配置

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

实例化 config 对象

+ (nullable ADJConfig *)configWithAppToken:(nonnull NSString *)appToken
                               environment:(nonnull NSString *)environment
                     allowSuppressLogLevel:(BOOL)allowSuppressLogLevel;

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

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

appToken (NSString)：您的 Adjust 应用识别码。
environment (NSString)：SDK 运行的环境。传送 ADJEnvironmentSandbox，可在 sandbox 模式下运行 SDK，方便进行测试；传送 ADJEnvironmentProduction，可在生产模式下运行 SDK，方便发布。
allowSuppressLogLevel (BOOL)：是否禁用所有日志记录。设为 true 可禁用日志记录；设为 false 可启用日志记录。

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)

1
NSString *yourAppToken = @"{YourAppToken}";
2
NSString *environment = ADJEnvironmentSandbox;
3
*adjustConfig = [ADJConfig configWithAppToken:yourAppToken
4
                                  environment:environment];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   var yourAppToken = yourAppToken;
3
   var environment = AdjustConfig.EnvironmentSandbox;
4
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
5
});

只读配置

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

设置日志级别

@property (nonatomic, assign) ADJLogLevel logLevel;

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

ADJLogLevel	描述
`ADJLogLevelVerbose`	启用完整日志
`ADJLogLevelDebug`	启用调试记录
`ADJLogLevelInfo`	仅显示信息级别日志 (默认选项)
`ADJLogLevelWarn`	禁用信息日志
`ADJLogLevelError`	禁用警告及更低级别日志
`ADJLogLevelAssert`	禁用错误及更低级别日志
`ADJLogLevelSuppress`	禁止所有日志

您可以为 config 实例 logLevel 属性指定 ADJLogLevel 值，以设置日志级别。

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

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
// ...
7
adjustConfig?.logLevel = ADJLogLevel.verbose

1
NSString *yourAppToken = @"{YourAppToken}";
2
NSString *environment = ADJEnvironmentSandbox;
3
*adjustConfig = [ADJConfig configWithAppToken:yourAppToken
4
                                 environment:environment];
5
// ...
6
[adjustConfig setLogLevel:ADJLogLevelVerbose];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   // ...
3
   var yourAppToken = yourAppToken;
4
   var environment = AdjustConfig.EnvironmentSandbox;
5
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
6
   adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
7
});

设置外部设备标识符

@property (nonatomic, copy, nullable) NSString *externalDeviceId;

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

您还可以使用外部设备 ID 作为设备的自定义标识符。这可以确保您的数据与其他系统中的数据保持一致性。在 config 实例上将您的外部设备 ID 指定至externalDeviceId属性。

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

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
// ...
7
adjustConfig?.externalDeviceId = "yourExternalDeviceId"

1
NSString *yourAppToken = @"{YourAppToken}";
2
NSString *environment = ADJEnvironmentSandbox;
3
*adjustConfig = [ADJConfig configWithAppToken:yourAppToken
4
                                 environment:environment];
5
// ...
6
[adjustConfig setExternalDeviceId:@"yourExternalDeviceId"];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   var yourAppToken = yourAppToken;
3
   var environment = AdjustConfig.EnvironmentSandbox;
4
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
5
   adjustConfig.setExternalDeviceId("yourExternalDeviceId");
6
});

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

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

设置默认链接识别码

@property (nonatomic, copy, nullable) NSString *defaultTracker;

如果您的应用已预安装在设备上，那么则可以配置一个默认链接识别码。当用户首次打开预安装应用时，安装就会被归因给默认链接识别码。请将默认链接识别码指定给 config 实例的 defaultTracker 属性。

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

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
adjustConfig?.defaultTracker = "{Token}"
7
Adjust.appDidLaunch(adjustConfig)

1
*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}"
2
                                 environment:ADJEnvironmentSandbox];
3
[adjustConfig setDefaultTracker:@"{Token}"];
4
[Adjust appDidLaunch:adjustConfig];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   var yourAppToken = yourAppToken;
3
   var environment = AdjustConfig.EnvironmentSandbox;
4
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
5
   adjustConfig.setDefaultTracker("{Token}");
6
});

启用成本数据发送

@property (nonatomic, assign) BOOL needsCost;

默认情况下，Adjust 不会在用户归因信息中发送成本数据。您可以启用成本数据发送，使 SDK 发送成本数据。要启用成本数据发送，请为 config 实例 needsCost 属性指定布尔值。

needsCost (BOOL)：设为 true 可启用成本数据发送；设为 false 可禁用成本数据发送。

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

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
// ...
7
adjustConfig?.needsCost = true

1
NSString *yourAppToken = @"{YourAppToken}";
2
NSString *environment = ADJEnvironmentSandbox;
3
*adjustConfig = [ADJConfig configWithAppToken:yourAppToken
4
                                 environment:environment];
5
// ...
6
[adjustConfig setNeedsCost:YES];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   var yourAppToken = yourAppToken;
3
   var environment = AdjustConfig.EnvironmentSandbox;
