Adapty アトリビューションでのディファードディープリンク

ディファードディープリンクを使うと、ユーザーが広告をクリックしてアプリをインストールした際に、カスタムデータをアプリに渡すことができます。たとえば、インストール後に初めてアプリを起動したとき、特定の画面に直接ナビゲートするといったことが可能です。

仕組みは次のとおりです：

ユーザーが広告をクリックすると、Adapty はクリックデータを保存します。
Adapty がインストールイベントを検知すると、クリック時のディファードデータを取得します。
ユーザーがアプリをインストールして初回起動すると、Adapty は保存されたデータを取り出し、アプリがカスタムパラメーターを受け取ります。これにより、アプリのコード内でさまざまな値に応じた処理を行えます。 Adapty は以下の遅延データパラメーターをサポートしています:

ios_deferred_data
android_deferred_data
deferred_data_sub[1-10]

遅延データパラメーターを追加するには、キャンペーン設定のリンクにパラメーターを追記します:

Integrations -> Meta/TikTok Ads ページからキャンペーンを開くか、Tracking links ページからトラッキングリンクを開きます。キャンペーンで使用するクリックリンクをコピーしてください。

広告プラットフォーム（Meta、TikTok、Google Adsなど）で、そのリンクを広告の遷移先URL欄に貼り付け、遅延データのパラメーターを追加のクエリパラメーターとして末尾に付加します。各パラメーターの先頭には & を付けてください。たとえば、インストール後にiOSユーザーを「Welcome」画面に誘導したい場合は、&ios_deferred_data=welcome を追加します。最終的な遷移先URLは次のようになります。

https://api-ua.adapty.io/api/v1/attribution/click?adpt_cid=__ADAPTY__ID__&ios_deferred_data=welcome&campaign_id=__CAMPAIGN_ID__&adset_id=__AID__&ad_id=__CID__&campaign_name=__CAMPAIGN_NAME__&adset_name=__AID_NAME__&ad_name=__CID_NAME__&redirect_url=__APP_LINK__

アプリのコードでパラメーターを処理します。なお、遅延データのパラメーターは payload パラメーターに含まれており、payload パラメーターはエスケープされた JSON であるため、アプリのコード内でパースする必要があります。

たとえば、ios_deferred_data が welcome のインストールを処理する方法は次のとおりです。

Adapty.delegate = self

nonisolated func onInstallationDetailsSuccess(_ details: AdaptyInstallationDetails) {
    guard
        let payloadStr = details.payload,
        let data = payloadStr.data(using: .utf8),
        let payload = try? JSONSerialization.jsonObject(with: data) as? [String: Any],
        let deeplink = payload["ios_deferred_data"] as? String,
        deeplink == "welcome"
    else { return }

    DispatchQueue.main.async {
        print("Navigate to welcome screen")
        // navigate to your screen here
    }
}

Adapty.setOnInstallationDetailsListener(object : OnInstallationDetailsListener {
    override fun onInstallationDetailsSuccess(details: AdaptyInstallationDetails) {
        details.payload?.let {
            runCatching {
                val json = JSONObject(it)
                if (json.optString("android_deferred_data") == "welcome") {
                    println("Navigate to welcome screen")
                    // navigate here
                }
            }.onFailure(Throwable::printStackTrace)
        }
    }
})

adapty.addEventListener('onInstallationDetailsSuccess', details => {
    // Parse the payload JSON and navigate to welcome screen if needed
    try {
        if (details.payload) {
            const payload = JSON.parse(details.payload);
            if (payload.ios_deferred_data === 'welcome') {
                // Navigate to welcome screen
                // Replace with your app's navigation logic
                // For example, using React Navigation:
                // navigation.navigate('Welcome');
                console.log('Navigate to welcome screen');
            }
        }
    } catch (error) {
        console.error('Error parsing installation details payload:', error);
    }
});

Adapty().onUpdateInstallationDetailsSuccessStream.listen((details) {
  final payloadStr = details.payload;
  if (payloadStr == null) return;

  final payload = json.decode(payloadStr) as Map<String, dynamic>;
  if (payload['ios_deferred_data'] == 'welcome') {
    print('Navigate to welcome screen');
  }
});