概要:本文主要是对类和方法(包括AppsFlyer SDK)的技术说明。
相关文章
下列文档可以帮助您更全面地了解Unity插件对接流程的各个方面:
- Unity插件V6版本接入指南——总体说明
- Unity插件V6版本接入指南——基础SDK对接
- Unity插件V6版本接入指南——进阶SDK对接
- Unity插件V6版本接入指南——API参考信息(本文)
通用于安卓和iOS的API
initSDK
说明 |
使用dev key和app ID对SDK进行初始化。所有应用均需要设置dev key。仅iOS应用需要设置应用ID。如果您的应用仅在安卓平台上运行,请将应用ID设为null。游戏对象包含IAppsFlyerConversionData接口。 |
方法签名 |
|
示例 |
|
startSDK
说明 |
调用此API后SDK启动,即时发送session,且所有后台到前台的切换也记录为一个session。 |
方法签名 |
|
示例 |
|
sendEvent
说明 |
通过调用带有事件名称和值参数的sendEvent来记录应用内事件 |
方法签名 |
|
示例 |
|
stopSDK
说明 |
在某些极端情况下,出于监管机构和隐私合规性的要求,您可能需要关闭所有的SDK功能。这可以通过stopSDK API来实现。调用该API后,SDK将停止运行,并不再与AppsFlyer服务器交互。 |
方法签名 |
|
示例 |
|
isSDKStopped
说明 |
stopSDK API(布尔值)是否设置为true。 |
方法签名 |
bool isSDKStopped() |
示例 |
|
getSdkVersion
说明 |
用于获取AppsFlyer SDK的版本信息 |
方法签名 |
|
示例 |
|
setIsDebug
说明 |
用于启用调试日志 |
方法签名 |
|
示例 |
|
setCustomerUserID
说明 |
用于设置客户用户ID(CUID)。 |
方法签名 |
|
示例 |
|
setAppInviteOneLink
说明 |
用于设置OneLink模板ID,即您创建用户邀请的自定义归因链接时所使用的OneLink模板ID。 |
方法签名 |
|
示例 |
|
setAdditionalData
说明 |
用于添加要发送到外部合作伙伴平台的其他数据。 |
方法签名 |
|
示例 |
|
setResolveDeepLinkURLs
说明 |
用于解析点击域中嵌套的OneLink。详情请见解析嵌套型深度链接URL。 |
方法签名 |
|
示例 |
|
setOneLinkCustomDomain
说明 |
广告主可以使用此方法来设置品牌化的OneLink域。 |
方法签名 |
|
示例 |
|
setcurrencyCode
说明 |
用于上报事件收入。仅限使用ISO货币代码。 |
方法签名 |
|
示例 |
|
recordLocation
说明 |
手动记录用户位置 |
方法签名 |
|
示例 |
|
anonymizeUser
说明 |
在初始化期间使用,明确对用户激活、事件和session进行匿名化处理。如需停止匿名化,请再次调用anonymizeUser again并将其设置为false。 |
方法签名 |
|
示例 |
|
getAppsFlyerId
说明 |
获取AppsFlyer ID,用于标识新增激活。 |
方法签名 |
|
示例 |
|
setMinTimeBetweenSessions
说明 |
默认情况下,两个session之间必须至少间隔5秒,才能分别将其计为单独的session。该方法用于对两个session之间的最短间隔设置一个自定义的值。 |
方法签名 |
|
示例 |
|
setUserEmails
说明 |
设置用户邮箱并对其加密。 |
方法签名 |
|
示例 |
|
setHost
说明 |
设置自定义的host |
方法签名 |
|
示例 |
|
getConversionData
说明 |
用于注册转化数据监听器,以从SDK侧直接获取每个新增激活的实时用户归因数据。使用该方法后您就可以为用户呈现个性化的内容或让其跳转到应用内的具体页面,从而大幅提升用户与应用的互动。 |
方法签名 |
|
示例 |
|
attributeAndOpenStore
说明 |
对点击进行归因,并打开应用商店的相关页面。 |
方法签名 |
|
示例 |
|
recordCrossPromoteImpression
说明 |
如需对展示进行归因,请调用以下API。请务必使用AppsFlyer面板中的App ID。 |
方法签名 |
|
示例 |
|
generateUserInviteLink
说明 |
LinkGenerator类会根据各种setter方法构建邀请链接,这些方法允许在点击时传递其他信息。 |
方法签名 |
|
示例 |
|
onAppOpenAttribution
说明 |
当用户通过深度链接打开应用时,获取深度链接数据。 |
方法签名 |
|
示例 |
|
onAppOpenAttributionFailure
说明 |
用于获取深度链接数据接收出错时的错误信息。 |
方法签名 |
|
示例 |
|
onConversionDataSuccess
说明 |
用于获取转化数据。尤其适用于延迟深度链接场景,详情请见此文档。
|
方法签名 |
|
示例 |
|
onConversionDataFail
说明 |
在无法获取激活转化数据时处理错误信息。 |
方法签名 |
|
示例 |
|
onInviteLinkGenerated
说明 |
OneLink链接生成成功回调。 |
方法签名 |
|
示例 |
|
onInviteLinkGeneratedFailure
说明 |
OneLink链接生成错误回调。 |
方法签名 |
|
示例 |
|
didFinishValidateReceipt
说明 |
validateAndSendInAppPurchase API的成功回调。 安卓:回调返回“Validate success“(验证成功)。 |
方法签名 |
|
示例 |
|
didFinishValidateReceiptWithError
说明 |
票据验证错误回调。 |
方法签名 |
|
示例 |
|
setPhoneNumber
说明 |
用于设置用户电话号码。 |
方法签名 |
|
示例 |
|
setSharingFilterForAllPartners
说明 |
让广告主停止与所有广告平台/对接渠道共享数据。了解详情 |
方法签名 |
|
示例 |
|
setSharingFilter
说明 |
让广告主停止与某些(一个或多个)广告平台/对接渠道共享数据。了解详情 |
方法签名 |
|
示例 |
|
适用于安卓的API
updateServerUninstallToken
说明 |
手动传输Firebase Device Token,用于衡量卸载。 |
方法签名 |
|
示例 |
|
setImeiData
说明 |
向AppsFlyer明确发送IMEI。 |
方法签名 |
|
示例 |
|
setAndroidIdData
说明 |
向AppsFlyer明确发送Android ID。 |
方法签名 |
|
示例 |
|
waitForCustomerUserId
说明 |
用于将SDK的启动延迟到CUID设置之后。 |
方法签名 |
|
示例 |
|
setCustomerIdAndStartSDK
说明 |
向SDK提供相关的CUID,然后触发SDK正常运行。 |
方法签名 |
|
示例 |
|
getOutOfStore
说明 |
用于获取当前的AF_STORE值。 |
方法签名 |
|
示例 |
|
setOutOfStore
说明 |
用于手动设置AF_STORE值。 |
方法签名 |
|
示例 |
|
setCollectAndroidID
说明 |
用于停止对Android ID的收集。如果应用中不包含Google Play Services,则SDK会收集Android ID。但如果应用中带有Google Play Services,则不能收集Android ID,否则会违反Google Play的政策规定。 |
方法签名 |
|
示例 |
|
setCollectIMEI
说明 |
用于停止对IMEI的收集。如果应用不包含Google Play Services,则AF插件会收集IMEI。但如果应用中带有Google Play Services,则不能收集IMEI,否则会违反Google Play的政策规定。 |
方法签名 |
|
示例 |
|
setIsUpdate
说明 |
用于手动设置应用更新。 |
方法签名 |
|
示例 |
|
setPreinstallAttribution
说明 |
用于指定生产商或媒体渠道名称,以对预装进行归因。 |
方法签名 |
|
示例 |
|
isPreInstalledApp
说明 |
布尔值,用于标识生产商预装的应用。 |
方法签名 |
|
示例 |
|
getAttributionId
说明 |
用于获取Facebook归因ID(若有)。 |
方法签名 |
|
示例 |
|
handlePushNotifications
说明 |
用于获取记录到的推送通知。 |
方法签名 |
|
示例 |
|
validateAndSendInAppPurchase
说明 |
该API用于应用内购的服务器端验证。如果验证成功,则会自动发送带有相关值的af_purchase事件。 |
方法签名 |
|
示例 |
|
适用于iOS的API
setShouldCollectDeviceName
说明 |
将该标签设为true后即可收集当前的设备名称(如“My iPhone“)。默认值为“false”。 |
方法签名 |
|
示例 |
|
setDisableCollectIAd
说明 |
用于停止ASA归因。 |
方法签名 |
|
示例 |
|
setUseReceiptValidationSandbox
说明 |
Apple环境(生产环境或沙盒环境)中的应用内购票据验证。默认值为“false”。 |
方法签名 |
|
示例 |
|
setUseUninstallSandbox
说明 |
用于在Apple环境(生产环境或沙盒环境)中测试卸载。默认值为“false”。 |
方法签名 |
|
示例 |
|
validateAndSendInAppPurchase
说明 |
如需发送并验证应用内购,请从processPurchase方法中调用此方法。 |
方法签名 |
|
示例 |
|
registerUninstall
说明 |
注册远程通知并向AppsFlyer提供推送设备令牌(Push Device Token)。 |
方法签名 |
|
示例 |
|
handleOpenUrl
说明 |
用于手动记录深度链接。 |
方法签名 |
|
示例 |
|
onOpenStoreLinkGenerated
说明 |
在不关闭应用的情况下利用StoreKit组件打开App Store。了解详情。 |
方法签名 |
|
示例 |
|
disableSKAdNetwork
说明 |
用于停止SKAdNetwork归因。将该方法设置为“true”即可停用。 |
方法签名 |
|
示例 |
|
waitForATTUserAuthorizationWithTimeoutInterval
说明 |
如果您想要先通过弹窗获取用户授权,然后再读取应用相关数据,以记录该用户或设备(如IDFA),可以使用此方法。如果用户同意授权,则SDK可读取到IDFA。这里的计时间隔(timeout interval)是指等待用户授权收集IDFA的时间。如果在计时结束后仍未得到用户授权,则SDK不会收集IDFA。 |
方法签名 |
|
示例 |
|