概述
概述Capacitor AppsFlyer 插件
initSDK使用此方法来初始化并启动 AppsFlyer SDK。此 API 应该在应用启动时立即调用。startSDK- 只在手动启动模式下使用此方法来启动 AppsFlyer SDK.logEvent__CAPGO_KEEP_1__setCustomerUserId- 设置您的客户 ID 可以让您将您的独特 ID 与 AppsFlyer 的独特 ID 和其他设备的 ID 进行交叉引用。该 ID 可在原始数据报告和 Postback API 中找到,用于与您的内部 ID 进行交叉引用。
Public API
标题:Public API| 方法 | 描述 |
|---|---|
addListener('conversion_callback', listener) | 监听转换回调,包括 onConversionDataSuccess 和 onConversionDataFail,带有 OnConversionDataResult 数据包。 |
addListener('oaoa_callback', listener) | 监听应用开启 attribution 回调,包括 onAppOpenAttribution 和 onAttributionFailure,带有 OnAppOpenAttribution payloads. |
addListener('udl_callback', listener) | 使用 AppsFlyer 的统一深度链接回调。 OnDeepLink payloads. |
initSDK | 使用此方法来初始化并启动 AppsFlyer SDK. 应该在应用启动时立即调用此 API. |
startSDK | 仅在手动启动模式下启动 AppsFlyer SDK。 |
logEvent | 记录应用内事件。 |
setCustomerUserId | 设置自己的客户 ID,允许您将自己的唯一 ID 与 AppsFlyer 的唯一 ID 和其他设备的 ID 进行交叉引用。该 ID 可在原始数据报告和 Postback API 中找到,用于与内部 ID 进行交叉引用。 |
setCurrencyCode | 设置用于应用内购买的货币。提供一个三位字符的 ISO 4217 code。 |
updateServerUninstallToken | 将 Android 上的 GCM/FCM 令牌或 iOS 上的 APNs 令牌传递给 AppsFlyer。使用此方法将卸载测量令牌传递给 AppsFlyer。 |
setAppInviteOneLink | 设置用于邀请属性的 OneLink ID 作为邀请属性的基础链接。 |
setOneLinkCustomDomain | 注册带有 AppsFlyer 可解析的属性的 OneLink 域名。 |
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. |
disableAdvertisingIdentifier | 禁用 SDK 收集各种广告 ID。这包括苹果广告商身份 (IDFA)、谷歌广告 ID (GAID)、OAID 和亚马逊广告 ID (AAID)。 |
disableCollectASA | 关闭苹果搜索广告的归因. |
setHost | 设置自定义主机. |
generateInviteLink | 允许您的现有用户邀请他们的朋友和联系人作为新用户加入您的应用. |
validateAndLogInAppPurchaseAndroid | API 用于服务器验证应用内购买。成功验证后,会自动记录 af_purchase 事件,包含相关值. |
validateAndLogInAppPurchaseIos | 查看源定义以了解当前行为. |
getSdkVersion | 获取 AppsFlyer SDK 版本. |
enableFacebookDeferredApplinks | 启用 Facebook 延迟应用链接的收集。需要 Facebook SDK 和 Facebook 应用在目标/客户端设备上。必须在初始化 AppsFlyer SDK 之前调用此 API 才能正常工作. |
sendPushNotificationData | 测量和获取推送通知营销活动的数据. |
setCurrentDeviceLanguage | 设置设备语言。数据将在 Raw Data Reports 中显示. |
logCrossPromoteImpression | 作为跨促销活动的一部分,记录一次点击。确保使用在 AppsFlyer 控制台中显示的推广应用 ID. |
setUserEmails | 设置用户邮箱并加密它们。 |
logLocation | 手动记录用户位置。 |
setPhoneNumber | 将以SHA-256加密的字符串形式发送。 |
setPartnerData | 允许为合作伙伴整合目的发送自定义数据。 |
logInvite | 使用此方法记录用户邀请内应用事件(af_invite)。 |
setDisableNetworkData | 使用此方法跳过收集设备上的网络运营商名称(carrier)和SIM卡运营商名称。 |
enableTCFDataCollection | 使用此方法开启/关闭自动收集consent数据,适用于使用CMP的用户。标志值将在应用会话之间持久化。 |
setConsentData | 使用此方法手动设置用户consent数据。如果您的应用不使用与TCF v2.2兼容的CMP,请使用以下方法直接向SDK提供consent数据。 |
logAdRevenue | 通过为广告收入进行归因,应用所有者可以获得完整的用户LTV和广告活动ROI视图。广告收入通过在应用中显示奖励视频、推广墙、插屏广告和横幅广告来产生。您可以使用此方法记录广告收入。 |
setConsentDataV2 | 使用此方法手动设置用户consent数据。如果您的应用不使用与TCF v2.2兼容的CMP,请使用以下方法直接向SDK提供consent数据。 |
isSDKStarted | 使用此方法检查AppsFlyerSDK是否已经在当前会话中启动。 |
isSDKStopped | 使用此方法检查AppsFlyerSDK是否当前处于停止状态。 |
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 为native能力在使用@capgo/capacitor-appsflyer Capgo 插件目录 为产品工作流程在Capgo 插件目录 Capacitor 插件由Capgo 为实现细节在Capacitor 插件由Capgo 添加或更新插件 为实现细节在添加或更新插件,并且 Ionic企业插件替代品 为产品工作流程在Ionic企业插件替代品。