@capgo/capacitor-appsflyer

概览

为您的 Capacitor 应用添加 AppsFlyer 归因、分析、延迟深度链接及 OneLink 支持

从这里开始 initSDK() 以及下方列出的其他核心方法。

平台支持

平台	支持	备注
iOS	是	原生
Android	是	原生
Web 端	否	使用 Capacitor.getPlatform() 做保护

核心功能

• initSDK - 使用此方法初始化并启动 AppsFlyer SDK。应当在 App 启动后立即调用此 API。
• startSDK - 仅在手动启动模式下，使用此方法启动 AppsFlyer SDK。
• logEvent - 记录一个 App 内事件。
• setCustomerUserId - 设置自定义 Customer ID 可以让你将自己的唯一 ID 与 AppsFlyer 的唯一 ID 及其他设备的 ID 进行交叉比对。该 ID 可在原始数据报告（raw-data reports）和 Postback APIs 中使用，以便与你的内部 ID 进行关联。

公开 API

方法	描述
addListener('conversion_callback', listener)	监听转化回调，包括： onConversionDataSuccess 以及 onConversionDataFail，其中 OnConversionDataResult payloads。
addListener('oaoa_callback', listener)	监听 App 打开归因回调，包括： onAppOpenAttribution 以及 onAttributionFailure，其中 OnAppOpenAttribution payloads。
addListener('udl_callback', listener)	通过以下方式监听统一的 deep link 回调： OnDeepLink payloads。
initSDK	使用此方法初始化并启动 AppsFlyer SDK。App 一启动就应调用此 API。
startSDK	仅在手动启动模式下，使用此方法启动 AppsFlyer SDK。
logEvent	记录一个 App 内事件。
setCustomerUserId	设置自己的 customer ID 后，你可以将自己的唯一 ID 与 AppsFlyer 的唯一 ID 及其他设备的 ID 进行交叉引用。该 ID 可在原始数据报告和 Postback APIs 中用于与你的内部 ID 交叉引用。
setCurrencyCode	设置应用内购买使用的货币。请提供三位字符的 ISO 4217 code。
updateServerUninstallToken	当其他 plugin 收集到 Android 上的 GCM/FCM token 或 iOS 上的 APNs token 时，请将其传入。用它把卸载测量 token 转发给 AppsFlyer。
setAppInviteOneLink	设置用作邀请归因基础链接的 OneLink ID。
setOneLinkCustomDomain	注册品牌 OneLink 域名，以便 AppsFlyer 解析隐藏在短链接中的归因参数。
appendParametersToDeepLinkingURL	为不使用 OneLink 的 App Links deep link 启用归因。请在此之前调用此方法 startSDK()。至少包含 pid 以及 is_retargeting=true 在参数 map 中。
setResolveDeepLinkURLs	当 AppsFlyer OneLink 被包裹在另一个 Universal Link 中时使用。它让 SDK 能解析被包裹的 URL，从而确保 deep linking 仍能正常工作。
addPushNotificationDeepLinkPath	配置 SDK 如何从推送通知 payload 中提取 deep link 值。
setSharingFilter	阻止事件传播到指定的 AppsFlyer 合作伙伴。
setSharingFilterForAllPartners	阻止事件传播到所有 AppsFlyer 合作伙伴。会覆盖 setSharingFilter。
setSharingFilterForPartners	阻止事件传播到指定的 AppsFlyer 合作伙伴。
setAdditionalData	设置要发送给 AppsFlyer 的额外键值数据。
getAppsFlyerUID	获取 AppsFlyer 的唯一设备 ID（每次新安装应用时创建）。
anonymizeUser	终端用户选择退出 AppsFlyer 分析（匿名化用户数据）。
stop	一旦调用此 API，我们的 SDK 将不再与服务器通信并停止工作。这在实现用户 opt-in/opt-out 时非常有用。
disableSKAdNetwork	选择退出 SKAdNetwork。
disableAdvertisingIdentifier	禁用 SDK 对各类广告 ID 的收集，包括 Apple 广告标识符 (IDFA)、Google 广告 ID (GAID)、OAID 和 Amazon 广告 ID (AAID)。
disableCollectASA	选择退出 Apple Search Ads 归因。
setHost	设置自定义 host。
generateInviteLink	允许现有用户邀请好友和联系人成为您应用的新用户。
validateAndLogInAppPurchaseAndroid	用于应用内购买服务器验证的 API。验证成功后，会自动记录带有相关值的 af_purchase 事件。
validateAndLogInAppPurchaseIos	查看源码定义以了解当前行为。
getSdkVersion	获取 App 中使用的 AppsFlyer SDK 版本。
enableFacebookDeferredApplinks	启用 Facebook Deferred AppLinks 收集。需要目标/客户端设备上安装 Facebook SDK 和 Facebook App。此 API 必须在初始化 AppsFlyer SDK 之前调用才能正常工作。
sendPushNotificationData	衡量并获取推送通知营销活动的数据。
setCurrentDeviceLanguage	设置设备语言。数据将显示在 Raw Data Reports 中。
logCrossPromoteImpression	记录交叉推广活动中的曝光 (impression)。请确保使用 AppsFlyer dashboard 中显示的推广 App ID。
setUserEmails	设置用户邮箱并进行加密。
logLocation	手动记录用户位置。
setPhoneNumber	将以 SHA-256 加密字符串的形式发送。
setPartnerData	允许发送自定义数据以进行合作伙伴集成。
logInvite	用于记录应用内用户邀请事件 (af_invite)。
setDisableNetworkData	用于选择不从设备收集网络运营商 (carrier) 和 SIM 卡运营商名称。
enableTCFDataCollection	用于针对使用 CMP 的用户，选择开启或关闭同意数据的自动收集。该标志值将在应用会话之间持久化。
setConsentData	使用此项手动设置用户同意数据。如果您的应用未使用兼容 TCF v2.2 的 CMP，请使用以下方法直接向 SDK 提供同意数据。
logAdRevenue	通过归因广告收入，应用所有者可以全面掌握用户 LTV 和广告活动 ROI。广告收入通过在应用内的激励视频、Offerwall、插屏广告和横幅广告中展示广告产生。您可以使用此方法记录广告收入。
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-appsflyer 要规划原生插件工作，请将其与 使用 @capgo/capacitor-appsflyer 用于“使用 @capgo/capacitor-appsflyer”中的原生能力， Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节， 添加或更新插件 关于“添加或更新插件”中的实现细节，以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。