跳过内容
Capgo - 实时更新 Capacitor 应用程序 Capgo

开始使用

GitHub

安装

标题：安装

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

终端窗口
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.

如果您prefer手动设置，安装插件并运行以下命令，然后按照以下平台特定的说明：

终端窗口
bun add @capgo/capacitor-appsflyer
bunx cap sync

导入

标题：导入
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
import type {
  AFAdRevenueData,
  AFAndroidInAppPurchase,
  AFAnonymizeUser,
  AFAppendToDeepLink,
  AFConsentData,
  AFConsentOptions,
  AFCuid,
  AFCurrency,
  AFData,
  AFDisable,
  AFEmails,
  AFEnableTCFDataCollection,
  AFEvent,
  AFFbDAL,
  AFFilters,
  AFHost,
  AFInit,
  AFIosInAppPurchase,
  AFLanguage,
  AFLatLng,
  AFLinkGenerator,
  AFLogInvite,
  AFOnelinkDomain,
  AFOnelinkID,
  AFPartnerData,
  AFPath,
  AFPhone,
  AFPromotion,
  AFPurchaseDetailsV2,
  AFPushPayload,
  AFUninstall,
  AFUrls,
} from '@capgo/capacitor-appsflyer';

API概述

标题：API概述

initSDK

标题：initSDK

使用此方法初始化并启动AppsFlyer SDK。此 API 应在应用启动时立即调用。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.initSDK({} as AFInit);

startSDK

标题：startSDK

使用此方法在手动启动模式下启动AppsFlyer SDK。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.startSDK();

logEvent

标题：logEvent

记录应用内事件。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

Section titled “setCustomerUserId”

设置客户端用户 ID

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setCustomerUserId({} as AFCuid);

setCurrencyCode

复制到剪贴板

Sets the currency used for in-app purchases. Provide a three-character ISO 4217 code.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

复制到剪贴板

Section titled “updateServerUninstallToken”

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.updateServerUninstallToken({} as AFUninstall);
复制到剪贴板

Section titled “setAppInviteOneLink”

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Section titled “setOneLinkCustomDomain”

为 AppsFlyer 注册自定义的 OneLink 域名，方便解析短链中的属性参数。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Section titled “appendParametersToDeepLinkingURL”

启用 App Links 深度链接的属性跟踪，方法是在参数映射中包含以下内容 startSDK()和 pid 在参数映射中包含以下内容 is_retargeting=true 复制到剪贴板

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

当 AppsFlyer 的 OneLink 包裹在另一个 Universal Link 中时，使用此选项。 它让 __CAPGO_KEEP_0__ 解析包裹的 URL，确保深度链接仍然正常工作。

Use this when an AppsFlyer OneLink is wrapped inside another Universal Link. It lets the SDK resolve the wrapped URL so deep linking still works correctly.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

“添加推送通知深度链接路径”

配置SDK从推送通知包中提取深度链接值的方式。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

“设置分享过滤器”

阻止事件传播到指定的AppsFlyer合作伙伴。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

“设置所有合作伙伴的分享过滤器”

阻止事件传播到所有AppsFlyer合作伙伴。覆盖了setSharingFilter。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

“设置指定合作伙伴的分享过滤器”

阻止事件传播到指定的AppsFlyer合作伙伴。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Section titled “setAdditionalData”

设置 AppsFlyer 的额外键值数据。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

Section titled “getAppsFlyerUID”

获取 AppsFlyer 的设备 ID（每个新安装的应用程序都会创建一个）。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.getAppsFlyerUID();

anonymizeUser

Section titled “anonymizeUser”

结束用户在 AppsFlyer 分析中的隐私保护（匿名化用户数据）。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Section titled “stop”

一旦调用了这个 API，我们的 SDK 就不会再与我们的服务器通信，停止运行。 在实施用户隐私保护时有用。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.stop();

disableSKAdNetwork

Section titled “disableSKAdNetwork”

SKAdNetwork 选项

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Section titled “disableAdvertisingIdentifier”

