Branch

Branch 帮助客户跨设备、渠道和平台触达用户、开展互动并评估效果。这是一个专注于提升移动端营收的易用平台，通过在所有设备、渠道和平台上无缝运作的专属链接来实现这一目标。

Adapty 提供完整的数据集，让你可以在一个地方追踪来自各大应用商店的订阅事件。借助 Adapty，你可以轻松了解订阅者的行为习惯和偏好，并以有针对性、高效率的方式与他们沟通。 Adapty 与 Branch 的集成主要通过两种方式运作。

从 Branch 接收归因数据 配置 Branch 集成后，Adapty 将开始从 Branch 接收归因数据。您可以在用户画像页面轻松查看这些数据。
向 Branch 发送订阅事件 Adapty 可以将集成中配置的所有订阅事件发送到 Branch，让你能够在 Branch 看板中追踪这些事件。

设置集成

将 Adapty 连接到 Branch

要集成 Branch，请在 Adapty 看板中前往 Integrations > Branch，将开关从关闭切换为开启，并填写相关字段。

817a051-CleanShot_2023-08-11_at_15.54.372x.webp

要获取 Branch Key 的值，请打开 Branch 的账户设置，找到 Branch Key 字段。将其填入 Adapty 看板中的 Key test（用于沙盒）或 Key live（用于生产环境）字段。在 Branch 中，可以切换 Live 和 Tests 环境来获取对应的密钥。

130e58b-CleanShot_2023-08-11_at_15.24.162x.webp

配置事件和标签

在凭证下方，有三组事件可以从 Adapty 发送到 Branch。直接开启你需要的事件即可。点击此处查看 Adapty 提供的完整事件列表。

你可以发送包含净收入（扣除 Apple/Google 分成后）的事件，也可以仅发送原始收入。此外，还可以勾选按用户本地货币上报的选项。

a645cf8-CleanShot_2023-08-11_at_15.18.282x.webp

我们建议使用 Adapty 提供的默认事件名称，但你也可以根据需要自行修改。 Adapty 将通过服务器到服务器的集成方式向 Branch 发送订阅事件，让你可以在 Branch 看板中查看所有订阅事件，并将其与获客广告系列关联起来。

将您的应用连接到 Branch

调用 .setIntegrationIdentifier() SDK 方法来初始化连接。您可以将 Branch Identity ID 传递给 customerUserId 参数。

如果您使用第三方用户 ID 作为 Customer User ID，请不要在 activate() 时传入——第三方 SDK 可能尚未生成该 ID。请先不带 CUID 调用 activate()，然后调用 setIntegrationIdentifier()，最后再使用 CUID 调用 identify()。

  do {
      // Adapty SDK 4.x
      try await Adapty.setIntegrationIdentifier(.branchId(<BRANCH_IDENTITY_ID>))
      // Adapty SDK 3.x
      try await Adapty.setIntegrationIdentifier(
          key: "branch_id", 
          value: <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.updateAttribution(data, "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';
2. 使用 `.updateAttribution()` 方法保存归因数据。如果你在上一步中未指定 Branch 用户 ID，请在此处将其传入 `networkUserId` 参数。

<Tabs groupId="current-os" queryString>
<TabItem value="swift" label="iOS (Swift)" default>
```swift showLineNumbers
class YourBranchImplementation {
    func initializeBranch() {
        // 将从 Branch iOS SDK 初始化方法中获取的归因数据传递给 Adapty。
        Branch.getInstance().initSession(launchOptions: launchOptions) { (data, error) in
            if let data {
                // Adapty SDK 4.x
                Adapty.updateAttribution(data, source: .branch)
                // Adapty SDK 3.x
                Adapty.updateAttribution(data, source: "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;
```typescript showLineNumbers
import { adapty, AttributionSource } from 'react-native-adapty';
import branch from 'react-native-branch';
branch.subscribe({
  enComplete: ({
    params,
  }) => {
    adapty.updateAttribution(params, "branch");
  },
});

事件结构

Adapty 会按照 Branch 集成页面 上 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"
  }
}

其中：

参数	类型	描述
`branch_key`	String	您的 Branch Key。
`name`	String	Branch 事件名称（从 Adapty 事件映射而来，例如 “PURCHASE”）。
`user_data`	Object	用户信息。
`user_data.os`	String	”Android” 或 “iOS”。
`user_data.developer_identity`	String	用户的 Customer User ID。
`user_data.country`	String	基于用户 IP 的国家代码。
`user_data.ip`	String	用户的 IP 地址。
`user_data.idfa`	String	仅限 iOS。广告标识符（ID for Advertisers）。
`user_data.idfv`	String	仅限 iOS。供应商标识符（ID for Vendors）。
`user_data.aaid`	String	仅限 Android。Google 广告 ID。
`event_data`	Object	标准事件数据指标（仅在 PURCHASE 及类似事件中存在）。
`event_data.transaction_id`	String	应用商店交易 ID。
`event_data.revenue`	Float	收入金额。
`event_data.currency`	String	货币代码（例如 “USD”）。
`custom_data`	Object	详细事件属性（包含所有可用的事件字段）。