adjust-icon

Cordova SDK 集成指南

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

1. 添加 SDK 至您的项目

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

Cordova 插件

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

Terminal window
> 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 和 TypeScript typing：

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

2. 设置安卓设备

添加权限

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

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

设置 Install Referrer

Adjust SDK 默认支持Google Play Referrer API。对于安卓端，Huawei Referrer API 和 Meta Install Referrer 可作为插件使用。请参考相关文档，为您的安卓应用设置插件。

Meta referrer 集成

要启用 Meta Install Referrer，您需要在AdjustConfig实例中设置 Meta 应用 ID。为此请进行下列操作：

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

  2. 将您的应用 ID 传递至AdjustConfig实例的setFbAppId方法。

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

3. 添加 iOS 框架

Adjust SDK 会自动在 iOS 设备上关联下列框架。

框架描述注意事项
AdSupport.framework允许读取设备 IDFA。对于操作系统为 iOS 14 及更早版本的设备，添加该框架也会允许读取 LAT 信息。如果您的应用属于 “儿童” 类别，那么请勿添加该框架
AdServices.framework处理 Apple Search Ads 归因
StoreKit.framework允许访问 SKAdNetwork 框架若要允许 Adjust 处理 iOS 14 或更新操作版本设备上与 SKAdNetwork 的通讯，那么必须添加该框架。
AppTrackingTransparency.framework若要允许 Adjust SDK 包装用户跟踪许可对话，并读取 iOS 14 或更新操作版本设备的许可响应，那么必须添加该框架。如果您的应用属于 “儿童” 类别，那么请勿添加该框架

4. 设置 SDK 签名

SDK v5 包含 SDK 签名库。请按照iOS和安卓测试指南操作，确保集成正确运行。

签名保护功能默认处于禁用状态。要启用该功能，您需要：

  1. 执行签名验证。
  2. 在测试前提供应用的 SHA-1 指纹。

5. 初始化 Adjust SDK

请确保在 Cordova 应用中尽快初始化 Adjust SDK。为此请进行下列操作：

  1. 请使用以下信息实例化一个AdjustConfig对象：

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

  2. 将您的AdjustConfig实例传递至Adjust.initSdk方法来初始化 SDK。

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

6. 创建您的应用

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

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

7. 测试集成

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

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

如果遇到任何问题，请发送邮件至 support@adjust.com，并在邮件中说明所有详情和日志。

测试 Google Play 服务集成

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

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