中文

Adjust 类

Adjust 类可用来向 Adjust 发送您应用程序和用户的相关信息。这些信息可用来进行归因,也可也来跟踪事件以进行数据分析。

方法

针对每次会话发送回传参数

您可以随 Adjust SDK 记录的每个会话同时发送回传参数。多次调用该方法可添加额外的参数。

+ (void) addSessionCallbackParameter: (nonnull NSString *) key
                               value: (nonnull NSString *) value

Objective-C

Swift

Javascript

移除会话回传参数

如果您添加了会话参数,可以晚些时候将其移除。为此,请将参数键传递至 removeSessionCallbackParameter 方法。

+ (void) removeSessionCallbackParameter: (nonnull NSString *) key

Objective-C

Swift

Javascript

重置所有会话回传参数

如果您添加了会话回传参数,可以晚些时候将其全部移除。为此,请调用 resetSessionCallbackParameters 方法。

+ (void) resetSessionCallbackParameters

Objective-C

Swift

Javascript

针对每次会话将回传参数发送至渠道合作伙伴

您可以随 Adjust SDK 记录的每个会话向合作伙伴同时发送回传参数。多次调用该方法可添加额外的参数。

+ (void) addSessionPartnerParameter: (nonnull NSString *) key
                              value: (nonnull NSString *) value

Objective-C

Swift

Javascript

移除发送给合作伙伴的回传参数

如果您添加了合作伙伴参数,可以晚些时候将其移除。为此,请将参数键传递至 removeSessionPartnerParameter 方法。

+ (void) removeSessionPartnerParameter: (nonnull NSString *) key

Objective-C

Swift

Javascript

重置所有发送给合作伙伴的回传参数

如果您添加了合作伙伴参数,可以晚些时候将其全部移除。为此,请调用 resetSessionPartnerParameters 方法。

+ (void) resetSessionPartnerParameters

Objective-C

Swift

Javascript

获取设备的 Adjust ID

您可以调用 adid 方法,返回用户设备的 Adjust ID (即 adid)。

请注意:
只有在安装成功被跟踪后 adid 才可用。
+ (NSString *) adid

Objective-C

Swift

Javascript

返回值

验证应用是否正确启动

To initialize the SDK, you need to verify that your application launched properly. To do this, you can pass your ADJConfig object to the appDidLaunch method:

请注意:
请在 `didFinishLaunching` 或 `didFinishLaunchingWithOptions` 方法末尾进行调用。
+ (void) appDidLaunch: (nullable ADJConfig *) adjustConfig

Objective-C

Swift

Javascript

参数

处理 App Tracking Transparency 选择

Adjust SDK 拥有基于 requestTrackingAuthorizationWithCompletionHandler 方法创建的包装器。您可以利用该包装器收集用户授权状态的相关信息。

Objective-C

返回值

调取当前跟踪授权状态

自 iOS 14.5 起,用户需要授予明确许可,您才能读取设备的广告主 ID (IDFA)。您可以调用 appTrackingAuthorizationStatus 方法,向 Adjust SDK 查询许可状态。

- (int) appTrackingAuthorizationStatus

Objective-C

Swift

Javascript

返回值

从 URL 中获取深度链接归因信息

如果您在使用深度链接,可以指示 Adjust SDK 搜索 URL,查找归因信息。如果 SDK 找到了有效信息,就会将其发送给 Adjust 后端。

+ (void) appWillOpenUrl: (nonnull NSURL *) url

Objective-C

Swift

参数

获取当前归因数据

用户安装您的应用后,您可以向 Adjust SDK 查询设备归因信息。

请注意:
只有在 Adjust 后端跟踪到安装后,归因信息才可用。后端收到安装事件后会返回该信息。
+ (ADJAttribution *) attribution

Objective-C

Swift

Javascript

返回值

将通用 URL 转化为 scheme URL

Adjust SDK 包含一个辅助功能,可以将通用链接转化为深度链接。为此,请将您的自定义深度链接 scheme 传递至 convertUniversalLink 方法。

+ (nullable NSURL *) convertUniversalLink: (nonnull NSURL *) url
                                   scheme: (nonnull NSString *) scheme

Objective-C

Swift

参数

返回值

变更第三方分享选项

您可以发送用户的第三方数据分享偏好。请通过第三方分享对象调用下列方法。使用用户首选项初始化对象。

