@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` payloads。
`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, 仅在手动启动模式下.
`logEvent`	记录应用内事件.
`setCustomerUserId`	设置自己的客户端 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`	End User Opt-Out from AppsFlyer analytics (匿名化用户数据).
`stop`	Once this API is invoked, our SDK no longer communicates with our servers and stops functioning. Useful when implementing user opt-in/opt-out.
`disableSKAdNetwork`	SKAdNetwork 退出.
`disableAdvertisingIdentifier`	Disables collection of various Advertising IDs by the SDK. This includes Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID and Amazon Advertising ID (AAID).
`disableCollectASA`	Apple Search Ads 属性退出.
`setHost`	Set a custom host.
`generateInviteLink`	允许您的现有用户邀请他们的朋友和联系人作为新用户加入您的应用程序.
`validateAndLogInAppPurchaseAndroid`	API for server verification of in-app purchases. An af_purchase event with the relevant values will be automatically logged if the validation is successful.
`validateAndLogInAppPurchaseIos`	查看源定义中的当前行为.
`getSdkVersion`	Get the AppsFlyer SDK version used in app.
`enableFacebookDeferredApplinks`	启用Facebook延迟应用程序链接的收集。需要Facebook SDK 和 Facebook 应用程序在目标/客户端设备上。这个 API 必须在初始化 AppsFlyer SDK 之前被调用，以便正常工作.
`sendPushNotificationData`	推送通知营销和数据收集。
`setCurrentDeviceLanguage`	设置设备的语言。数据将在原始数据报告中显示。
`logCrossPromoteImpression`	作为跨促销活动的一部分，记录一次曝光。确保使用在AppsFlyer控制台中显示的推广应用ID。
`setUserEmails`	设置用户邮箱并加密它们。
`logLocation`	手动记录用户的位置。
`setPhoneNumber`	将以SHA-256加密的字符串形式发送。
`setPartnerData`	用于为合作伙伴集成目的发送自定义数据。
`logInvite`	用于记录用户邀请的在-app事件（af_invite）。
`setDisableNetworkData`	用于在设备上禁用收集网络运营商名称（运营商）和SIM运营商名称的功能。
`enableTCFDataCollection`	用于开启/关闭自动收集consent数据的功能，适用于使用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-only。
`validateAndLogInAppPurchaseV2`	API 用于服务器验证 V2 的应用内购买。如果验证成功，则将自动记录 af_purchase 事件及其相关值。

真实来源

此参考资料是同步从 src/definitions.ts 在 capacitor-appsflyer.