Adjust 类
Adjust 类可用来向 Adjust 发送您应用程序和用户的相关信息。这些信息可用来进行归因,也可也来跟踪事件以进行数据分析。
方法 您可以随 Adjust SDK 记录的每个会话同时发送回传参数。多次调用该方法可添加额外的参数。
+ (void) addSessionCallbackParameter: (nonnull NSString *) key
value: (nonnull NSString *) value
全部展开
[Adjust addSessionCallbackParameter:@"foo" value:@"bar"];
Adjust.addSessionCallbackParameter("foo", value: "bar")
Adjust.addSessionCallbackParameter('foo', 'bar');
如果您添加了会话参数 ,可以晚些时候将其移除。为此,请将参数键传递至 removeSessionCallbackParameter
方法。
+ (void) removeSessionCallbackParameter: (nonnull NSString *) key
全部展开
[Adjust removeSessionCallbackParameter:@"foo"];
Adjust.removeSessionCallbackParameter("foo")
Adjust.removeSessionCallbackParameter('foo');
如果您添加了会话回传参数 ,可以晚些时候将其全部移除。为此,请调用 resetSessionCallbackParameters
方法。
+ (void) resetSessionCallbackParameters
全部展开
[Adjust resetSessionCallbackParameters];
Adjust.resetSessionCallbackParameters()
Adjust.resetSessionCallbackParameters();
您可以随 Adjust SDK 记录的每个会话向合作伙伴同时发送回传参数。多次调用该方法可添加额外的参数。
+ (void) addSessionPartnerParameter: (nonnull NSString *) key
value: (nonnull NSString *) value
全部展开
[Adjust addSessionPartnerParameter:@"foo" value:@"bar"];
Adjust.addSessionPartnerParameter("foo", value: "bar")
Adjust.addSessionPartnerParameter('foo', 'bar');
如果您添加了合作伙伴参数 ,可以晚些时候将其移除。为此,请将参数键传递至 removeSessionPartnerParameter
方法。
+ (void) removeSessionPartnerParameter: (nonnull NSString *) key
全部展开
[Adjust removeSessionPartnerParameter:@"foo"];
Adjust.removeSessionPartnerParameter("foo")
Adjust.removeSessionPartnerParameter('foo');
如果您添加了合作伙伴参数 ,可以晚些时候将其全部移除。为此,请调用 resetSessionPartnerParameters
方法。
+ (void) resetSessionPartnerParameters
全部展开
[Adjust resetSessionPartnerParameters];
Adjust.resetSessionPartnerParameters()
Adjust.resetSessionPartnerParameters();
您可以调用 adid
方法,返回用户设备的 Adjust ID (即 adid)。
全部展开
NSString *adid = [Adjust adid];
var adid = Adjust.getAdid();
要初始化 SDK,您需要先验证应用程序已经正确激活。为此,您需要将 ADJConfig object 对象 传递给 appDidLaunch
方法。
请在 `didFinishLaunching` 或 `didFinishLaunchingWithOptions` 方法末尾进行调用。
+ (void) appDidLaunch: (nullable ADJConfig *) adjustConfig
全部展开
[Adjust appDidLaunch:adjustConfig];
Adjust.appDidLaunch(adjustConfig!)
Adjust.appDidLaunch(adjustConfig);
adjustConfig
ADJConfig 对象已设置好所有可选功能的完整 ADJConfig 对象。
Adjust SDK 拥有基于 requestTrackingAuthorizationWithCompletionHandler
方法创建的包装器。您可以利用该包装器收集用户授权状态的相关信息。
[Adjust requestTrackingAuthorizationWithCompletionHandler:^(NSUInteger status) {
switch (status) {
case 0:
// ATTrackingManagerAuthorizationStatusNotDetermined case
break;
case 1:
// ATTrackingManagerAuthorizationStatusRestricted case
break;
case 2:
// ATTrackingManagerAuthorizationStatusDenied case
break;
case 3:
// ATTrackingManagerAuthorizationStatusAuthorized case
break;
}
}];
0
整数 ATTrackingManagerAuthorizationStatusNotDetermined
:用户尚未与授权请求弹窗互动1
整数 ATTrackingManagerAuthorizationStatusRestricted
:用户已在设备层级限制授权请求弹窗2
整数 ATTrackingManagerAuthorizationStatusDenied
:用户已拒绝授予访问权限3
整数 ATTrackingManagerAuthorizationStatusAuthorized
:用户已授予访问权限
自 iOS 14.5 起,用户需要授予明确许可,您才能读取设备的广告主 ID (IDFA)。您可以调用 appTrackingAuthorizationStatus
方法,向 Adjust SDK 查询许可状态。
- (int) appTrackingAuthorizationStatus
全部展开
int authorizationStatus = [Adjust appTrackingAuthorizationStatus];
let authorizationStatus = Adjust.appTrackingAuthorizationStatus()
var authorizationStatus = Adjust.appTrackingAuthorizationStatus();
全部展开
status
整数 状态代码,详细说明用户是否授予了设备跟踪权限。
0
用户尚未收到跟踪许可请求。 1
用户设备受限。 2
用户拒绝提供 IDFA。 3
用户授权访问 IDFA。 -1
状态不可用。
如果您在使用深度链接 ,可以指示 Adjust SDK 搜索 URL,查找归因信息。如果 SDK 找到了有效信息,就会将其发送给 Adjust 后端。
+ (void) appWillOpenUrl: (nonnull NSURL *) url
全部展开
[Adjust appWillOpenUrl:url];
Adjust.appWillOpenUrl(url)
用户安装您的应用后,您可以向 Adjust SDK 查询设备归因信息。
只有在 Adjust 后端跟踪到安装后,归因信息才可用。后端收到安装事件后会返回该信息。
+ (ADJAttribution *) attribution
全部展开
ADJAttribution *attribution = [Adjust attribution];
let attribution = Adjust.attribution()
var attribution = Adjust.getAttribution();
Adjust SDK 包含一个辅助功能,可以将通用链接 转化为深度链接。为此,请将您的自定义深度链接 scheme 传递至 convertUniversalLink
方法。
+ (nullable NSURL *) convertUniversalLink: (nonnull NSURL *) url
scheme: (nonnull NSString *) scheme
全部展开
[Adjust convertUniversalLink:url scheme:@"adjustExample"];
Adjust.convertUniversalLink(url, scheme: "adjustExample")
全部展开
url
URL 对象 包含深度链接信息的通用 URL。 方案
字符串 您希望添加为所得链接前缀的 scheme。
url
URL 对象 带有给定前缀的指定 scheme 格式 URL 对象。
您可以发送用户的第三方数据分享偏好。请通过第三方分享对象调用下列方法。使用用户首选项初始化对象。
您也可以传递用户偏好相关的精细信息,获取更多详情用于数据分析。
(void) + trackThirdPartySharing
全部展开
// Disable third-party sharing for the user
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:@NO];
[Adjust trackThirdPartySharing:adjustThirdPartySharing];
// Enable third-party sharing for the user
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:@YES];
[Adjust trackThirdPartySharing:adjustThirdPartySharing];
// Gather granular details
ADJThirdPartySharing *adjustThirdPartySharing = [[ADJThirdPartySharing alloc] initWithIsEnabledNumberBool:nil];
[adjustThirdPartySharing addGranularOption:@"PartnerA" key:@"foo" value:@"bar"];
[Adjust trackThirdPartySharing:adjustThirdPartySharing];
// Disable third-party sharing for the user
let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(false)
Adjust.trackThirdPartySharing(adjustThirdPartySharing)
// Enable third-party sharing for the user
let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(true)
Adjust.trackThirdPartySharing(adjustThirdPartySharing)
// Gather granular details
let adjustThirdPartySharing = ADJThirdPartySharing.initWithIsEnabledNumberBool(nil)
adjustThirdPartySharing.addGranularOption("PartnerA", key: "foo", value: "bar")
Adjust.trackThirdPartySharing(adjustThirdPartySharing)
// Disable third-party sharing for the user
var adjustThirdPartySharing = new AdjustThirdPartySharing(false);
Adjust.trackThirdPartySharing(adjustThirdPartySharing);
// Enable third-party sharing for the user
var adjustThirdPartySharing = new AdjustThirdPartySharing(true);
Adjust.trackThirdPartySharing(adjustThirdPartySharing);
// Gather granular details
var adjustThirdPartySharing = new AdjustThirdPartySharing(null);
adjustThirdPartySharing.addGranularOption('PartnerA', 'foo', 'bar');
Adjust.trackThirdPartySharing(adjustThirdPartySharing);
您可以调用 disableThirdPartySharing
方法,禁用第三方信息分享。默认状态下,该方法设为 false
。
+ (void) disableThirdPartySharing
全部展开
[Adjust disableThirdPartySharing];
Adjust.disableThirdPartySharing()
Adjust.disableThirdPartySharing();
如果您正在使用 Adjust 的数据隐私 设置,就需要在 Adjust SDK 中进行切换。请调用 trackMeasurementConsent
方法进行设置。
+ (void) trackMeasurementConsent: (BOOL) enabled
全部展开
[Adjust trackMeasurementConsent:YES];
Adjust?.trackMeasurementConsent(true)
Adjust.trackMeasurementConsent(true);
您可以允许用户要求行使被遗忘权。在调用该方法时,Adjust 会将遗忘请求传递至 Adjust 后端,后端就会移除用户信息。
您可以调用 idfa
方法,调取设备广告主 ID (IDFA)。
+ (nullable NSString *) idfa
全部展开
NSString *idfa = [Adjust idfa];
Adjust.getIdfa(function(idfa) {
// …
});
您可以调用 setEnabled
方法,启用或禁用 Adjust SDK 跟踪。
+ (void) setEnabled: (BOOL) enabled
全部展开
Adjust.setEnabled(false);
您可以调用 isEnabled
方法,查看 Adjust SDK 是否已启用。
全部展开
Adjust.isEnabled(function(isEnabled) {
if (isEnabled) {
// SDK is enabled.
} else {
// SDK is disabled.
}
});
如果您希望验证设备当前运行的 Adjust SDK 版本,可以调用 sdkVersion
方法。
+ (NSString *) sdkVersion
SDK 版本
字符串 SDK 版本 (格式: iosX. Y. Z
)。
如果您使用推送通知 进行再归因,就需要将识别码添加至 Adjust SDK。
+ (void) setDeviceToken: (nonnull NSData *) deviceToken
全部展开
[Adjust setDeviceToken:deviceToken];
Adjust.setDeviceToken(deviceToken)
Adjust.setDeviceToken(deviceToken);
deviceToken
数据 您的 Apple 推送标签 (Push token)
用户设备离线时,您可以将 SDK 设为离线模式,将事件加入队列。在离线模式下,Adjust SDK 会存储所有事件,SDK 上线后会尝试发送事件。
离线模式设置在应用打开之间不被保存。即使在上一次应用打开时开启了离线模式,SDK 重新启动时也将始终处于在线模式。
+ (void) setOfflineMode: (BOOL) enabled
全部展开
[Adjust setOfflineMode:YES]; // Enables offline mode
[Adjust setOfflineMode:NO]; // Disables offline mode
Adjust.setOfflineMode(true) // Enables offline mode
Adjust.setOfflineMode(false)// Disables offline mode
Adjust.setOfflineMode(true) // Enables offline mode
Adjust.setOfflineMode(false)// Disables offline mode
Adjust SDK 支持从特定渠道合作伙伴接收广告收入信息。您可以将渠道合作伙伴 SDK 记录的信息以 JSON 对象的形式发送到 Adjust SDK。
此功能只能用于特定广告收入来源。请查看受支持的来源列表。
+ (void) trackAdRevenue: (nonnull NSString *) source
payload: (nonnull NSData *) payload
全部展开
// initilise ADJAdRevenue instance with appropriate ad revenue source
ADJAdRevenue *adRevenue = [[ADJAdRevenue alloc] initWithSource:source];
// pass revenue and currency values
[adRevenue setRevenue:1.6currency:@"USD"];
// pass optional parameters
[adRevenue setAdImpressionsCount:adImpressionsCount];
[adRevenue setAdRevenueUnit:adRevenueUnit];
[adRevenue setAdRevenuePlacement:adRevenuePlacement];
[adRevenue setAdRevenueNetwork:adRevenueNetwork];
// attach callback and/or partner parameter if needed
[adRevenue addCallbackParameter:key value:value];
[adRevenue addPartnerParameter:key value:value];
// track ad revenue
[Adjust trackAdRevenue:source payload:payload];
// initilise ADJAdRevenue instance with appropriate ad revenue source
let adRevenue = ADJAdRevenue(source: source)
// pass revenue and currency values
adRevenue.setRevenue(1.6, currency: "USD")
// pass optional parameters
adRevenue.adImpressionsCount= adImpressionsCount
adRevenue.adRevenueUnit= adRevenueUnit
adRevenue.adRevenuePlacement= adRevenuePlacement
adRevenue.adRevenueNetwork= adRevenueNetwork
// attach callback and/or partner parameter if needed
adRevenue.addCallbackParameter(key,value: value)
adRevenue.addPartnerParameter(key,value: value)
// track ad revenue
Adjust.trackAdRevenue(source,payload: payload)
全部展开
source
字符串 广告收入信息来源。 payload
数据对象 广告收入信息的 JSON payload。
ADJAdRevenueSourceAppLovinMAX
启用 AppLovin MAX 广告收入跟踪。 ADJAdRevenueSourceAdmob
启用 AdMob 广告收入跟踪。 ADJAdRevenueSourceIronsource
启用 ironSource 广告收入跟踪。 ADJAdRevenueSourceAdMost
启用 Admost 广告收入跟踪。 ADJAdRevenueSourceUnity
启用 Unity 广告收入跟踪。 ADJAdRevenueSourceHeliumChartboost
启用 Helium Chartboost 广告收入跟踪。 ADJAdRevenueSourcePublisher
启用一般来源的广告收入跟踪。
Adjust SDK 可允许您将事件信息传递回 Adjust 后端,此信息会显示在原始数据导出 中。
+ (void) trackEvent: (nullable ADJEvent *) event
全部展开
ADJEvent *event = [ADJEvent eventWithEventToken:@"abc123"];
[Adjust trackEvent:event];
let event = ADJEvent(eventToken: "abc123")
Adjust.trackEvent(event)
事件
ADJEvent 对象您想跟踪事件的 ADJEvent 对象。应当通过来自 Adjust 控制面板的事件识别码进行设置。
Adjust SDK 允许您跟踪应用内订阅事件相关的信息。为此,您可以创建订阅 (subscription) 对象,并将其传送给 SDK。
+ (void) trackSubscription: (nonnull ADJSubscription *) subscription
全部展开
ADJSubscription *subscription = [[ADJSubscription alloc] initWithPrice:price
currency:currency
transactionId:transactionId
andReceipt:receipt];
[Adjust trackSubscription:subscription];
let subscription = ADJSubscription(
price: price,
currency: currency,
transactionId: transactionId,
andReceipt: receipt)
Adjust.trackSubscription(subscription)
您可以调用 trakSubsessionEnd
方法,通知 Adjust SDK 应用程序已经暂停。
+ (void) trackSubsessionEnd
全部展开
[Adjust trackSubsessionEnd];
Adjust.trackSubsessionEnd()
您可以调用 trakSubsessionStart
方法,通知 Adjust SDK 应用程序已经恢复。
全部展开
[Adjust trackSubsessionStart];
Adjust.trackSubsessionStart()
如果您延迟了 Adjust SDK 启动,SDK 就会在延迟计时器结束后才将信息发送给后端。您可以使用此方法要求 SDK 在延迟时间结束前发送包。
+ (void) sendFirstPackages
全部展开
[Adjust sendFirstPackages];
Adjust.sendFirstPackages()