您也可以传递用户偏好相关的精细信息,获取更多详情用于数据分析。

(void) + trackThirdPartySharing

Objective-C

Swift

Javascript

禁用第三方数据分享

您可以调用 disableThirdPartySharing 方法,禁用第三方信息分享。默认状态下,该方法设为 false

+ (void) disableThirdPartySharing

Objective-C

Swift

Javascript

在 SDK 中启用数据隐私设置

如果您正在使用 Adjust 的数据隐私设置,就需要在 Adjust SDK 中进行切换。请调用 trackMeasurementConsent 方法进行设置。

+ (void) trackMeasurementConsent: (BOOL) enabled

Objective-C

Swift

Javascript

允许用户要求行使 GDPR 被遗忘权

您可以允许用户要求行使被遗忘权。在调用该方法时,Adjust 会将遗忘请求传递至 Adjust 后端,后端就会移除用户信息。

- (void) gdprForgetMe

Objective-C

Swift

Javascript

收集设备 IDFA

您可以调用 idfa 方法,调取设备广告主 ID (IDFA)。

+ (nullable NSString *) idfa

Objective-C

Swift

Javascript

返回值

启用或禁用 Adjust SDK

您可以调用 setEnabled 方法,启用或禁用 Adjust SDK 跟踪。

请注意:
默认状态下 Adjust SDK 始终启用。您可以调用 checkEnabled 方法查看 SDK 状态。
+ (void) setEnabled: (BOOL) enabled

Objective-C

Swift

Javascript

检查 Adjust SDK 是否启用

您可以调用 isEnabled 方法,查看 Adjust SDK 是否已启用。

+ (BOOL) isEnabled

Objective-C

Swift

Javascript

检查 Adjust SDK 版本

如果您希望验证设备当前运行的 Adjust SDK 版本,可以调用 sdkVersion 方法。

+ (NSString *) sdkVersion

Objective-C

Swift

返回值

设置推送标签 (Push token)

如果您使用推送通知进行再归因,就需要将识别码添加至 Adjust SDK。

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

Objective-C

Swift

Javascript

参数

启用或禁用离线模式

用户设备离线时,您可以将 SDK 设为离线模式,将事件加入队列。在离线模式下,Adjust SDK 会存储所有事件,SDK 上线后会尝试发送事件。

重要提示:
离线模式设置在应用打开之间不被保存。即使在上一次应用打开时开启了离线模式,SDK 重新启动时也将始终处于在线模式。
+ (void) setOfflineMode: (BOOL) enabled

Objective-C

Swift

Javascript

跟踪特定来源的广告收入

Adjust SDK 支持从特定渠道合作伙伴接收广告收入信息。您可以将渠道合作伙伴 SDK 记录的信息以 JSON 对象的形式发送到 Adjust SDK。

请注意:
此功能只能用于特定广告收入来源。请查看受支持的来源列表。
+ (void) trackAdRevenue: (nonnull NSString *) source
                payload: (nonnull NSData *)   payload 

Objective-C

Swift

参数

跟踪事件

Adjust SDK 可允许您将事件信息传递回 Adjust 后端,此信息会显示在原始数据导出中。

+ (void) trackEvent: (nullable ADJEvent *) event

Objective-C

Swift

参数

跟踪订阅

Adjust SDK 允许您跟踪应用内订阅事件相关的信息。为此,您可以创建订阅 (subscription) 对象,并将其传送给 SDK。

+ (void) trackSubscription: (nonnull ADJSubscription *) subscription

Objective-C

Swift

参数

通知 SDK 应用程序已暂停

您可以调用 trakSubsessionEnd 方法,通知 Adjust SDK 应用程序已经暂停。

请注意:
只有在系统层级通知无法使用时,才需要调用该方法。
+ (void) trackSubsessionEnd

Objective-C

Swift

通知 SDK 应用程序已恢复

您可以调用 trakSubsessionStart 方法,通知 Adjust SDK 应用程序已经恢复。

请注意:
只有在系统层级通知无法使用时,才需要调用该方法。

Objective-C

Swift

要求 SDK 发送初始负载 (payload)

如果您延迟了 Adjust SDK 启动,SDK 就会在延迟计时器结束后才将信息发送给后端。您可以使用此方法要求 SDK 在延迟时间结束前发送包。

+ (void) sendFirstPackages

Objective-C

Swift