# @capacitor-firebase/analytics 中文文档

规范地址：https://npmcn.com/package/%40capacitor-firebase/analytics/

版本：8\.6\.0
npm 元数据更新时间：2026-10-31T07:03:04.807Z
中文译文更新时间：2026-11-09T02:00:23.953Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40capacitor-firebase/analytics
原文对照：https://npmcn.com/package/%40capacitor-firebase/analytics/?lang=original
项目主页：https://capawesome.io/
源码仓库：https://github.com/capawesome-team/capacitor-firebase

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

- 包体积（解压后）：162 kB，30 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：firebase ^12\.6\.0，@capacitor/core \>=8\.0\.0
- 首次发布：2022-03-19T21:28:56.630Z
- 最新版本发布：2026-10-31T07:03:04.463Z
- 近 30 天下载量：399370（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：58（近 12 个月 14 个）

## 中文简介

在Android,iOS,和Web上用于Firebase Analytics的电容插件.

## 安装

```sh
npm install @capacitor-firebase/analytics
```

也可以使用：`pnpm add @capacitor-firebase/analytics`、`yarn add @capacitor-firebase/analytics`、`bun add @capacitor-firebase/analytics`

## README

# 电容火碱分析插件

非官方电容插件 [火场分析](https://firebase.google.com/docs/analytics)\[^1\]

[![Try Capawesome Cloud free for 14 days — iOS builds without a Mac](https://capawesome.io/assets/banners/cloud-free-trial-capacitor-apps.png)](https://capawesome.io/)

## 使用大小写

Firebase Analytics插件一般用来理解用户如何与您的应用程序互动,例如:

-   **事件跟踪**: 使用自定义参数登录应用程序事件,例如签名 `logEvent(...)`。 。 。 .
-   **屏幕跟踪**: 记录用户访问的屏幕 `setCurrentScreen(...)`。 。 。 .
-   **观众分门别类**: 指定用户ID和自定义用户属性来分割用户.
-   **同意管理**:设置用户的同意模式并允许或禁用数据收集以遵守隐私要求.
-   **换算计量**: 启动在iOS上使用电子邮件地址或电话号码进行设备转换测量.

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 8.x.x (英语) | \>=8.x.x | 积极支持 |
| 7.x.x (中文(简体) ) | 7.x.x (中文(简体) ) | 折旧 |
| 6.x.x (中文(简体) ) | 6.x.x (中文(简体) ) | 折旧 |
| 5.x.x (中文(简体) ) | 5.x.x (中文(简体) ) | 折旧 |
| 1.x.x (中文(简体) ) | 4.x.x (中文(简体) ) | 折旧 |

## 指南

-   [Capacitor 中带有火基分析的跟踪 App事件](https://capawesome.io/blog/capacitor-firebase-analytics-guide/):记录事件,跟踪屏幕,并用这个插件设置观众分区.
-   [如何在电容App中使用火把](https://capawesome.io/blog/how-to-use-firebase-in-a-capacitor-app/): Analytics 坐在其他Firebase插件中的位置,哪些团队通常会同时加入.

## 安装

你可以用我们的 **AI 辅助设置** 以安装插件. 添加数据 [超级技能](https://github.com/capawesome-team/skills) 至您的 AI 工具,使用以下命令:

```bash
npx skills add capawesome-team/skills --skill capacitor-plugins
```

然后使用下列提示:

```
Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/analytics` plugin in my project.
```

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

```bash
npm install @capacitor-firebase/analytics firebase
npx cap sync
```

如果您还没有将 Firebase 添加到您的项目中([机器人](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) 编号 : [iOS系统](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) 编号 : [网页](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)) (中文(简体) ).

### 机器人

#### 禁用分析数据收集

见 [禁用分析数据收集](https://firebase.google.com/docs/analytics/configure-data-collection?platform=android#disable_data_collection) 如果您想要禁用分析数据收集.

#### 禁用广告ID收藏

见 [禁用广告ID收藏](https://firebase.google.com/docs/analytics/configure-data-collection?platform=android#disable_advertising_id_collection) 如果您想要禁用广告ID收藏.

#### 变量

如果需要, 您可以在您的应用程序中定义以下工程变量 `variables.gradle` 要更改依赖的默认版本的文件 :

-   `$firebaseAnalyticsVersion` 版本 `com.google.firebase:firebase-analytics` (默认 : `23.0.0`(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

### iOS系统

#### Swift 软件包管理器

在您的 `capacitor.config.json` (或 `capacitor.config.ts`) 避免 [SwiftPM 软件包识别相撞](https://github.com/capawesome-team/capacitor-firebase/issues/959)数字 :

```json
{
  "experimental": {
    "ios": {
      "spm": {
        "packageOptions": {
          "@capacitor-firebase/analytics": {
            "symlink": true
          }
        }
      }
    }
  }
}
```

**请注意**目标 `packageOptions` 支持需要控制器 CLI **8.4.0+ (中文(简体) )**。 。 。 .

使用时 **可可罂粟** 对于您的 iOS 项目, 您需要添加 `CapacitorFirebaseAnalytics/Analytics` 锁定到您的 `Podfile` (通常情况) `ios/App/Podfile`:

```diff
target 'App' do
capacitor_pods
# Add your Pods here
+  pod 'CapacitorFirebaseAnalytics/Analytics', :path => '../../node_modules/@capacitor-firebase/analytics'
end
```

**请注意**: 不要在区域中添加吊舱 `def capacitor_pods`,但在评论中 `# Add your Pods here` (单位:千美元)[实例](https://github.com/robingenz/capacitor-firebase-plugin-demo/blob/e1684a0af6871442ed0a87dceeeba6fd9ce0185d/ios/App/Podfile#L30)) (中文(简体) ).

#### 禁用分析数据收集

见 [禁用分析数据收集](https://firebase.google.com/docs/analytics/configure-data-collection?platform=ios#disable_data_collection) 如果您想要禁用分析数据收集.

#### 禁用 IDFA 收藏

使用时 **可可罂粟** 您想要禁用 IDFA 收藏的 iOS 项目, 您可以使用 `CapacitorFirebaseAnalytics/AnalyticsWithoutAdIdSupport` 替换为 `CapacitorFirebaseAnalytics/Analytics` 舱位 :

```diff
target 'App' do
capacitor_pods
# Add your Pods here
-  pod 'CapacitorFirebaseAnalytics/Analytics', :path => '../../node_modules/@capacitor-firebase/analytics'
+  pod 'CapacitorFirebaseAnalytics/AnalyticsWithoutAdIdSupport', :path => '../../node_modules/@capacitor-firebase/analytics'
end
```

使用时 **Swift 软件包管理器** 您想要禁用 IDFA 收藏, 您可以启用 `AnalyticsWithoutAdIdSupport` 你的特质 `capacitor.config.json` (或 `capacitor.config.ts`:

```json
{
  "experimental": {
    "ios": {
      "spm": {
        "swiftToolsVersion": "6.1",
        "packageTraits": {
          "@capacitor-firebase/analytics": ["AnalyticsWithoutAdIdSupport"]
        }
      }
    }
  }
}
```

**说明**: SPM 特性支持需要Capacitor CLI **8.3.0+ (中文(简体) )** 和 X 代码 **16.3+ (简体中文)** (Swift 6.1+) (英语).

## 配置

此插件不需要配置 .

## 演示

这里有一个实例: [robingenz/电容器-火力基地-插座-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)

## 使用量

以下例子显示如何记录事件,跟踪屏幕,识别用户,管理数据收集,配置会话超时,并启动在设备上转换测量.

### 日志事件

登录带有名称和可选参数的应用程序事件 :

```typescript
import { FirebaseAnalytics } from '@capacitor-firebase/analytics';

const logEvent = async () => {
  await FirebaseAnalytics.logEvent({
    name: 'sign_up',
    params: { method: 'password' },
  });
};
```

### 音轨屏幕

设定当前屏幕名称以记录屏幕用户访问的屏幕 。 这个 `screenClassOverride` 选项仅可在Android和iOS上使用:

```typescript
import { FirebaseAnalytics } from '@capacitor-firebase/analytics';

const setCurrentScreen = async () => {
  await FirebaseAnalytics.setCurrentScreen({
    screenName: 'Login',
    screenClassOverride: 'LoginPage',
  });
};
```

### 识别用户

设定用户ID属性和自定义用户属性以分割您的用户 :

```typescript
import { FirebaseAnalytics } from '@capacitor-firebase/analytics';

const setUserId = async () => {
  await FirebaseAnalytics.setUserId({
    userId: '123',
  });
};

const setUserProperty = async () => {
  await FirebaseAnalytics.setUserProperty({
    key: 'language',
    value: 'en',
  });
};
```

### 管理数据收集

启用或禁用自动数据收集( 值在应用程序的下个运行之前不会应用) , 检查是否启用( 仅在 Web 上可用) , 或清除设备中的所有分析数据( 仅在 Android 和 iOS 上可用) :

```typescript
import { FirebaseAnalytics } from '@capacitor-firebase/analytics';

const setEnabled = async () => {
  await FirebaseAnalytics.setEnabled({
    enabled: true,
  });
};

const isEnabled = async () => {
  const { enabled } = await FirebaseAnalytics.isEnabled();
  return enabled;
};

const resetAnalyticsData = async () => {
  await FirebaseAnalytics.resetAnalyticsData();
};
```

### 配置会话超时

设定终止当前会话的不活动持续时间 。 仅在Android和iOS上提供:

```typescript
import { FirebaseAnalytics } from '@capacitor-firebase/analytics';

const setSessionTimeoutDuration = async () => {
  await FirebaseAnalytics.setSessionTimeoutDuration({
    duration: '120',
  });
};
```

### 启动设备转换测量

以平面或散列的电子邮件地址或电话号码启动设备转换测量。 仅在iOS上可用 :

```typescript
import { FirebaseAnalytics } from '@capacitor-firebase/analytics';

const initiateOnDeviceConversionMeasurementWithEmailAddress = async () => {
  await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({
    emailAddress: 'mail@example.com',
  });
};

const initiateOnDeviceConversionMeasurementWithPhoneNumber = async () => {
  await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({
    phoneNumber: '+49123456789',
  });
};

const initiateOnDeviceConversionMeasurementWithHashedEmailAddress = async () => {
  await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({
    emailAddressToHash: 'mail@example.com',
  });
};

const initiateOnDeviceConversionMeasurementWithHashedPhoneNumber = async () => {
  await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber({
    phoneNumberToHash: '+49123456789',
  });
};
```

## API 密码

-   [`getAppInstanceId()`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-getappinstanceid)
-   [`setConsent(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setconsent)
-   [`setUserId(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setuserid)
-   [`setUserProperty(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setuserproperty)
-   [`setCurrentScreen(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setcurrentscreen)
-   [`logEvent(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-logevent)
-   [`setSessionTimeoutDuration(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setsessiontimeoutduration)
-   [`setEnabled(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setenabled)
-   [`isEnabled()`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-isenabled)
-   [`resetAnalyticsData()`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-resetanalyticsdata)
-   [`logTransaction(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-logtransaction)
-   [`initiateOnDeviceConversionMeasurementWithEmailAddress(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithemailaddress)
-   [`initiateOnDeviceConversionMeasurementWithPhoneNumber(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithphonenumber)
-   [`initiateOnDeviceConversionMeasurementWithHashedEmailAddress(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithhashedemailaddress)
-   [`initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(...)`](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithhashedphonenumber)
-   [接口](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-interfaces)
-   [数字](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-enums)

### 获取 AppInstanceId ()

```typescript
getAppInstanceId() => Promise<GetAppInstanceIdResult>
```

获取应用实例 ID .

仅供Android和iOS使用.

**回返情况:** `Promise<[GetAppInstanceIdResult](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-getappinstanceidresult)>`

**自:** 1.4.0 (中文(简体) )

* * *

### 约定(...)

```typescript
setConsent(options: SetConsentOptions) => Promise<void>
```

设置用户的同意模式.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetConsentOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setconsentoptions)` |

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

* * *

### set 用户(...)

```typescript
setUserId(options: SetUserIdOptions) => Promise<void>
```

设置用户标识属性.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetUserIdOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setuseridoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 用户 Property (...)

```typescript
setUserProperty(options: SetUserPropertyOptions) => Promise<void>
```

设置自定义用户属性为给定值.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetUserPropertyOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setuserpropertyoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 设置当前Screen(...)

```typescript
setCurrentScreen(options: SetCurrentScreenOptions) => Promise<void>
```

设置当前屏幕名称.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetCurrentScreenOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setcurrentscreenoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 日志事件(...)

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

记录一个应用事件.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[LogEventOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-logeventoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 设定会议时间间隔(...)

```typescript
setSessionTimeoutDuration(options: SetSessionTimeoutDurationOptions) => Promise<void>
```

设定结束当前会话的不活动持续时间 .

仅供Android和iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetSessionTimeoutDurationOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setsessiontimeoutdurationoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 设置可启用(...)

```typescript
setEnabled(options: SetEnabledOptions) => Promise<void>
```

启用/ 无法自动收集数据 . 该值在应用程序的下一轮运行之前不应用 .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SetEnabledOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-setenabledoptions)` |

**自:** 0.1.0 (中文(简体) )

* * *

### 已启用

```typescript
isEnabled() => Promise<IsEnabledResult>
```

返回是否启用自动数据收集.

仅供Web使用.

**回返情况:** `Promise<[IsEnabledResult](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-isenabledresult)>`

**自:** 0.1.0 (中文(简体) )

* * *

### 重置分析数据Data ()

```typescript
resetAnalyticsData() => Promise<void>
```

从设备中清除此应用程序的所有分析数据 . 恢复应用程序实例 ID .

仅供Android和iOS使用.

**自:** 0.1.0 (中文(简体) )

* * *

### 日志交易(...)

```typescript
logTransaction(options: LogTransactionOptions) => Promise<void>
```

记录 a StoreKit 2 交易.

仅供iOS(1.5.0+)使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[LogTransactionOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-logtransactionoptions)` |

**自:** 8.2.0 (中文(简体) )

* * *

### 启动 EmailAddress (...)

```typescript
initiateOnDeviceConversionMeasurementWithEmailAddress(options: InitiateOnDeviceConversionMeasurementWithEmailAddressOptions) => Promise<void>
```

用电子邮件地址启动设备转换测量 .

仅供iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[InitiateOnDeviceConversionMeasurementWithEmailAddressOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithemailaddressoptions)` |

**自:** 7.2.0 联合国

* * *

### 启动 OnDevice 转换计量与Phone 数字(...)

```typescript
initiateOnDeviceConversionMeasurementWithPhoneNumber(options: InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions) => Promise<void>
```

用电话号码启动设备转换测量.

仅供iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithphonenumberoptions)` |

**自:** 7.2.0 联合国

* * *

### 启动 On Device Conversion Measurement with Hashed 电子邮件地址(...)

```typescript
initiateOnDeviceConversionMeasurementWithHashedEmailAddress(options: InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions) => Promise<void>
```

用一个散列的电子邮件地址启动设备转换测量 .

仅供iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithhashedemailaddressoptions)` |

**自:** 7.2.0 联合国

* * *

### 启动使用HashedPhone Number (.) 进行的Device转换计量

```typescript
initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(options: InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions) => Promise<void>
```

用散列电话号码启动设备转换测量.

仅供iOS使用.

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-initiateondeviceconversionmeasurementwithhashedphonenumberoptions)` |

**自:** 7.2.0 联合国

* * *

### 接口

#### 获取AppInstanceId 结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`appInstanceId`** | `string` | 应用实例 ID。 未定义如果 `FirebaseAnalytics.<a href="#consenttype">ConsentType</a>.ANALYTICS_STORAGE` 已设定为 `FirebaseAnalytics.<a href="#consentstatus">ConsentStatus</a>.DENIED`。 。 。 . | 1.4.0 (中文(简体) ) |

#### 设定同意选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`type`** | `[ConsentType](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-consenttype)` | 同意类型. | 6.0.0 (单位:千美元) |
| **`status`** | `[ConsentStatus](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-consentstatus)` | 同意地位. | 6.0.0 (单位:千美元) |

#### 设置用户选择

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`userId`** | `string | null` | 0.1.0 (中文(简体) ) |

#### 配置用户

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`key`** | `string` | 0.1.0 (中文(简体) ) |
| **`value`** | `string | null` | 0.1.0 (中文(简体) ) |

#### 设置当前选择

| Prop | 类型 | 说明 | 默认 | 自兹 |
| --- | --- | --- | --- | --- |
| **`screenName`** | `string | null` |  |  | 0.1.0 (中文(简体) ) |
| **`screenClassOverride`** | `string | null` | 仅供Android和iOS使用. | `null` | 0.1.0 (中文(简体) ) |

#### 日志结果选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`name`** | `string` | 事件名称. | 0.1.0 (中文(简体) ) |
| **`params`** | `{ [key: string]: any; }` | 可选事件参数. | 0.1.0 (中文(简体) ) |

#### 设定会议时间安排选项

| Prop | 类型 | 说明 | 默认 | 自兹 |
| --- | --- | --- | --- | --- |
| **`duration`** | `number` | 持续数秒. | `1800` | 0.1.0 (中文(简体) ) |

#### 设置可选选项

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`enabled`** | `boolean` | 0.1.0 (中文(简体) ) |

#### 已启用结果

| Prop | 类型 | 自兹 |
| --- | --- | --- |
| **`enabled`** | `boolean` | 0.1.0 (中文(简体) ) |

#### 日志交易选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`transactionId`** | `string` | 仓库 Kit 2 `Transaction.id` 值作为数字字符串. | 8.2.0 (中文(简体) ) |

#### 通过电子邮件地址管理选项启动设备转换计量

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`emailAddress`** | `string` | 启动设备转换测量的电子邮件地址 . | 7.2.0 联合国 |

#### 启动使用 Phone 数字选项的设备转换计量

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`phoneNumber`** | `string` | 启动设备转换测量的电话号码 . | 7.2.0 联合国 |

#### 启动 HashedEmail 地址管理选项

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`emailAddressToHash`** | `string` | 启动设备转换测量的电子邮件地址 . | 7.2.0 联合国 |

#### 启动使用 HashedPhone 选项的服务器转换计量

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`phoneNumberToHash`** | `string` | 启动设备转换测量的电话号码 . | 7.2.0 联合国 |

### 数字

#### 同意类型

| 成员 | 数值 | 自兹 |
| --- | --- | --- |
| **`AdPersonalization`** | `'AD_PERSONALIZATION'` | 6.0.0 (单位:千美元) |
| **`AdStorage`** | `'AD_STORAGE'` | 6.0.0 (单位:千美元) |
| **`AdUserData`** | `'AD_USER_DATA'` | 6.0.0 (单位:千美元) |
| **`AnalyticsStorage`** | `'ANALYTICS_STORAGE'` | 6.0.0 (单位:千美元) |
| **`FunctionalityStorage`** | `'FUNCTIONALITY_STORAGE'` | 6.0.0 (单位:千美元) |
| **`PersonalizationStorage`** | `'PERSONALIZATION_STORAGE'` | 6.0.0 (单位:千美元) |

#### 状况

| 成员 | 数值 | 自兹 |
| --- | --- | --- |
| **`Granted`** | `'GRANTED'` | 6.0.0 (单位:千美元) |
| **`Denied`** | `'DENIED'` | 6.0.0 (单位:千美元) |

## 测试您的执行

[给](https://firebase.google.com/docs/analytics/debugview) 您可找到更多信息,说明如何使用 **调试视图**。 。 。 .

## 财务问题

### 我如何证实我的事件被记录下来?

使用 **调试视图** 在Firebase控制台 检查事件 当它们记录在您的应用程序。 见 [调试维尤文档](https://firebase.google.com/docs/analytics/debugview) 以了解更多关于如何测试您的火库分析实施情况的信息.

### 我如何禁用分析数据收集?

您可以在运行时启用或禁用自动数据收集 `setEnabled(...)` 方法; 注意该值在应用程序的下一次运行之前不适用。 要默认禁用数据收集, 请遵循连接在 [安装](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-installation) 用于Android和iOS的章节.

### 我如何设定用户的同意模式 ?

打电话 `setConsent(...)` (a) 同意类型(例如分析存储或广告存储)和同意地位(给予或拒绝)。 这使得您可以管理根据用户同意收集的数据.

### 为什么没有定义应用实例 ID ?

这个 `appInstanceId` 返回时间 `getAppInstanceId()` 如果分析存储同意类型被设定为通过 `setConsent(...)`5\. 还注意到 `getAppInstanceId()` 仅在Android和iOS上提供.

### 我如何禁用广告 ID或IDFA收藏?

Android上,跟着 [禁用广告ID收藏](https://firebase.google.com/docs/analytics/configure-data-collection?platform=android#disable_advertising_id_collection) 向导。 在iOS上,请使用 `CapacitorFirebaseAnalytics/AnalyticsWithoutAdIdSupport` 替换为 `CapacitorFirebaseAnalytics/Analytics` 使用可口可乐Pods或启用 `AnalyticsWithoutAdIdSupport` 如果您使用 Swift 软件包管理器, 则包的特性 。 见 [安装](https://npmcn.com/package/%40capacitor-firebase/analytics/#readme-installation) 详细情况.

### 我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

## 相关插件

-   [火基地应用](https://capawesome.io/docs/sdks/capacitor/firebase/app/): 访问Firebase核心应用程序配置.
-   [火灾基地崩溃](https://capawesome.io/docs/sdks/capacitor/firebase/crashlytics/):跟踪并报告应用软件与火地崩溃.
-   [基地性能监测](https://capawesome.io/docs/sdks/capacitor/firebase/performance-monitoring/):用"火地性能监测"测量您的应用的性能.
-   [远程配置](https://capawesome.io/docs/sdks/capacitor/firebase/remote-config/): 在不发布应用程序更新的情况下改变您应用程序的行为和外观.

## 通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 [《卡帕索克通讯》](https://cloud.capawesome.io/newsletter/)。 。 。 .

## 更改日志

见 [变动情况](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/analytics/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/analytics/LICENSE)。 。 。 .

\[^1\]: 这个项目不附属于Google LLC或其任何子公司或子公司,也不获得其认可、支持、赞助或批准.

## 常见问题

### @capacitor-firebase/analytics 是什么？

在Android,iOS,和Web上用于Firebase Analytics的电容插件\.

### 如何安装 @capacitor-firebase/analytics？

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

### @capacitor-firebase/analytics 支持 TypeScript 吗？

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

### @capacitor-firebase/analytics 支持 ESM 还是 CommonJS？

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

### @capacitor-firebase/analytics 可以商用吗？

@capacitor-firebase/analytics 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @capacitor-firebase/analytics 的下载量有多少？

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

### @capacitor-firebase/analytics 还在维护吗？

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