配置

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

实例化 config 对象

- (nullable ADJConfig *)initWithAppToken:(nonnull NSString *)appToken
                             environment:(nonnull NSString *)environment
                             suppressLogLevel:(BOOL)allowSuppressLogLevel;

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

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

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

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
    appToken: yourAppToken,
    environment: environment)

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken
                                                    environment:environment];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
});

只读配置

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

设置日志级别

@property (nonatomic, assign) ADJLogLevel logLevel;

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

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

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

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

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
    appToken: yourAppToken,
    environment: environment)
// ...
adjustConfig?.logLevel = ADJLogLevel.verbose

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
 ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken
                                                    environment:environment];
// ...
[adjustConfig setLogLevel:ADJLogLevelVerbose];

setupWebViewJavascriptBridge(function (bridge) {
   // ...
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);
});

设置外部设备标识符

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

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

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

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

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
   appToken: yourAppToken,
   environment: environment)
// ...
adjustConfig?.externalDeviceId = "yourExternalDeviceId"

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
 ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken
                                                    environment:environment];
// ...
[adjustConfig setExternalDeviceId:@"yourExternalDeviceId"];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.setExternalDeviceId("yourExternalDeviceId");
});

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

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

设置默认链接识别码

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

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

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

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
   appToken: yourAppToken,
   environment: environment)
adjustConfig?.defaultTracker = "{Token}"
Adjust.initSdk(adjustConfig)

ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
                                              environment:environment];
[adjustConfig setDefaultTracker:@"{Token}"];
[Adjust initSdk:adjustConfig];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.setDefaultTracker("{Token}");
});

启用成本数据发送

- (void)enableCostDataInAttribution;

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

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

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox
let adjustConfig = ADJConfig(
   appToken: yourAppToken,
   environment: environment)
// ...
adjustConfig?.enableCostDataInAttribution()

NSString *yourAppToken = @"{YourAppToken}";
NSString *environment = ADJEnvironmentSandbox;
 ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken
                                                environment:environment];
// ...
[adjustConfig enableCostDataInAttribution];

setupWebViewJavascriptBridge(function (bridge) {
   var yourAppToken = yourAppToken;
   var environment = AdjustConfig.EnvironmentSandbox;
   var adjustConfig = new AdjustConfig(yourAppToken, environment);
   adjustConfig.enableCostDataInAttribution();
});

启用后台发送

- (void)enableSendingInBackground;

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

1
adjustConfig?.enableSendingInBackground()

1
[adjustConfig enableSendingInBackground];

1
adjustConfig.setSendInBackground(true);

禁用 AdServices 处理

- (void)disableAdServices;

默认情况下，Adjust SDK 会与苹果的 AdServices.framework 通信以调取 Apple Search Ads 归因信息。您可以通过在 ADJConfig 实例上调用 disableAdServices 方法来配置 SDK 以禁用此行为。

1
adjustConfig?.disableAdServices()

1
[adjustConfig disableAdServices];

1
adjustConfig.disableAdServices();

动态配置

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

激活离线模式

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

您可以随时调用[Adjust switchToOfflineMode]方法来开启和关闭离线模式。

Swift
Objective-C

1
Adjust.switchToOfflineMode()

1
[Adjust switchToOfflineMode]

禁用离线模式

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

Swift
Objective-C

1
Adjust.switchBackToOnlineMode()

1
[Adjust switchBackToOnlineMode]

设置推送标签

+ (void)setPushToken:(nonnull NSData *)pushToken;

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

您可以随时调用[Adjust setPushToken]方法并传递以下参数来更新推送标签 (Push token)：

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

Swift
Objective-C

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

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

禁用 SDK

+ (void)disable;

应用打开时 Adjust SDK 会默认运行。您可以通过调用[Adjust disable]方法禁用 Adjust SDK，暂停向 Adjust 发送信息。禁用 Adjust SDK 时，SDK 不会向 Adjust 服务器发送任何数据。

Swift
Objective-C

1
Adjust.disable()

1
[Adjust disable];

启用 SDK

+ (void)enable;

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

Swift
Objective-C

1
Adjust.enable()

1
[Adjust enable];

查看启用状态

+ (void)isEnabledWithCompletionHandler:(nonnull ADJIsEnabledGetterBlock)completion;

您可以随时通过一个 completion handler 调用 [Adjust isEnabledWithCompletionHandler] 方法，查看 Adjust SDK 是否已启用。状态为异步返回并以BOOL值的形式传递给您的 completion handler。

Swift
Objective-C

1
Adjust.isEnabled { isEnabled in
2
   // Your completion handler
3
};

1
[Adjust isEnabledWithCompletionHandler:^(BOOL isEnabled) {
2
   // Your completion handler
3
}]