@capgo/capacitor-appsflyer

Capacitor用于AppsFlyer的属性、分析和深度链接插件。

概述

Capacitor用于AppsFlyer的属性、分析和深度链接插件。

核心功能

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

公共 API

方法	描述
`addListener('conversion_callback', listener)`	监听转换回调，包括 `onConversionDataSuccess` 和 `onConversionDataFail`, `OnConversionDataResult` ，
`addListener('oaoa_callback', listener)`	监听应用启动事件回调，包括 `onAppOpenAttribution` 和 `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。此__CAPGO_KEEP_1__应在应用启动时立即调用。
`logEvent`	使用此方法启动AppsFlyer __CAPGO_KEEP_0__，仅在手动启动模式下。
`setCustomerUserId`	记录应用内事件。
`setCurrencyCode`	Sets the currency used for in-app purchases. Provide a three-character ISO 4217 code.
`updateServerUninstallToken`	设置用于应用内购买的货币。提供一个三位字符的 ISO 4217 __CAPGO_KEEP_0__。
`setAppInviteOneLink`	设置用于邀请来源归因的 OneLink ID。
`setOneLinkCustomDomain`	注册品牌化的 OneLink 域名，以便 AppsFlyer 可以解析短链中的归因参数。
`appendParametersToDeepLinkingURL`	启用 App Links 深度链接的归因。请在调用此方法之前 `startSDK()`至少包含 `pid` 和 `is_retargeting=true` 在参数映射中。
`setResolveDeepLinkURLs`	当 AppsFlyer 的 OneLink 包含在另一个 Universal Link 内时，使用此方法。它让 SDK 解析包装 URL，以便深度链接仍然正常工作。
`addPushNotificationDeepLinkPath`	配置 SDK 从推送通知包中提取深度链接值的方式。
`setSharingFilter`	停止事件传播到指定的 AppsFlyer 合作伙伴。
`setSharingFilterForAllPartners`	停止事件传播到所有 AppsFlyer 合作伙伴。覆盖 setSharingFilter。
`setSharingFilterForPartners`	停止事件传播到指定的 AppsFlyer 合作伙伴。
`setAdditionalData`	向 AppsFlyer 发送额外的键值对数据。
`getAppsFlyerUID`	获取 AppsFlyer 的设备 ID（每个新安装的应用程序都会创建一个）。
`anonymizeUser`	AppsFlyer 分析的用户隐私保护（匿名化用户数据）。
`stop`	一旦调用了这个 API，我们的 SDK 就不会再与我们的服务器通信，停止运行。适用于实现用户自愿/自愿选择的场景。
`disableSKAdNetwork`	SKAdNetwork 的 Opt-out。
`disableAdvertisingIdentifier`	禁用 SDK 收集的广告 ID。包括苹果广告 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`	[__CAPGO_KEEP_0__]
`setCurrentDeviceLanguage`	获取推送通知活动的数据
`logCrossPromoteImpression`	设置设备语言，数据会在原始数据报告中显示
`setUserEmails`	在跨促销活动中记录一次点击。确保使用应用程序ID，应用程序ID在AppsFlyer控制台中显示
`logLocation`	设置用户邮箱并加密
`setPhoneNumber`	手动记录用户位置
`setPartnerData`	将会以SHA-256加密的字符串发送
`logInvite`	用于发送给合作伙伴的自定义数据
`setDisableNetworkData`	用于记录用户邀请的事件（af_invite）
`enableTCFDataCollection`	用于关闭收集网络运营商名称（carrier）和SIM卡运营商名称的功能
`setConsentData`	Use this to set user consent data manually. If your app doesn’t use a CMP compatible with TCF v2.2, use the following method to manually provide the consent data directly to the SDK.
`logAdRevenue`	用于手动设置用户consent数据。如果您的应用程序不使用与TCF v2.2兼容的CMP，使用以下方法手动提供consent数据直接给__CAPGO_KEEP_0__。
`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.