@capgo/capacitor-appsflyer

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

概述

Capacitor 为 AppsFlyer 提供的 attribution、分析和深度链接插件。

核心功能

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`- payload `OnConversionDataResult` - payload
`addListener('oaoa_callback', listener)`	监听应用程序打开的 attribution 回调，包括 `onAppOpenAttribution` 和 `onAttributionFailure`，带有 `OnAppOpenAttribution` 数据包。
`addListener('udl_callback', listener)`	监听统一的深度链接回调，带有 `OnDeepLink` 数据包。
`initSDK`	使用此方法初始化并启动 AppsFlyer SDK。此 API 应该在应用程序启动时立即调用。
`startSDK`	使用此方法启动 AppsFlyer SDK，仅在手动启动模式下。
`logEvent`	记录应用内事件。
`setCustomerUserId`	设置自己的客户 ID 可以让您将自己的唯一 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 合作伙伴。覆盖 setSharingFilter。
`setSharingFilterForPartners`	停止事件传播到指定的 AppsFlyer 合作伙伴。
`setAdditionalData`	设置向 AppsFlyer 发送的额外键值数据。
`getAppsFlyerUID`	获取 AppsFlyer 的设备 ID（每个新安装的应用程序都会创建一个）。
`anonymizeUser`	从 AppsFlyer 分析中排除用户（匿名化用户数据）。
`stop`	一旦调用了这个 API，我们的 SDK 就不会再与我们的服务器通信，停止运行。适用于实现用户同意/拒绝功能。
`disableSKAdNetwork`	关闭 SKAdNetwork。
`disableAdvertisingIdentifier`	禁用 SDK 收集各种广告 ID。这包括苹果广告 ID（IDFA）、谷歌广告 ID（GAID）、OAID 和亚马逊广告 ID（AAID）。
`disableCollectASA`	关闭苹果搜索广告的归因。
`setHost`	设置自定义主机。
`generateInviteLink`	允许您的现有用户邀请他们的朋友和联系人作为新用户加入您的应用程序。
`validateAndLogInAppPurchaseAndroid`	API 用于服务器验证应用内购买。成功验证后，会自动记录 af_purchase 事件并包含相关值。
`validateAndLogInAppPurchaseIos`	查看源定义以了解当前行为。
`getSdkVersion`	Get the AppsFlyer SDK version used in app.
`enableFacebookDeferredApplinks`	启用 Facebook 延迟应用链接的收集。需要 Facebook SDK 和 Facebook 应用程序在目标/客户端设备上。必须在初始化 AppsFlyer SDK 之前调用这个 API 才能正常工作。
`sendPushNotificationData`	通过推送通知campaign获取数据。
`setCurrentDeviceLanguage`	设置设备的语言。数据将在Raw Data Reports中显示。
`logCrossPromoteImpression`	作为跨促销campaign的一部分，记录一次impression。确保使用在AppsFlyer控制台中显示的promoted app ID。
`setUserEmails`	设置用户邮箱并加密。
`logLocation`	手动记录用户位置。
`setPhoneNumber`	将以SHA-256加密的字符串发送。
`setPartnerData`	用于发送自定义数据，用于合作伙伴集成目的。
`logInvite`	用于记录用户邀请in-app事件（af_invite）。
`setDisableNetworkData`	用于关闭收集网络运营商名称（carrier）和SIM运营商名称的功能。
`enableTCFDataCollection`	用于开启/关闭自动收集consent数据的功能，适用于使用CMP的用户。标志值将在app session之间持久化。
`setConsentData`	用于手动设置用户consent数据。如果您的app不使用与TCF v2.2兼容的CMP，请使用以下方法手动提供consent数据直接到SDK。
`logAdRevenue`	通过为广告收入进行归因，应用程序所有者可以获得用户LTV和广告活动ROI的完整视图。广告收入是通过在应用程序中显示奖励视频、offer walls、插屏广告和横幅广告来产生的。您可以使用此方法记录您的广告收入。
`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 企业插件替代方案 {"targetLanguage":"Simplified Chinese","pagePath":"/zh/docs/plugins/appsflyer/","protectedTokens":["Cloudflare","Capacitor","GitHub","Capgo","code","API","SDK","CLI","npm","bun"],"items":[{"text":"为 Ionic 企业插件替代方案中的产品工作流程"},{"text":"编辑页面"}]}