Branch

Branchは、さまざまなデバイス、チャネル、プラットフォームをまたいでユーザーへのリーチ、エンゲージメント、成果測定を可能にするサービスです。あらゆるデバイス、チャネル、プラットフォームでシームレスに機能する専用リンクを通じて、モバイル収益を最大化するためのユーザーフレンドリーなプラットフォームです。

Adaptyは、ストアからのサブスクリプションイベントを一元管理・追跡できる充実したデータセットを提供します。Adaptyを使えば、サブスクライバーの行動を簡単に把握し、好みを理解し、その情報をもとにターゲットを絞った効果的なコミュニケーションが実現できます。

BranchとAdaptyの連携は、主に2つの方法で機能します。

1. BranchからのアトリビューションデータをAdaptyが受信する Branchとのインテグレーションをセットアップすれば、AdaptyはBranchからアトリビューションデータを受信し始めます。このデータはユーザーのプロファイルページで簡単に確認できます。

   

2. Branchへのサブスクリプションイベントの送信
   Adaptyは、インテグレーションで設定されたすべてのサブスクリプションイベントをBranchに送信できます。これにより、Branchダッシュボード内でこれらのイベントを追跡できるようになります。

連携のセットアップ

Adapty を Branch に接続する

Branch を連携するには、Adapty ダッシュボードの Integrations > Branch に移動し、トグルをオンにして各フィールドに入力してください。

Branch Key の値を取得するには、Branch の Account Settings を開き、Branch Key フィールドを確認してください。Adapty ダッシュボードの Key test（サンドボックス用）または Key live（本番用）フィールドに使用します。Branch 側では、Live と Test の環境を切り替えて適切なキーを取得してください。

イベントとタグを設定する

認証情報の下には、Adapty から Branch に送信できるイベントが 3 つのグループに分かれています。必要なものをオンにするだけです。Adapty が提供するイベントの全一覧はこちらで確認できます。

収益（Apple/Google の手数料差し引き後）または売上金額のみでイベントを送信できます。また、ユーザーの通貨でレポートするチェックボックスもあります。

Adapty が提供するデフォルトのイベント名を使用することを推奨します。ただし、必要に応じてイベント名を変更することも可能です。

Adapty はサーバー間連携を使って Branch にサブスクリプションイベントを送信するため、Branch ダッシュボードですべてのサブスクリプションイベントを確認し、獲得キャンペーンと紐付けることができます。

アプリをBranchに接続する

1. .setIntegrationIdentifier() SDKメソッドを呼び出して接続を初期化します。Branch Identity IDをcustomerUserIdパラメーターに渡すことができます。

do {
    try await Adapty.setIntegrationIdentifier(.branchId(<BRANCH_IDENTITY_ID>))
} catch {
    // handle the error
}

// login and update attribution and identifier
Branch.getAutoInstance(this)
    .setIdentity("YOUR_USER_ID") { referringParams, error ->
        referringParams?.let { data ->
            Adapty.updateExternalAttribution(data.toString(), AdaptyExternalAttributionProvider.BRANCH) { error ->
                if (error != null) {
                    //handle the error
                }
            }
        }
    }

// logout
Branch.getAutoInstance(context).logout()

import 'package:flutter_branch_sdk/flutter_branch_sdk.dart';

FlutterBranchSdk.setIdentity('YOUR_USER_ID');

Branch.setIdentity("your user id");

  import branch from 'react-native-branch';

  branch.setIdentity('YOUR_USER_ID');

2. .updateExternalAttribution() メソッド（SDK バージョン 4.1 より前は .updateAttribution() という名前）を使ってアトリビューションデータを保存します。前のステップで Branch ユーザー ID を指定しなかった場合は、ここで networkUserId パラメーターに渡してください。

  class YourBranchImplementation {
      func initializeBranch() {
          // Pass the attribution you receive from the initializing method of Branch iOS SDK to Adapty.
          Branch.getInstance().initSession(launchOptions: launchOptions) { (data, error) in
              if let data {
                  Adapty.updateExternalAttribution(data, provider: .branch)
              }
          }
      }
  }

//everything is in the above snippet for Android

try {
    await Adapty().setIntegrationIdentifier(
        key: "branch_id", 
        value: <BRANCH_IDENTITY_ID>,
    );
} on AdaptyError catch (adaptyError) {
    // handle the error
} catch (e) {
    // handle the error
}

using AdaptySDK;

Branch.initSession(delegate(Dictionary<string, object> parameters, string error) {
    string attributionString = JsonUtility.ToJson(parameters);
    
    Adapty.UpdateExternalAttribution(
      attributionString, 
      "branch", 
      (error) => {
        // handle the error
    });
});

import { adapty, AttributionSource } from 'react-native-adapty';
import branch from 'react-native-branch';

branch.subscribe({
  enComplete: ({
    params,
  }) => {
    adapty.updateAttribution(params, "branch");
  },
});

イベント構造

Adapty は、Branch Integration ページの Events names セクションで設定された内容に従って、選択したイベントを Branch に送信します。各イベントは次のような構造になっています：

{
  "branch_key": "key_live_kaFuWw8WvY7n1ss7...",
  "name": "PURCHASE",
  "user_data": {
    "os": "iOS",
    "developer_identity": "user_12345",
    "country": "US",
    "ip": "192.168.100.1",
    "idfa": "00000000-0000-0000-0000-000000000000",
    "idfv": "00000000-0000-0000-0000-000000000000",
    "aaid": "00000000-0000-0000-0000-000000000000"
  },
  "event_data": {
    "transaction_id": "GPA.3383-4699-1373-07113",
    "revenue": 9.99,
    "currency": "USD"
  },
  "custom_data": {
    "vendor_product_id": "yearly.premium.6999",
    "original_transaction_id": "GPA.3383-4699-1373-07113",
    "store": "play_store",
    "environment": "production"
  }
}

各パラメータの説明：

トラブルシューティング

access_level_updated がイベントフィードで失敗として表示される

access_level_updated は webhook 専用イベントです。Adapty はこのインテグレーションにこのイベントを送信しません。ただし、Adapty は有効なすべてのインテグレーションに対して結果を記録するため、サポートされていないイベントは失敗として表示されます。