adjust-icon

React Native SDK 集成指南

通过 Adjust React Native SDK,您可以在自己的 React Native 应用中监测归因、事件及更多数据。请按照本指南中说明的步骤操作,在应用内设置 Adjust SDK。您还可以在 GitHub 上查看示例应用。

1. 添加 SDK 至您的项目

要在您的 React Native 应用中使用 Adjust SDK,请先将 SDK 加入项目。请按以下步骤添加:

  1. 使用以下方法之一下载 React Native 库。
  1. 在您的终端运行以下指令来为您的 iOS 应用安装 CocoaPods 依赖:
Terminal window
$ cd ios && pod install

2. 集成 SDK

要将 SDK 集成进项目,您必须先将 Adjust 的 SDK 配置导入主要应用 Javascript 文件。

在应用的.js文件开始处加入以下行:

import { Adjust, AdjustEvent, AdjustConfig } from "react-native-adjust";

3. 初始化 Adjust SDK

请确保在 React Native 应用中尽快初始化 Adjust SDK。要进行 SDK 初始化,请使用应用识别码及您希望应用程序运行的环境来初始化 config 对象。 向应用的.js文件中加入以下代码行:

constructor(props) {
super(props);
const adjustConfig = new AdjustConfig("{YourAppToken}", AdjustConfig.EnvironmentSandbox);
Adjust.create(adjustConfig);
}
componentWillUnmount() {
Adjust.componentWillUnmount();
}

传递AdjustConfig参数:

  • 用您的识别码替换 {YourAppToken} 。请查看应用设置,了解查找识别码的办法。
  • 选择您的环境:
    • 如要测试应用并发送测试数据,请使用AdjustConfig.EnvironmentSandbox。请在控制面板中启用 sandbox 模式,查看测试数据。
    • 如果您已经完成测试,准备发布应用,请使用AdjustConfig.EnvironmentProduction

4. 设置 安卓 设备

添加权限

Adjust SDK 需要特定权限来访问信息。(如尚未添加) 请将其添加至您的 AndroidManifest.xml 文件中:

AndroidManifest.xml
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

从 Adjust SDK 4.32.0 及以上版本默认包含 com.google.android.gms.AD_ID 权限。如果您的应用需要符合 COPPA 的要求或不针对 Google Play 商店,则可以通过添加 remove 指令将其删除。

AndroidManifest.xml
<uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

添加 Google Play 服务

针对 Google Play 商店的应用必须使用 Google 广告 ID (gps_adid) 来识别设备。为此,请将以下 dependency 加入build.gradle 文件的 dependencies 部分。

build.gradle
implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'

设置 Proguard

如果您使用的是 Proguard,请将以下规则添加至您的 Proguard 文件。

proguard.pro
-keep class com.adjust.sdk.** { *; }
-keep class com.google.android.gms.common.ConnectionResult {
int SUCCESS;
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
java.lang.String getId();
boolean isLimitAdTrackingEnabled();
}
-keep public class com.android.installreferrer.** { *; }

设置 Install Referrer

Install Referrer 是一种归因机制,可用来将应用安装归因至来源。包含两部分:

  • 来自这些应用商店的一系列 API,开发者借此可在应用中调取 referral 内容。
  • Google Play 和华为 App Gallery 等应用商店在其商店网站应用页面 URL 中接受的 referrer 参数。referrer 参数按以下方式填充:
    • 用户点击 Adjust 链接时,Adjust 服务器发送一个独一无二的识别码,即 reftag。该识别码被指配给此点击,并被添加至 referrer 参数。要进一步了解 reftag,请访问Reftag 页面。
    • 您在开展 Google Ads 推广活动时,Google 会传递一个叫做 gclid 的唯一识别码至 referrer 参数。您必须在 Google Ads 账户中开启 Auto-tagging

Google Play Referrer API

于 v4.12.0 中添加

要支持 Google Play Referrer API

  1. 请在您的最高层级build.gradle文件的 依赖区块 中添加以下行:
build.gradle
dependencies {
//...
implementation 'com.android.installreferrer:installreferrer:2.2'
//...
}
  1. installreferrer库是 Google Maven 库的一部分。您需要将 Google Maven 库添加到应用的最高层级build.gradle文件来构建应用:
build.gradle
allprojects {
repositories {
maven {
url "https://maven.google.com"
}
}
}
  1. 如果您使用的是 Proguard,请务必将下列设置加入您的 Proguard 文件:
proguard.pro
-keep public class com.android.installreferrer.** { *; }

华为 Referrer API

从版本 v4.22.0 开始,Adjust SDK 将支持对装有华为 App Gallery 10.4 或更新版本的设备进行安装监测。您无需其他调整和变更,就可以开始使用华为 Referrer API。

Meta referrer 集成

于 v4.37.0 中添加

Adjust SDK v4.37.0 及更高版本支持Meta Install Referrer。要启用该功能:

  1. 应用控制面板中找到您的 Meta app ID。更多信息,请参考 Meta 的应用控制面板文档

  2. 将应用 ID 作为 string 参数传递至 AdjustConfig.setFbAppId 方法。

    const adjustConfig = new AdjustConfig(
    "{YourAppToken}",
    AdjustConfig.EnvironmentSandbox,
    );
    //...
    adjustConfig.setFbAppId("<fb_app_id_string>");
    //...
    Adjust.create(adjustConfig);

5. 添加 iOS 框架

在应用中添加特定 iOS 框架后,Adjust SDK 就能获取额外信息。这些框架可以支持特定 SDK 功能,但即便没有这些框架,SDK 也能正常工作。您可以添加这些框架,然后在 Project Settings -> Build Phases -> Link Binary With Libraries 下将其设置为可选。

框架描述注意事项
AdSupport.framework如果您希望 SDK 能访问 IDFA 值和 (iOS 14 以前的) LAT 信息,请添加该框架。如果您的应用属于 “儿童” (Kids) 类别,请不要安装该框架。
AdServices.framework该框架对于处理 Apple Search Ads 是必要的。
StoreKit.framework如果您希望访问 SKAdNetwork 框架,同时让 Adjust SDK 在 iOS 14 或未来版本的 iOS 中自动处理与该框架的通讯,请添加该框架。
AppTrackingTransparency.framework如果您希望 SDK 能在 iOS 14 或未来版本的 iOS 中包装用户的 ATT 许可对话框,并访问用户的许可响应,请添加该框架。如果您的应用属于 “儿童” (Kids) 类别,请不要安装该框架。

6. 添加 Adjust SDK 签名

Adjust SDK 签名可以用来签署 Adjust SDK 发送的所有通讯。这样,Adjust 的服务器就能轻松甄别、拒绝任何非法安装活动。

要开始使用 Adjust SDK 签名,请联系您的技术客户经理,或发送邮件至 support@adjust.com

7. 测试集成

采用 Adjust SDK 提供的工具,您可以测试并排除集成出现的问题。要测试集成,请按照下列步骤操作:

  • 将您的环境设为 AdjustConfig.EnvironmentSandbox
  • 在 Adjust 控制面板结果中添加 sandbox 过滤器
  • 将日志级别设为 AdjustConfig.LogLevelVerbose

测试 Google Play 服务集成

要测试 Adjust SDK 能否接收设备的 Google 广告 ID,请将日志级别设为 AdjustConfig.LogLevelVerbose,环境设为 AdjustConfig.EnvironmentSandbox。启动应用,记录一次会话或事件。如果 SDK 读取了广告 ID,就会记录 gps_adid 参数。

如果您在获取 Google 广告 ID 时遇到任何问题,请在 SDK GitHub 库中提问,或联系 support@adjust.com