@capgo/capacitor-appsflyer

Capacitor plugin for AppsFlyer attribution, analytics, and deep links.

概述

Capacitor 为 AppsFlyer 提供的插件，用于 attribution、analytics 和深度链接。

核心功能

initSDK - 使用此方法初始化并启动 AppsFlyer SDK。此 API 应该在应用启动时立即调用。
startSDK - 只在手动启动模式下使用此方法启动 AppsFlyer SDK。
logEvent - 记录应用内事件。
setCustomerUserId - 设置您的客户 ID 可以让您将您的唯一 ID 与 AppsFlyer 的唯一 ID 和其他设备的 ID 进行交叉引用。该 ID 可在原始数据报告中以及在 Postback API 中用于与您的内部 ID 进行交叉引用。

Public API

方法	描述
`addListener('conversion_callback', listener)`	监听转换回调，包括 `onConversionDataSuccess` 和 `onConversionDataFail`, `OnConversionDataResult` 带有
`addListener('oaoa_callback', listener)`	的付款。 `onAppOpenAttribution` 监听应用开启归因回调，包括 `onAttributionFailure`和 `OnAppOpenAttribution` 数据包。
`addListener('udl_callback', listener)`	使用此方法来初始化和启动 AppsFlyer __CAPGO_KEEP_0__。这个 __CAPGO_KEEP_1__ 应该在应用启动时立即调用。 `OnDeepLink` 使用此方法来启动 AppsFlyer __CAPGO_KEEP_0__，仅在手动启动模式下。
`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`	设置用于应用内购买的货币。提供一个三位字符的 ISO 4217 __CAPGO_KEEP_0__。
`setCustomerUserId`	将 GCM/FCM 代币传递给 Android 或 APNs 代币传递给 iOS，另一个插件收集它们。使用此方法将卸载测量代币传递给 AppsFlyer。
`setCurrencyCode`	Sets the currency used for in-app purchases. Provide a three-character ISO 4217 code.
`updateServerUninstallToken`	注册带有品牌 OneLink 域名的 AppsFlyer，可以解析短链中的归因参数。
`setAppInviteOneLink`	启用 App Links 深度链接的归因，仅在不使用 OneLink 时。调用此方法之前
`setOneLinkCustomDomain`	设置用于应用内事件的事件名称。
`appendParametersToDeepLinkingURL`	设置用于应用内事件的事件值。 `startSDK()`包括至少 `pid` 和 `is_retargeting=true` 在参数映射中。
`setResolveDeepLinkURLs`	使用此选项时，应用商店链接（AppsFlyer OneLink）被包裹在另一个Universal Link中。它让SDK解析包裹的URL，以便深度链接仍然正常工作。
`addPushNotificationDeepLinkPath`	配置SDK从推送通知包中提取深度链接值的方式。
`setSharingFilter`	停止事件从指定的应用商店合作伙伴传播。
`setSharingFilterForAllPartners`	停止所有应用商店合作伙伴的事件传播。覆盖设置的共享过滤器。
`setSharingFilterForPartners`	停止事件从指定的应用商店合作伙伴传播。
`setAdditionalData`	发送额外的键值对数据到应用商店。
`getAppsFlyerUID`	获取应用商店的唯一设备ID（为每个新安装的应用创建）。
`anonymizeUser`	应用商店分析（匿名化用户数据）的终端用户退回选项。
`stop`	一旦调用了此API，我们的SDK将不再与我们的服务器通信并停止工作。有用时在实现用户同意/退回时使用。
`disableSKAdNetwork`	退出SKAdNetwork。
`disableAdvertisingIdentifier`	禁用SDK收集各种广告标识符。这包括苹果广告商标识符（IDFA）、谷歌广告标识符（GAID）、OAID和亚马逊广告标识符（AAID）。
`disableCollectASA`	退出苹果搜索广告的归因。
`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-appsflyer 来规划原生插件工作，连接它使用 @capgo/capacitor-appsflyer 使用 @capgo/capacitor-appsflyer Capgo 插件目录 Capgo 插件目录 Capacitor 由 Capgo 提供的插件 Capacitor 由 Capgo 提供的插件添加或更新插件添加或更新插件 Ionic 企业插件替代方案 Ionic 企业插件替代方案