4
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
5
   adjustConfig.setNeedsCost(true);
6
});

启用后台记录

@property (nonatomic, assign) BOOL sendInBackground;

默认情况下，应用在后台运行时，Adjust SDK 会暂停发送请求。您可以通过启用后台记录功能来使 SDK 在应用位于后台时发送请求。要启用后台记录，请为 config 实例 sendInBackground 属性指定布尔值

sendInBackground (BOOL)：设为 true 可启用后台请求发送；设为 false 可禁用后台请求发送。

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
// ...
7
adjustConfig?.sendInBackground = true

1
NSString *yourAppToken = @"{YourAppToken}";
2
NSString *environment = ADJEnvironmentSandbox;
3
*adjustConfig = [ADJConfig configWithAppToken:yourAppToken
4
                                 environment:environment];
5
// ...
6
[adjustConfig setSendInBackground:YES];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   // ...
3
   var yourAppToken = yourAppToken;
4
   var environment = AdjustConfig.EnvironmentSandbox;
5
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
6
   adjustConfig.setSendInBackground(true);
7
});

启用事件缓冲

@property (nonatomic, assign) BOOL eventBufferingEnabled;

用户在应用中触发事件后，Adjust SDK 会立即发送事件信息。您可以通过设置事件缓冲来按指定时间发送事件信息。事件缓冲会将事件存储在设备本地缓冲中，每分钟发送一批请求。

您的 config 对象包含一个布尔式 eventBufferingEnabled 属性，该属性控制此行为。要启用事件缓冲，请为 config 实例 eventBufferingEnabled 属性指定布尔值。

eventBufferingEnabled (BOOL)：设为 true 可启用事件缓冲；设为 false 可禁用事件缓冲。

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
adjustConfig?.eventBufferingEnabled = true
7
Adjust.appDidLaunch(adjustConfig)

1
*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}"
2
                                 environment:ADJEnvironmentSandbox];
3
[adjustConfig setEventBufferingEnabled:YES];
4
[Adjust appDidLaunch:adjustConfig];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   var yourAppToken = yourAppToken;
3
   var environment = AdjustConfig.EnvironmentSandbox;
4
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
5
   adjustConfig.setEventBufferingEnabled(true);
6
});

延迟 SDK 启动

@property (nonatomic, assign) double delayStart;

默认情况下，Adjust SDK 会在应用打开时启动。如果您想通过会话参数发送的数据在应用打开时不可用，那么则可以延迟 SDK 启动。当您想发送唯一标识符等信息时，这一方法尤其有效。

要配置启动延迟，请为 config 实例delayStart属性指定一个double值。

delayStart (double)：SDK 启动延迟事件 (以秒计)。您最多可以将 SDK 的启动时间延迟 10 秒。

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
adjustConfig?.delayStart = 5.5
7
// ...
8
Adjust.appDidLaunch(adjustConfig)

1
*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}"
2
                                 environment:ADJEnvironmentSandbox];
3
[adjustConfig setDelayStart:5.5];
4
/// ...
5
[Adjust appDidLaunch:adjustConfig];

1
setupWebViewJavascriptBridge(function (bridge) {
2
   var yourAppToken = yourAppToken;
3
   var environment = AdjustConfig.EnvironmentSandbox;
4
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
5
   adjustConfig.setDelayStart(5.5);
6
});

动态配置

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

开启和关闭离线模式

+ (void)setOfflineMode:(BOOL)enabled;

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

您可以随时使用下列参数调用 setOfflineMode 方法，以开启和关闭离线模式：

enabled (BOOL)：设为 true 可启用离线模式；设为 false 可禁用离线模式。

1
Adjust.setOfflineMode(true);

1
[Adjust setOfflineMode:YES];

1
Adjust.setOfflineMode(true);

设置推送标签 (Push token)

+ (void)setDeviceToken:(nonnull NSData *)deviceToken;

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

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

deviceToken (NSData)：您的推送标签 (Push token)。

1
func application(_ app: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
2
    Adjust.setDeviceToken(deviceToken)
3
}

1
- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
2
    [Adjust setDeviceToken:deviceToken];
3
}

1
Adjust.setDeviceToken(deviceToken);

禁用或启用 SDK

+ (void)setEnabled:(BOOL)enabled;

应用打开时 Adjust SDK 会默认运行。您可以通过禁用和启用 Adjust SDK 来暂停或恢复记录。禁用 Adjust SDK 时，SDK 不会向 Adjust 服务器发送任何数据。

您可以随时使用下列参数调用 setEnabled 方法，以启用或禁用 SDK：

enabled (BOOL)：设为 true 可启用 SDK；设为 false 可禁用 SDK。

1
Adjust.setEnabled(true)

1
[Adjust setEnabled:NO];

1
Adjust.setEnabled(false);

查看启用状态

+ (BOOL)isEnabled;

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

1
Adjust.isEnabled()

1
[Adjust isEnabled];

1
Adjust.isEnabled();