概述
概述部分Capacitor (AppsFlyer) attribution、分析和深度链接插件。
核心功能
核心功能部分initSDK- 使用此方法初始化并启动 AppsFlyer SDK。此 API 应尽早在应用程序启动时调用。startSDK- 使用此方法仅在手动启动模式下启动 AppsFlyer SDK。logEvent- 记录应用内事件。setCustomerUserId- 设置自己的客户 ID 可以让您将自己的唯一 ID 与 AppsFlyer 的唯一 ID 和其他设备的 ID 进行交叉引用。该 ID 可在原始数据报告和 Postback API 中找到，用于与内部 ID 进行交叉引用。
公共 API
标题：公共 API| 方法 | 描述 |
|---|---|
addListener('conversion_callback', listener) | 监听转换回调，包括 onConversionDataSuccess 和 onConversionDataFail, OnConversionDataResult payloads |
addListener('oaoa_callback', listener) | Listen for app-open attribution callbacks, including onAppOpenAttribution 和 onAttributionFailure， OnAppOpenAttribution payloads。 |
addListener('udl_callback', listener) | Listen for unified deep link callbacks with OnDeepLink payloads。 |
initSDK | Use this method to initialize and start AppsFlyer SDK. This API should be called as soon as the app launched。 |
startSDK | Use this method to start AppsFlyer SDK, only on manual start mode。 |
logEvent | Log an in-app event。 |
setCustomerUserId | Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and other devices’ IDs. This ID is available in raw-data reports and in the Postback APIs for cross-referencing with your internal IDs。 |
setCurrencyCode | Sets the currency used for in-app purchases. Provide a three-character ISO 4217 code. |
updateServerUninstallToken | Pass GCM/FCM tokens on Android or APNs tokens on iOS when another plugin collected them. Use this to forward uninstall measurement tokens to AppsFlyer。 |
setAppInviteOneLink | 设置用于邀请归因的 OneLink ID 作为短链的基础链接。 |
setOneLinkCustomDomain | 注册带有 AppsFlyer 可解析的归因参数的自定义 OneLink 域名。 |
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 的 Opt-out。 |
disableAdvertisingIdentifier | 禁用 SDK 收集各种广告 ID。这包括苹果广告商身份 (IDFA)、谷歌广告 ID (GAID)、OAID 和亚马逊广告 ID (AAID)。 |
disableCollectASA | 苹果搜索广告的 Opt-out 属性。 |
setHost | 设置自定义主机。 |
generateInviteLink | 允许您的现有用户邀请他们的朋友和联系人作为新用户加入您的应用程序。 |
validateAndLogInAppPurchaseAndroid | API 用于服务器验证应用内购买。成功验证后，会自动记录 af_purchase 事件并包含相关值。 |
validateAndLogInAppPurchaseIos | 查看源定义以了解当前行为。 |
getSdkVersion | 获取 AppsFlyer 应用程序中使用的 SDK 版本。 |
enableFacebookDeferredApplinks | 启用 Facebook 延迟应用链接的收集。需要 Facebook SDK 和 Facebook 应用程序在目标/客户端设备上。这个 API 必须在初始化 AppsFlyer SDK 之前调用，以正常工作。 |
sendPushNotificationData | 测量和获取推送通知活动的数据。 |
setCurrentDeviceLanguage | 设置设备的语言。数据将在原始数据报告中显示。 |
logCrossPromoteImpression | 作为跨促销活动的一部分，记录一次点击。确保使用在 AppsFlyer 控制台中显示的推广应用 ID。 |
setUserEmails | 设置用户邮箱并加密它们。 |
logLocation | 手动记录用户的位置。 |
setPhoneNumber | 将以 SHA-256 加密的字符串发送。 |
setPartnerData | 用于为合作伙伴集成目的发送自定义数据。 |
logInvite | 用于记录用户邀请的应用内事件 (af_invite)。 |
setDisableNetworkData | 用于在设备上禁用收集网络运营商名称 (carrier) 和 SIM 运营商名称的功能。 |
enableTCFDataCollection | 用于开启/关闭自动收集同意数据的功能，适用于使用 CMP 的用户。标志值将在应用会话之间持久化。 |
setConsentData | 用于手动设置用户同意数据。如果您的应用不使用与 TCF v2.2 兼容的 CMP，使用以下方法手动提供同意数据直接到 SDK。 |
logAdRevenue | 通过为广告收入进行归因，应用所有者可以获得用户 LTV 和广告活动 ROI 的完整视图。广告收入是通过在应用中显示奖励视频、推广墙、插屏广告和横幅广告来产生的。您可以使用此方法记录您的广告收入。 |
setConsentDataV2 | 手动设置用户同意数据。若您的应用程序不使用与 TCF v2.2 兼容的 CMP，使用以下方法手动向 SDK 提供同意数据。 |
isSDKStarted | 使用此方法检查 AppsFlyer SDK 是否已经在当前会话中启动。 |
isSDKStopped | 使用此方法检查 AppsFlyer SDK 是否当前处于停止状态。 |
disableAppSetId | 禁用 AppSet ID 收集。如果在 SDK 初始化之前调用此方法，App Set ID 将不会被收集。如果在初始化之后调用此方法，App Set ID 将被收集但不会在请求负载中发送。仅适用于 Android。 |
validateAndLogInAppPurchaseV2 | API 服务器端验证内购 V2。若验证成功，会自动记录 af_purchase 事件并包含相关值。 |
真实来源
标题：真实来源此参考从 src/definitions.ts 在 capacitor-appsflyer.
继续从 @capgo/capacitor-appsflyer
标题：继续从 @capgo/capacitor-appsflyerIf you are using @capgo/capacitor-appsflyer 为了规划原生插件工作，连接它与 使用 @capgo/capacitor-appsflyer 为原生能力在使用 @capgo/capacitor-appsflyer Capgo 插件目录 为产品工作流程在 Capgo 插件目录 Capacitor 由 Capgo 插件 为实现细节在 Capacitor 由 Capgo 插件 添加或更新插件 为实现细节在添加或更新插件 Ionic 企业插件替代方案 为 Ionic Enterprise Plugin Alternatives 产品工作流程。