# @capgo/capacitor-install-referrer 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-install-referrer/

版本：8\.1\.15
npm 元数据更新时间：2026-10-15T05:35:23.461Z
中文译文更新时间：2026-11-09T03:02:14.745Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-install-referrer
原文对照：https://npmcn.com/package/%40capgo/capacitor-install-referrer/?lang=original
项目主页：https://capgo.app/docs/plugins/install-referrer/
源码仓库：https://github.com/Cap-go/capacitor-install-referrer

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：71.1 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-05-06T07:14:56.082Z
- 最新版本发布：2026-10-15T05:35:23.103Z
- 近 30 天下载量：61497（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

阅读 Google Play 的 Capacitor 插件 安装参考器和 Apple AdServices 属性.

## 安装

```sh
npm install @capgo/capacitor-install-referrer
```

也可以使用：`pnpm add @capgo/capacitor-install-referrer`、`yarn add @capgo/capacitor-install-referrer`、`bun add @capgo/capacitor-install-referrer`

## README

# @ capgo/ 电容- install- referrer

找出一个安装来自哪里:Google Play安装参考器在Android上和Apple AdServices在iOS上的归属,一个呼叫背后. 属性安装到没有完整的 MMP SDK 的运动 .

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-install-referrer)](https://capgo.app/?ref=plugin_install_referrer)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_install_referrer)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_install_referrer) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-install-referrer` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _加入@capgo/capor-install-referrer到我的Capacitor应用上,并把它接上。"_ [代理设置指南](https://capgo.app/agents/?ref=plugin_install_referrer) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_install_referrer)

![@capgo/capacitor-install-referrer for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-install-referrer/main/assets/github-social-preview.png)

## 主要特点

-   **一通电话**数字 : `getReferrer()` 返回本地安装属性细节.
-   **机器人**:读取Google Play安装参考器,包括裁判员字符串和时间戳.
-   **iOS系统**: 返回 Apple 服务归属符.
-   **苹果搜索广告**设置 `fetchAppleAttribution` 获取 Apple 的归属有效载荷.
-   **滴入别名**数字 : `GetReferrer()` 用于为旧的裁判员插件写入代码.
-   **平台**: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 在网上不可用.

安装属性的电容插件 。 Android读取了Google Play安装参考器,而iOS则使用Apple AdServices属性符,带有可选的Apple搜索Ads属性查询.

与Capacitor 8. 兼容.

## 平台行为

-   Android还原了"Play"安装参考器字符串,点击时间戳,安装时间戳,以及即时体验旗.
-   iOS 返回 AdServices 归属符. 设定取回AppleAttributiation为真来直接从原生代码要求苹果公司获得归属有效载荷.
-   iOS不提供通用的App Store安装等同Google Play的参考. Apple AdServices覆盖了Apple Search Ads的归属.
-   网络不可用,拒绝电话.

## 安装

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

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

然后使用下列提示:

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

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

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

## 使用量

```ts
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);
}
```

从 iOS 本地代码获取 Apple 属性有效载荷 :

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

console.log(result.appleAttribution);
```

Get Referrer () 也可以作为从cap- play- install- referrer 中迁移的应用程序被贬损的相容性别名.

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| v八._。 。 。 ._ | v八._。 。 。 ._ | 对 |
| v._。 。 。 ._ | v._。 。 。 ._ | 应要求 |
| v6 (英语)._。 。 。 ._ | v6 (英语)._。 。 。 ._ | 没有 |

## API 密码

-   [`getReferrer(...)`](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-getreferrer)
-   [`GetReferrer(...)`](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-getreferrer)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-interfaces)

Base API用于获取安装参考和归属细节.

### 获取参考文件(...)

```typescript
getReferrer(options?: GetReferrerOptions | undefined) => Promise<GetReferrerResult>
```

返回本地安装属性细节 .

Android读取了Google Play安装参考器API. iOS返回一个Apple AdServices归属符并可以可选取Apple的归属有效载荷.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[GetReferrerOptions](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-getreferreroptions)` |

**回返情况:** `Promise<[GetReferrerResult](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-getreferrerresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 获取参考文件(...)

```typescript
GetReferrer(options?: GetReferrerOptions | undefined) => Promise<GetReferrerResult>
```

由 Cap-play-install-referreer 所启发的插件的后向兼容化名.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[GetReferrerOptions](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-getreferreroptions)` |

**回返情况:** `Promise<[GetReferrerResult](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-getreferrerresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<PluginVersionResult>
```

返回平台执行版本标记 .

**回返情况:** `Promise<[PluginVersionResult](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-pluginversionresult)>`

**自:** 8.0.0 (单位:千美元)

* * *

### 接口

#### 获取参考结果

安装本地平台返回的裁判员和归属细节 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`platform`** | `string` | 产生结果的平台. Android return android; iOS return ios. (原始内容存档于2018-10-12). | 8.0.0 (单位:千美元) |
| **`referrer`** | `string` | 仅限Android. Raw Google Play 安装裁判员字符串. | 8.0.0 (单位:千美元) |
| **`clickTimestampSeconds`** | `number` | 仅限Android. 客户端点击时间戳数秒. | 8.0.0 (单位:千美元) |
| **`installBeginTimestampSeconds`** | `number` | 仅限Android. 客户端安装数秒后开始时间戳. | 8.0.0 (单位:千美元) |
| **`googlePlayInstantParam`** | `boolean` | 仅限Android. 当用户启动您的应用程序的即时体验时是真实的. | 8.0.0 (单位:千美元) |
| **`attributionToken`** | `string` | 仅iOS. 苹果服务归属符. 将此令牌发送给您的后端 MMP, 或苹果公司在其 TTL 范围内的 AdServices API . | 8.0.0 (单位:千美元) |
| **`appleAttribution`** | `[AppleAttributionRecord](https://npmcn.com/package/%40capgo/capacitor-install-referrer/#readme-appleattributionrecord)` | 仅iOS. Apple AdService在取回AppleAttribution时的归属有效载荷是真实的. | 8.0.0 (单位:千美元) |

#### AppleArbitution 记录

安装 Apple 服务返回的属性值 .

苹果可能随着时间的推移会添加字段,因此未知的密钥被保存.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`attribution`** | `boolean` | 当苹果找到匹配的苹果搜索阿德斯归属记录时是真. | 8.0.0 (单位:千美元) |

#### 获取参考选项

读取安装属性的选项 .

| Prop | 类型 | 说明 | 默认 | 自兹 |
| --- | --- | --- | --- | --- |
| **`fetchAppleAttribution`** | `boolean` | 仅iOS. 当真实时,插件会向苹果公司发送AdServices归属符并返回AppleAttribution中的归属有效载荷. 如果您想要将归属Token 发送到自己的后端或 MMP 时, 请保留此错误 . | `false` | 8.0.0 (单位:千美元) |
| **`appleAttributionRetryCount`** | `number` | 仅iOS. 404回應后再试Apple的归属终点的次数. 当符号有效但归属数据尚未准备好时,苹果可以返回404. | `3` | 8.0.0 (单位:千美元) |
| **`appleAttributionRetryDelayMs`** | `number` | 仅iOS. 苹果归属重试之间的延迟,以毫秒计. | `5000` | 8.0.0 (单位:千美元) |

#### 插件变压器

插件版本有效载荷 .

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`version`** | `string` | 版本标识符由平台执行返回. |

## 常见问题

### @capgo/capacitor-install-referrer 是什么？

阅读 Google Play 的 Capacitor 插件 安装参考器和 Apple AdServices 属性\.

### 如何安装 @capgo/capacitor-install-referrer？

在项目目录运行 npm install @capgo/capacitor-install-referrer，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-install-referrer 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-install-referrer 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-install-referrer 可以商用吗？

@capgo/capacitor-install-referrer 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-install-referrer 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-install-referrer 在 2026/10/09 – 2026/11/07 这 30 天内被下载 61,497 次，日均约 2,050 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-install-referrer 还在维护吗？

最新版本 8\.1\.15 发布于 2026/10/15（25 天前）；至今共发布 16 个版本，其中过去 12 个月发布了 16 个；首次发布于 2026/05/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。