Cordova SDK 集成指南

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

1. 添加 SDK 至您的项目

Adjust Cordova SDK 在 npm 中作为插件提供。要将其添加到您的项目中，

Cordova 插件

如需将 Adjust Cordova SDK 添加至您的 Cordova 插件，请运行以下命令：

> cordova plugin add com.adjust.sdk
Fetching plugin "com.adjust.sdk" via npm
Installing "com.adjust.sdk" for android
Installing "com.adjust.sdk" for ios

Ionic

如果您使用 Ionic 构建应用，请运行以下命令从awesome-cordova-plugins库中添加 SDK：

> npm install @awesome-cordova-plugins/adjust --save
> ionic cordova plugin add com.adjust.sdk

2. 设置安卓设备

添加 Google Play 服务

定向 Google Play 商店的应用必须使用 Google 广告 ID (gps_adid) 来识别设备。为此，请将以下内容添加至您的plugin.xml文件。

<framework src="com.google.android.gms:play-services-ads-identifier:18.0.1" id="sl-md0000000" />

添加权限

Adjust SDK 需要下列权限。(如尚未添加) 请将其添加至您的 plugin.xml 文件中：

<config-file target="AndroidManifest.xml" parent="/manifest/application" id="sl-md0000000">
    <receiver         android:name="com.adjust.sdk.AdjustReferrerReceiver"         android:exported="true" id="sl-md0000000">
        <intent-filter id="sl-md0000000">
            <action android:name="com.android.vending.INSTALL_REFERRER" id="sl-md0000000" />
        </intent-filter>
    </receiver>
</config-file>

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

<config-file target="AndroidManifest.xml" parent="/manifest" id="sl-md0000000">
  <uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove" id="sl-md0000000" />
</config>

设置 Proguard

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

-keep public 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.** { *; }

如果您的发布目标非 Google Play 商店，请向 Proguard 文件添加下列规则：

-keep public class com.adjust.sdk.** { *; }

设置 Install Referrer

Install Referrer 是一种唯一标识符，可用来将应用安装归因至来源。Adjust SDK 需要该信息进行归因。您可以用下列 3 种方法收集 install referrer：

• 使用 Google Play Referrer API。
• 使用华为 Referrer API (仅限华为设备)。

Google Play Referrer API

要支持 Google Play Referrer API：

1. 在build.gradle文件中配置 Google Maven 库：

   allprojects {
      repositories {
         jcenter()
         maven {
               url "https://maven.google.com"
         }
      }
   }

2. 添加下列行至您的 plugin.xml 文件:

   <framework src="com.android.installreferrer:installreferrer:2.2" id="sl-md0000000" />

3. 如果您使用的是 Proguard，请务必将下列设置加入您的 Proguard 文件：

   -keep public class com.android.installreferrer.** { *; }

华为 Referrer API

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

Meta referrer 集成

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

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

2. 在AdjustConfig实例上将您的 App ID 指定至fbAppId属性。

   var adjustConfig = new AdjustConfig(
      "{YourAppToken}",
      AdjustConfig.EnvironmentSandbox,
   );
   adjustConfig.fbAppId = "<fb_app_id_string id="sl-md0000000">";
   Adjust.create(adjustConfig);

3. 添加 iOS 框架

在应用中添加特定 iOS 框架后，Adjust SDK 就能获取额外信息。这些框架可以支持特定 SDK 功能，但即便没有这些框架，SDK 也能正常工作。

将所需框架添加至plugin.xml文件以启用框架。

<framework src="AdSupport.framework" weak="true" id="sl-md0000000" />
<framework src="StoreKit.framework" weak="true" id="sl-md0000000" />
<framework src="AdServices.framework" weak="true" id="sl-md0000000" />
<framework src="AppTrackingTransparency.framework" weak="true" id="sl-md0000000" />

4. 初始化 Adjust SDK

请确保在 Cordova 应用中尽快初始化 Adjust SDK。为此，请使用以下信息实例化一个AdjustConfig对象：

• appToken：Adjust 应用识别码。
• environment：应用运行的环境。要在本地测试应用，请设置为 AdjustConfig.ENVIRONMENT_SANDBOX。

var adjustConfig = new AdjustConfig(
   "{YourAppToken}",
   AdjustConfig.EnvironmentSandbox,
);
Adjust.create(adjustConfig);

5. 创建您的应用

完成了！您现在可以创建并运行 Cordova 应用了。请启用日志，检查可能存在的问题。请查看日志中的 Install tracked 信息。

您现在已经准备就绪，可以使用 Adjust SDK 进行用户归因了。

6. 添加 Adjust SDK 签名

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

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

7. 测试集成

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

• 将环境设为 Sandbox 。
• 在 Adjust 控制面板结果中添加 sandbox 过滤器。
• 将日志级别设为 verbose 。

测试 Google Play 服务集成

要测试 Adjust SDK 能否接收设备的 Google 广告 ID，请将日志级别设为 verbose ，环境设为 Sandbox 。启动应用，监测一次会话或事件。如果 SDK 记录了 gps_adid (Google Play 服务广告主 ID) 参数，就说明已经成功读取广告 ID。

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