开始

安装

您可以使用我们的 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-firebase-analytics` plugin in my project.

如果您更喜欢手动设置，请按照以下命令安装插件，并遵循以下平台特定的说明：

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

导入

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

API概述

getAppInstanceId

仅适用于Android和iOS。

导入

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

const result = await FirebaseAnalytics.getAppInstanceId();
console.log(result);

getSessionId

获取当前会话ID（ga_session_id).

仅适用于Android和iOS。

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

const result = await FirebaseAnalytics.getSessionId();
console.log(result);

setConsent

设置用户同意模式。

import { FirebaseAnalytics, ConsentStatus, ConsentType } from '@capgo/capacitor-firebase-analytics';

await FirebaseAnalytics.setConsent({
  type: ConsentType.AdPersonalization,
  status: ConsentStatus.Granted,
});

setUserId

设置用户ID属性。

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

await FirebaseAnalytics.setUserId({ userId: 'user-id-123' });

setUserProperty

设置一个自定义用户属性为给定的值。

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

await FirebaseAnalytics.setUserProperty({
  key: 'key-123',
  value: 'value',
});

setCurrentScreen

设置当前屏幕名称。

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

await FirebaseAnalytics.setCurrentScreen({ screenName: 'screen' });

logEvent

记录应用事件。

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

await FirebaseAnalytics.logEvent({ name: 'example' });

setSessionTimeoutDuration

设置当前会话超时持续时间。

仅适用于 Android 和 iOS。

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

await FirebaseAnalytics.setSessionTimeoutDuration({ duration: 1800 });

setEnabled

启用/禁用自动数据收集。 数据值直到下一次应用程序运行才会生效。

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

await FirebaseAnalytics.setEnabled({ enabled: true });

isEnabled

isEnabled

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

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

const result = await FirebaseAnalytics.isEnabled();
console.log(result);

resetAnalyticsData

resetAnalyticsData

清除此应用程序在设备上的所有分析数据。 重置应用程序实例ID。

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

await FirebaseAnalytics.resetAnalyticsData();

initiateOnDeviceConversionMeasurementWithEmailAddress

使用设备端的转换测量，使用电子邮件地址。

仅适用于 iOS。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({ emailAddress: 'user@example.com' });

initiateOnDeviceConversionMeasurementWithPhoneNumber

标题为“initiateOnDeviceConversionMeasurementWithPhoneNumber”

仅适用于 iOS。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({ phoneNumber: '+15555550123' });

initiateOnDeviceConversionMeasurementWithHashedEmailAddress

标题为“initiateOnDeviceConversionMeasurementWithHashedEmailAddress”

仅适用于 iOS。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({ emailAddressToHash: 'user@example.com' });

initiateOnDeviceConversionMeasurementWithHashedPhoneNumber

使用加密电话号码启动设备端转换测量。

仅适用于 iOS。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber({ phoneNumberToHash: '+15555550123' });

类型参考

GetAppInstanceIdResult

export interface GetAppInstanceIdResult {
  /**
   * The app instance id.
   *
   * Not defined if `FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE` has been set to `FirebaseAnalytics.ConsentStatus.DENIED`.
   *
   * @since 1.4.0
   */
  appInstanceId?: string;
}

GetSessionIdResult

export interface GetSessionIdResult {
  /**
   * The current session id.
   *
   * Matches Firebase Analytics `ga_session_id`.
   *
   * Not defined if `FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE` has been set to `FirebaseAnalytics.ConsentStatus.DENIED`.
   *
   * @since 8.0.1
   */
  sessionId?: number;
}

SetConsentOptions

export interface SetConsentOptions {
  /**
   * The consent type.
   *
   * @since 6.0.0
   */
  type: ConsentType;
  /**
   * The consent status.
   *
   * @since 6.0.0
   */
  status: ConsentStatus;
}

SetUserIdOptions

export interface SetUserIdOptions {
  /**
   * @since 0.1.0
   */
  userId: string | null;
}

SetUserPropertyOptions

export interface SetUserPropertyOptions {
  /**
   * @since 0.1.0
   */
  key: string;
  /**
   * @since 0.1.0
   */
  value: string | null;
}

SetCurrentScreenOptions

export interface SetCurrentScreenOptions {
  /**
   * @since 0.1.0
   */
  screenName: string | null;
  /**
   * Only available for Android and iOS.
   *
   * @default null
   * @since 0.1.0
   */
  screenClassOverride?: string | null;
}

LogEventOptions

export interface LogEventOptions {
  /**
   * The event name.
   *
   * @since 0.1.0
   */
  name: string;
  /**
   * The optional event params.
   *
   * @since 0.1.0
   */
  params?: { [key: string]: any };
}

SetSessionTimeoutDurationOptions

export interface SetSessionTimeoutDurationOptions {
  /**
   * Duration in seconds.
   *
   * @default 1800
   * @since 0.1.0
   */
  duration: number;
}

SetEnabledOptions

export interface SetEnabledOptions {
  /**
   * @since 0.1.0
   */
  enabled: boolean;
}

IsEnabledResult

export interface IsEnabledResult {
  /**
   * @since 0.1.0
   */
  enabled: boolean;
}

InitiateOnDeviceConversionMeasurementWithEmailAddressOptions

export interface InitiateOnDeviceConversionMeasurementWithEmailAddressOptions {
  /**
   * The email address to initiate on-device conversion measurement with.
   *
   * @since 7.2.0
   */
  emailAddress: string;
}

InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions

export interface InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions {
  /**
   * The phone number to initiate on-device conversion measurement with.
   *
   * @since 7.2.0
   */
  phoneNumber: string;
}

真实来源

此页面由插件生成 src/definitions.ts. 当公共API上游更改时，请重新同步。

继续从开始

如果您正在使用 开始使用 为计划仪表板和API操作，连接它 API概述 了解API概述的实现细节 简介 了解简介的实现细节 API密钥 了解API密钥的实现细节 设备 了解设备的实现细节 包 了解包的实现细节