跳转至正文

安装 Install Referrer Capacitor 插件

从 Capacitor 读取 Google Play 安装来源数据和 Apple AdServices 归因数据

安装

bun add @capgo/capacitor-install-referrer bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-install-referrer
  • pnpm add @capgo/capacitor-install-referrer
  • yarn add @capgo/capacitor-install-referrer

指南

如何在 Capacitor 中使用 Install Referrer

在设备上测试

下载 Capgo App,然后扫描二维码 code。

Install Referrer 插件预览二维码 code

使用 @capgo/capacitor-install-referrer

@capgo/capacitor-install-referrer 在 Capacitor 应用中读取安装归因信号。

通过统一的 API,在 Android 上获取 Google Play Install Referrer 数据,并在 iOS 上获取 Apple AdServices 归因 token。

安装

bun add @capgo/capacitor-install-referrer
bunx cap sync

插件暴露的内容

  • getReferrer 返回 Android 或 iOS 的安装归因详情。
  • GetReferrer 是用于从以下版本迁移的已弃用兼容别名: cap-play-install-referrer.
  • Android 会返回 Play referrer 字符串、点击时间戳、安装时间戳以及 instant app 标记。
  • iOS 会返回 AdServices attribution token,还可以选择获取 Apple 的 attribution payload。

用法示例

import { InstallReferrer } from '@capgo/capacitor-install-referrer';

const result = await InstallReferrer.getReferrer();

if (result.platform === 'android') {
  console.log(result.referrer);
}

if (result.platform === 'ios') {
  console.log(result.attributionToken);
}

Apple 归因载荷

const result = await InstallReferrer.getReferrer({
  fetchAppleAttribution: true,
  appleAttributionRetryCount: 3,
  appleAttributionRetryDelayMs: 5000,
});

console.log(result.appleAttribution);

平台注意事项

Android 使用 Google Play Install Referrer 服务,且必须通过 Play Store 安装才能拿到真实的 referrer 数据。iOS 使用 Apple AdServices,因为 Apple 并没有提供通用的 App Store 安装 referrer 等效机制。

完整参考

从“使用 @capgo/capacitor-install-referrer”继续

如果你正在使用 使用 @capgo/capacitor-install-referrer 要规划原生插件工作,请将其与 @capgo/capacitor-install-referrer 有关 @capgo/capacitor-install-referrer 的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Install Referrer 插件常见问题

如何在 Capacitor 应用中安装 Install Referrer 插件?

运行 "bun add @capgo/capacitor-install-referrer"(或 "npm install @capgo/capacitor-install-referrer"),然后运行 "bunx cap sync",让 iOS 和 Android 项目识别到原生 code。再在应用 code 中从 "@capgo/capacitor-install-referrer" 导入。

@capgo/capacitor-install-referrer 支持 React、Vue 和 Angular 吗?

支持。Install Referrer 是一个 Capacitor 包,因此可与任何运行在 Capacitor 中的 Web 框架配合使用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-install-referrer 支持哪个 Capacitor 版本?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-install-referrer 是免费开源的吗?

是的。code 的源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-install-referrer/,该包可从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

能否不经过 App Store 审核,更新使用了 Install Referrer 的 code?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App Store 审核,即可即时发布 Install Referrer 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo