配置

请使用该文档中的方法配置 Adjust SDK 行为。

实例化 config 对象

constructor(appToken: string, environment: Environment)

要配置 Adjust SDK，您需要实例化一个 AdjustConfig 对象。该对象包含 只读 配置选项。请将这些配置选项发送给 Adjust SDK。

要实例化您的 config 对象，请创建新的 AdjustConfig 实例，并传送下列参数：

• appToken (string)：您的 Adjust 应用识别码。
• environment (Environment)：SDK 运行的环境。传送 AdjustConfig.EnvironmentSandbox，可在 sandbox 模式下运行 SDK，方便进行测试；传送 AdjustConfig.EnvironmentProduction，可在生产模式下运行 SDK，方便发布。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
Adjust.initSdk(adjustConfig);

只读配置

只读 配置选项需要在 SDK 初始化 之前 在 AdjustConfig 实例中设定。这些配置选项无法在 SDK 运行过程中变更。请务必在运行 Adjust.initSdk() 之前配置要使用的所有设置。

设置日志级别

public setLogLevel(level: LogLevel): void

通过 Adjust SDK，您可以配置不同日志级别，返回不同数量的信息。可用的日志级别包括：

您可以在 AdjustConfig 实例上使用下列参数调用 setLogLevel 方法，以设置日志级别：

• logLevel (LogLevel)：要使用的日志级别。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7

8
Adjust.initSdk(adjustConfig);

设置外部设备标识符

public setExternalDeviceId(externalDeviceId: string): void

外部设备标识符是您为设备或用户自定义的一个值。您可以通过这个值在不同的会话和平台中识别用户。您也可以通过该值基于用户对安装进行去重，这样同一位用户就不会被记录为多次新安装了。请联系您的 Adjust 代表来开始使用外部设备 ID。

您可以使用外部设备 ID 作为设备的自定义标识符。这可以确保您的数据与其他系统中的数据保持一致性。您可以使用下列参数调用 setExternalDeviceId 方法，以设置该属性：

• externalDeviceId (string)：您的外部设备标识符。需要 区分大小写 。如果您导入了外部设备 ID，则需要确保发送的值与已导入的值相匹配。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setExternalDeviceId("{Your-External-Device-Id}");
7

8
Adjust.initSdk(adjustConfig);

如果您想在商业分析中使用外部设备 ID，则可以将其作为会话回传参数发送。

您可以将已有外部设备 ID 导入到 Adjust。这能保证 Adjust 服务器将未来的数据与已有设备记录相匹配。请联系您的 Adjust 代表，了解更多信息。

设置默认链接识别码

public setDefaultTracker(defaultTracker: string): void

如果您的应用已预安装在设备上，那么则可以配置一个默认链接识别码。当用户首次打开预安装应用时，安装就会被归因给默认链接识别码。要设置默认链接识别码，请使用下列参数调用 setDefaultTracker 方法：

• defaultTracker (string)：用于记录预安装应用安装的 Adjust 链接识别码。

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setDefaultTracker("{TrackerToken}");
7

8
Adjust.initSdk(adjustConfig);

启用成本数据发送

public enableCostDataInAttribution(): void

默认情况下，Adjust 不会在用户归因信息中发送成本数据。您可以启用成本数据发送，使 SDK 发送成本数据。要启用成本数据发送，请在 config 实例上调用enableCostDataInAttribution方法。

您可以在用户的归因信息中访问成本数据。

1
const adjustConfig = new AdjustConfig(
2
   "{Your App Token}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
6
adjustConfig.enableCostDataInAttribution();

启用后台记录

public enableSendingInBackground(): void

默认情况下，应用在后台运行时，Adjust SDK 会暂停发送请求。您可以通过启用后台记录功能来使 SDK 在应用位于后台时发送请求。要启用后台记录，请在 config 实例上调用enableSendingInBackground方法。

1
const adjustConfig = new AdjustConfig(
2
   "{Your App Token}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.enableSendingInBackground();
6
Adjust.initSdk(adjustConfig);

动态配置

为响应事件或用户进行的操作， 动态 配置选项可能在 SDK 的生命周期中发生变化。

激活离线模式

switchToOfflineMode: () => void

Adjust SDK 会实时向 Adjust 后端发送事件和会话数据。您可以通过将 SDK 设为离线状态来暂停信息的发送。在离线状态中，SDK 会在设备本地文件中存储所有数据。离线模式关闭后，SDK 会将此信息发送至 Adjust 服务器。

要启用离线模式，请调用Adjust.switchToOfflineMode方法。

1
Adjust.switchToOfflineMode();

禁用离线模式

switchBackToOnlineMode: () => void

您可以通过调用Adjust.switchBackToOnlineMode方法来重新启用 SDK。这会提示 SDK 恢复发送信息。

1
Adjust.switchBackToOnlineMode();

设置推送标签

setPushToken: (token: string) => void

推送标签 (Push token) 用于受众和客户回传。在卸载和重装监测中，推送标签也是必要的。

您的 config 对象包含一个pushToken字符串属性，您可以通过该属性存储推送标签。您可以随时调用setPushToken方法，并发送下列参数，以更新该属性：

• token (string)：您的推送标签 (Push token)。

1
Adjust.setPushToken("YourPushNotificationToken");

禁用 SDK

disable: () => void

应用打开时 Adjust SDK 会默认运行。您可以通过调用Adjust.disable方法禁用 Adjust SDK，暂停向 Adjust 发送信息。禁用 Adjust SDK 后，Adjust 不会收到任何数据，SDK 也不会记录任何信息。也就是说，SDK 禁用时调用的任何 Adjust 方法都不会记录任何内容。

1
Adjust.disable();

启用 SDK

enable: () => void

如果您已经禁用了 SDK 并希望重新启用，请调用Adjust.enable方法。启用后，SDK 会向 Adjust 服务器发送信息。

1
Adjust.enable();

查看启用状态

isEnabled: (callback: (enabled: boolean) => void) => void

您可以随时调用 isEnabled 方法，查看 Adjust SDK 是否已启用。该方法会返回 boolean 来指示 SDK 是处于 启用 (true) 还是 禁用 (false) 状态。

1
Adjust.isEnabled((isEnabled) => {
2
   if (isEnabled) {
3
      console.log("SDK is enabled");
4
   } else {
5
      console.log("SDK is disabled");
6
   }
7
});