概述
概述Capacitor用于AppsFlyer的 attribution、分析和深度链接的插件。
核心能力
概述initSDK- 使用此方法初始化并启动AppsFlyer SDK。此API应在应用启动时立即调用。startSDK- 使用此方法启动AppsFlyer SDK，仅在手动启动模式下。logEvent- 日志应用事件。setCustomerUserId- 设置自己的客户ID使您能够将自己的唯一ID与AppsFlyer的唯一ID和其他设备的ID进行交叉引用。该ID可在原始数据报告和Postback API中找到，用于与内部ID进行交叉引用。
| 方法 | 初始化并启动 AppsFlyer __CAPGO_KEEP_0__。这个 __CAPGO_KEEP_1__ 应该在应用启动时立即调用。 |
|---|---|
addListener('conversion_callback', listener) | 监听转换回调，包括 onConversionDataSuccess 和 onConversionDataFail, OnConversionDataResult 带有 |
addListener('oaoa_callback', listener) | 的数据包。 onAppOpenAttribution 监听应用打开 attribution 回调，包括 onAttributionFailure和 OnAppOpenAttribution , |
addListener('udl_callback', listener) | 带有 OnDeepLink 的数据包。 |
initSDK | Use this method to initialize and start AppsFlyer SDK. This API should be called as soon as the app launched. |
startSDK | 仅在手动启动模式下使用此方法启动 AppsFlyer SDK。 |
logEvent | 记录应用内事件。 |
setCustomerUserId | 设置自己的客户 ID 可以让您将自己的唯一 ID 与 AppsFlyer 的唯一 ID 和其他设备的 ID 进行交叉引用。这 ID 可以在原始数据报告和 Postback API 中找到，以便与您的内部 ID 进行交叉引用。 |
setCurrencyCode | 设置用于应用内购买的货币。提供一个三位字符的 ISO 4217 code。 |
updateServerUninstallToken | 将 GCM/FCM 代币传递给 Android 或 APNs 代币传递给 iOS，另一个插件收集它们。使用此方法将卸载测量代币传递给 AppsFlyer。 |
setAppInviteOneLink | 设置用于邀请归因的 OneLink ID 作为邀请归因的基础链接。 |
setOneLinkCustomDomain | 注册带有归因参数的短链的自定义 OneLink 域名，以便 AppsFlyer 可以解析。 |
appendParametersToDeepLinkingURL | 启用 App Links 深度链接的归因，未使用 OneLink。请在调用此方法之前 startSDK()包含至少 pid 和 is_retargeting=true 在参数映射中 |
setResolveDeepLinkURLs | 使用此方法，当 AppsFlyer OneLink 包含在另一个 Universal Link 内时。它让 SDK 解析包装 URL，以便深度链接仍然正常工作。 |
addPushNotificationDeepLinkPath | 配置SDK从推送通知包中提取深度链接值的方式。 |
setSharingFilter | 停止事件传播到指定的AppsFlyer合作伙伴。 |
setSharingFilterForAllPartners | 停止事件传播到所有AppsFlyer合作伙伴。 覆盖已设置的共享过滤器。 |
setSharingFilterForPartners | 停止事件传播到指定的AppsFlyer合作伙伴。 |
setAdditionalData | 向AppsFlyer发送额外的键值对数据。 |
getAppsFlyerUID | 获取AppsFlyer的唯一设备ID（每个新安装的应用程序都会创建一个）。 |
anonymizeUser | 从AppsFlyer分析中排除用户（匿名化用户数据）。 |
stop | 一旦调用了这个API，我们的SDK就不再与我们的服务器通信并停止运行。 在实施用户同意/拒绝时有用。 |
disableSKAdNetwork | 退出SKAdNetwork。 |
disableAdvertisingIdentifier | 禁用SDK收集各种广告ID。 这包括苹果广告商身份（IDFA）、谷歌广告ID（GAID）、OAID和亚马逊广告ID（AAID）。 |
disableCollectASA | 退出苹果搜索广告的归因。 |
setHost | 设置自定义主机。 |
generateInviteLink | 允许您的现有用户邀请他们的朋友和联系人作为新用户加入您的应用。 |
validateAndLogInAppPurchaseAndroid | API用于验证应用内购买。验证成功时，会自动记录一个af_purchase事件，包含相关值。 |
validateAndLogInAppPurchaseIos | 查看源定义以了解当前行为。 |
getSdkVersion | 获取AppsFlyer SDK版本，用于应用。 |
enableFacebookDeferredApplinks | 启用Facebook延迟应用链接的收集。需要Facebook SDK和Facebook应用在目标/客户端设备上。这个API必须在初始化AppsFlyer SDK之前调用，以正常工作。 |
sendPushNotificationData | 测量和获取推送通知campaign的数据。 |
setCurrentDeviceLanguage | 设置设备语言。数据将在Raw Data Reports中以原始形式显示。 |
logCrossPromoteImpression | 作为跨促销活动的一部分，记录一个 impression。确保使用在AppsFlyer控制台中显示的推广应用ID。 |
setUserEmails | 设置用户邮箱并加密它们。 |
logLocation | 手动记录用户位置。 |
setPhoneNumber | 将以SHA-256加密的字符串发送。 |
setPartnerData | 用于发送自定义数据以支持合作伙伴集成目的。 |
logInvite | 使用来记录用户邀请内应用事件（af_invite）。 |
setDisableNetworkData | 使用来关闭收集网络运营商名称（carrier）和SIM卡运营商名称的功能。 |
enableTCFDataCollection | 使用来开启/关闭自动收集consent数据，适用于使用CMP的用户。标志值将在应用程序会话之间持久化。 |
setConsentData | 使用此方法来手动设置用户consent数据。如果您的应用程序不使用与TCF v2.2兼容的CMP，请使用以下方法手动提供consent数据直接到SDK。 |
logAdRevenue | 通过将广告收入归因于应用程序所有者，应用程序所有者可以获得用户LTV和广告活动ROI的完整视图。广告收入是通过在应用程序中显示奖励视频、推广墙、插屏广告和横幅广告来产生的。您可以使用此方法来记录广告收入。 |
setConsentDataV2 | 使用此方法来手动设置用户consent数据。如果您的应用程序不使用与TCF v2.2兼容的CMP，请使用以下方法手动提供consent数据直接到SDK。 |
isSDKStarted | 使用此方法来检查是否已经在当前会话中启动了AppsFlyerSDK。 |
isSDKStopped | 使用此方法来检查是否已经在当前会话中停止了AppsFlyerSDK。 |
disableAppSetId | 禁用AppSet ID的收集。如果在SDK初始化之前调用此方法，App Set ID将不会被收集。如果在初始化后调用此方法，App Set ID将被收集但不会在请求负载中发送。仅适用于Android。 |
validateAndLogInAppPurchaseV2 | API用于验证内应用购买V2。成功验证后，将自动记录一个af_purchase事件，包含相关值。 |
真实数据来源
真实数据来源此参考资料与 src/definitions.ts 在 capacitor-appsflyer.