@capgo/电容-面书-分析

从您的 Capacitor app 在 iOS 和 Android 上发送 Meta (Facebook) App Events, 以测量您的 Meta 广告活动的安装,购买和转换.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-facebook-analytics 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-facebook-analysis到我的Capacitor应用上并把它接上 代理设置指南 • 妇女 主机磁共振

主要特点

• 应用事件数字 : initAppEvents() 启动 Facebook SDK 并激活 App Events .
• 自定义事件数字 : logEvent() 记录任何带有参数的事件.
• 采购数字 : logPurchase() 用货币记录收入.
• 广告跟踪数字 : enableAdvertiserTracking(), (中文(简体) ), disableAdvertiserTracking() 财务报告和审定财务报表 getAdvertiserTrackingStatus(). 在iOS 17上以及后来的状态反映了App Track Introduction. 在iOS 16以及更早的时候,设置者会更改Facebook SDK旗.
• 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 使用官方的Facebook SDKs. 事件日志无法上网 .

安装

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

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

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

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

bun add @capgo/capacitor-facebook-analytics
bunx cap sync

使用量

import {
  FacebookAnalytics,
  FacebookEventName,
  FacebookEventParameterName,
} from '@capgo/capacitor-facebook-analytics';

await FacebookAnalytics.enableAdvertiserTracking();
await FacebookAnalytics.initAppEvents();

await FacebookAnalytics.logEvent({
  event: FacebookEventName.CompletedRegistration,
  params: {
    [FacebookEventParameterName.RegistrationMethod]: 'email',
  },
});

await FacebookAnalytics.logEvent({
  event: FacebookEventName.AddedToCart,
  valueToSum: 19.99,
  currency: 'USD',
  params: {
    [FacebookEventParameterName.ContentType]: 'product',
    [FacebookEventParameterName.ContentId]: 'sku-123',
  },
});

await FacebookAnalytics.logPurchase({
  amount: 9.99,
  currency: 'USD',
});

原生设置

在您的本地应用程序中配置 Meta app id 和客户端符 。 此插件不会为您创建这些值 .

iOS系统

将您的元值添加到应用程序 Info.plist数字 :

<key>FacebookAppID</key>
<string>YOUR_FACEBOOK_APP_ID</string>
<key>FacebookClientToken</key>
<string>YOUR_FACEBOOK_CLIENT_TOKEN</string>
<key>FacebookDisplayName</key>
<string>YOUR_APP_NAME</string>

当广告商的追踪 被你同意的流,打电话 enableAdvertiserTracking() 在伐木活动之前.