此选项会禁用 SDK 收集各种广告标识符，包括苹果广告商标识符（IDFA）、谷歌广告标识符（GAID）、OAID 和亚马逊广告标识符（AAID）。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Section titled “disableCollectASA”

禁用苹果搜索广告的属性

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Section titled “setHost”

设置自定义主机

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setHost({} as AFHost);
Section titled “生成邀请链接”

允许您的现有用户邀请他们的朋友和联系人作为新用户加入您的应用

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

Section titled “验证并登录应用内购买Android”

API用于服务器验证应用内购买。 如果验证成功，会自动记录一个af_purchase事件，包含相关值。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);

validateAndLogInAppPurchaseIos

Section titled “验证并登录应用内购买iOS”

查看当前合同的源定义。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Section titled “获取SDK版本”

获取应用中使用的AppsFlyer SDK版本。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.getSdkVersion();
Section titled “enableFacebookDeferredApplinks”

Enable the collection of Facebook Deferred AppLinks. Requires Facebook SDK and Facebook app on target/client device. This API must be invoked before initializing the AppsFlyer SDK in order to function properly.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

复制到剪贴板

Section titled “sendPushNotificationData”

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

复制到剪贴板

Section titled “setCurrentDeviceLanguage”

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

复制到剪贴板

Section titled “logCrossPromoteImpression”

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Section titled “setUserEmails”

设置用户邮箱并加密。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Section titled “logLocation”

手动记录用户位置。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Section titled “setPhoneNumber”

将以SHA-256加密的字符串发送。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Section titled “setPartnerData”

允许为合作伙伴整合目的发送自定义数据。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Section titled “logInvite”

用于在应用内记录用户邀请事件（af_invite）。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Section titled “setDisableNetworkData”

用于关闭从设备中收集网络运营商名称（carrier）和SIM卡运营商名称的功能。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Section titled “enableTCFDataCollection”

用于开启/关闭自动收集用户同意数据，针对使用CMP的用户。 标志值将在应用会话之间持久化。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Section titled “setConsentData”

用于手动设置用户同意数据。 如果您的应用不使用兼容TCF v2.2的CMP，使用以下方法手动提供同意数据直接到SDK。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Section titled “logAdRevenue”

通过为广告收入进行归因，应用程序所有者可以获得完整的用户LTV和营销ROI视图。 广告收入是通过在应用程序中显示奖励视频、推广墙、插屏广告和横幅广告来产生的。 您可以使用此方法记录广告收入。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Section titled “setConsentDataV2”

使用此方法手动设置用户同意数据。 如果您的应用程序不使用与TCF v2.2兼容的CMP，请使用以下方法手动向SDK提供同意数据。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Section titled “isSDKStarted”

使用此方法检查是否在当前会话中已启动AppsFlyerSDK。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.isSDKStarted();

isSDKStopped

Section titled “isSDKStopped”

使用此方法检查AppsFlyerSDK是否当前已停止。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.isSDKStopped();

disableAppSetId

Section titled “disableAppSetId”

关闭AppSet ID收集。若在SDK初始化前调用，则App Set ID不会被收集。 若在初始化后调用，则App Set ID会被收集但不会在请求包中发送。 仅适用于Android。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

Section titled “validateAndLogInAppPurchaseV2”

API用于验证和记录应用内购买V2。 如果验证成功，则会自动记录一个af_purchase事件，包含相关值。

import { AppsFlyer } from '@capgo/capacitor-appsflyer';


await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

真实数据来源

Section titled “真实数据来源”

本页面是由插件的 src/definitions.ts.重新同步此页面时，应根据API的最新版本进行同步。

继续从Getting Started

Section titled “继续从Getting Started”

如果您正在使用 入门 来规划仪表板和API操作，连接它与 使用@capgo/capacitor-appsflyer 为native能力在使用@capgo/capacitor-appsflyer API概述 为API概述的实现细节 介绍 为介绍的实现细节 API密钥 为API密钥的实现细节，并且 设备 了解设备的实现细节。