Getting Started

このプラグインのインストール手順と全マークダウンガイドを含む設定の質問をコピーします。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-firebase-analytics`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/firebase-analytics/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

Capgo の AI 助成インストール機能を使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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.

Manual Setup を使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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

インポート

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

API オーバービュー

`getAppInstanceId`

アプリインスタンスIDを取得します。

AndroidおよびiOSのみで利用可能です。

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

await FirebaseAnalytics.getAppInstanceId();

`getSessionId`

__CAPGO_KEEP_0__を取得します（ga_session_id).

AndroidおよびiOSのみで利用可能です。

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

await FirebaseAnalytics.getSessionId();

`setConsent`

ユーザーの同意モードを設定します。

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

await FirebaseAnalytics.setConsent({} as SetConsentOptions);

`setUserId`

ユーザーIDプロパティを設定します。

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

await FirebaseAnalytics.setUserId({} as SetUserIdOptions);

`setUserProperty`

カスタムユーザープロパティを指定された値に設定します。

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

await FirebaseAnalytics.setUserProperty({} as SetUserPropertyOptions);

`setCurrentScreen`

現在の画面名を設定します。

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

await FirebaseAnalytics.setCurrentScreen({} as SetCurrentScreenOptions);

`logEvent`

アプリのイベントをログします。

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

await FirebaseAnalytics.logEvent({} as LogEventOptions);

`setSessionTimeoutDuration`

現在のセッションを終了する不活性時間を設定します。

AndroidとiOSのみで利用可能です。

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

await FirebaseAnalytics.setSessionTimeoutDuration({} as SetSessionTimeoutDurationOptions);

`setEnabled`

自動データ収集を有効/無効にします。値は、次回のアプリ起動まで適用されません。

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

await FirebaseAnalytics.setEnabled({} as SetEnabledOptions);

`isEnabled`

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__

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

await FirebaseAnalytics.isEnabled();

`resetAnalyticsData`

__CAPGO_KEEP_5__

__CAPGO_KEEP_6__

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

await FirebaseAnalytics.resetAnalyticsData();

`initiateOnDeviceConversionMeasurementWithEmailAddress`

__CAPGO_KEEP_9__

__CAPGO_KEEP_10__

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({} as InitiateOnDeviceConversionMeasurementWithEmailAddressOptions);

`initiateOnDeviceConversionMeasurementWithPhoneNumber`

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions);

`initiateOnDeviceConversionMeasurementWithHashedEmailAddress`

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({} as InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions);

`initiateOnDeviceConversionMeasurementWithHashedPhoneNumber`

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions);

型式参照

`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 を同步してください。

Getting Startedから続けてください

Capgoを使用している場合 Getting Started ダッシュボードとAPIの計画と操作を行う場合、Capgoを接続してください。 API オーバービュー API オーバービューの実装詳細についてイントロダクションイントロダクションの実装詳細について API キー API キーの実装詳細についてデバイスデバイスの実装詳細について、バンドルバンドルの実装詳細について。