如果自动 Meta App 事件记录被禁用(FacebookAutoLogAppEventsEnabled =: false因此,初始化可以等待同意,呼叫 initAppEvents() 只有在同意和ATT流出之后 在iOS上,这个在激活 App Events 之前初始化 FBSDK 。 关于Android, FacebookInitProvider 通常执行基本 sdkInitialize() 启动时 AutoInitEnabled 财务报告和审定财务报表 AutoLogAppEventsEnabled 控制全部初始化和自动事件记录; initAppEvents() 需要时完成基本输入(例如如果提供者被删除),然后调用 activateApp()不调用 ApplicationDelegate.shared.initializeSDK() 从 AppDelegate 在流出之前,它会启动Meta.

机器人

将您的元值添加到应用程序 AndroidManifest.xml数字 :

<meta-data android:name="com.facebook.sdk.ApplicationId" android:value="@string/facebook_app_id" />
<meta-data android:name="com.facebook.sdk.ClientToken" android:value="@string/facebook_client_token" />

添加字符串资源到 android/app/src/main/res/values/strings.xml数字 :

<string name="facebook_app_id">YOUR_FACEBOOK_APP_ID</string>
<string name="facebook_client_token">YOUR_FACEBOOK_CLIENT_TOKEN</string>

解决问题

"FacebookAnalytics" plugin is not implemented on android

这通常意味着Capacitor没有注册本地的Android插件. 检查如下:

1. 运行 bunx cap sync 在安装或升级插件后.
2. 确认 @capgo/capacitor-facebook-analytics 在Android同步输出中列出.
3. 添加元数据 ApplicationId 财务报告和审定财务报表 ClientToken 从上面的Android设置部分录入.
4. 升级到 @capgo/[email protected] 或更新 如果你在老建筑.

如果 Meta SDK 设置缺失,事件调用仍然可以以明显的错误拒绝,但一旦同步成功,插件本身应该在Android上注册.

API 密码

• initAppEvents()
• logEvent(...)
• logPurchase(...)
• enableAdvertiserTracking()
• disableAdvertiserTracking()
• getAdvertiserTrackingStatus()
• getPluginVersion()
• 接口
• 类型异名

Facebook App Events 分析桥.

initAppEvents () (英语)

initAppEvents() => Promise<void>

初始化Facebook SDK并激活App Events.

当自动程序事件记录被禁用时调用, 您想要 在您同意后开始发送事件 .

在iOS上,这个初始化了主线程上的 FBSDK,然后激活 App 活动.

关于Android, FacebookInitProvider 通常运行基本的 SDK 设置通过 FacebookSdk.sdkInitialize() 在应用程序启动. com.facebook.sdk.AutoInitEnabled 控制路径是否也调用 FacebookSdk.fullyInitialize() (服务器通信). com.facebook.sdk.AutoLogAppEventsEnabled 自动控制 activateApp() 伐木业。 当提供者被移除时 (例如 @capgo/capacitor-social-login)或基本内涵从来 完成, 这种方法调用 sdkInitialize() 等待着它 InitializeCallback,然后通过 setAutoInitEnabled(true) 打电话前 activateApp()。 。 。 . activateApp() 光是SDK根本不够 初始化或仅基本初始化完成.

不初始化 Facebook 从 AppDelegate 同意的应用程序; 在用户获得广告计量同意后,拨打这种方法.

日志事件(...)

logEvent(options: LogEventOptions) => Promise<void>

登录Facebook App事件.

对数购买 (...)

logPurchase(options: LogPurchaseOptions) => Promise<void>

登录Facebook购买活动 .

启用 Advertiser 跟踪 ()

enableAdvertiserTracking() => Promise<void>

启用广告商跟踪 .

IOS 16 及以下各集 Settings.shared.isAdvertiserTrackingEnabled。 。 。 . 在iOS 17及以上 FBSDK v17+上直接读取App Track Track Transference. 在Android上,这个可以使广告商ID收藏.

禁用Advertiser跟踪()

disableAdvertiserTracking() => Promise<void>

禁用广告商跟踪.

IOS 16 及以下各集 Settings.shared.isAdvertiserTrackingEnabled。 。 。 . 在iOS 17及以上 FBSDK v17+上直接读取App Track Track Transference. 在Android上,这禁用广告商的ID收藏.

获取 Advertiser 跟踪状态 ()

getAdvertiserTrackingStatus() => Promise<AdvertiserTrackingStatusResult>

获取当前广告商跟踪状态.

在iOS 17及以上,这反映了App Track Introduction的授权.

回返情况: Promise<AdvertiserTrackingStatusResult>

获取 PluginVersion ()

getPluginVersion() => Promise<PluginVersionResult>

返回平台执行版本标记 .

回返情况: Promise<PluginVersionResult>

接口

日志结果选项

日志购买选项

广告跟踪状态

插件变压器

类型异名

Facebook 活动Name

Facebook标准事件名称.

(typeof FacebookEventName)[keyof typeof FacebookEventName]

Facebook 活动

事件参数由Facebook标准参数名或自定义名称所键入.

Record<FacebookEventParameterName | string, FacebookEventParamValue>

记录

构造 T 类型 K 的一组属性类型

{ [P in K]: T; }

脸书EventParamValue

被本地的Facebook App Evolutions SDKs所接受的价值.

布尔值被转换为 Facebook 切换字符串 : true 变成 "1" 财务报告和审定财务报表 false 变成 "0"。 。 。 .

string | number | boolean | null

脸书事件Comment

Facebook标准事件参数名.

(typeof FacebookEventParameterName)[keyof typeof FacebookEventParameterName]