始めから始める

このプラグインのインストールステップとフルマークダウンガイドまでのすべてのステップを含むセットアッププロンプトをコピーしてください。

        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.

インストール

AI-Assisted Setupを使用してプラグインをインストールできます。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

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

API オーバービュー

`getAppInstanceId`

アプリケーションインスタンスIDを取得します。

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

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

await FirebaseAnalytics.getAppInstanceId();

`getSessionId`

現在のセッションIDを取得します（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`

setCurrentScreen

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

await FirebaseAnalytics.setCurrentScreen({} as SetCurrentScreenOptions);

`logEvent`

logEvent

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

await FirebaseAnalytics.logEvent({} as LogEventOptions);

`setSessionTimeoutDuration`

setSessionTimeoutDuration

__CAPGO_KEEP_0__

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`

自動データ収集が有効かどうかを返します。

Webのみで利用可能です。

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

await FirebaseAnalytics.isEnabled();

`resetAnalyticsData`

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

「initiateOnDeviceConversionMeasurementWithEmailAddress」セクション

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

await FirebaseAnalytics.resetAnalyticsData();

`initiateOnDeviceConversionMeasurementWithEmailAddress`

Section titled “isEnabled”

iOSのみで利用可能です。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({} as InitiateOnDeviceConversionMeasurementWithEmailAddressOptions);

`initiateOnDeviceConversionMeasurementWithPhoneNumber`

電話番号を使用してデバイス上の変換測定を開始します。

iOSのみで利用可能です。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions);

`initiateOnDeviceConversionMeasurementWithHashedEmailAddress`

ハッシュ化されたメールアドレスを使用してデバイス上の変換測定を開始します。

iOSのみで利用可能です。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({} as InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions);

`initiateOnDeviceConversionMeasurementWithHashedPhoneNumber`

ハッシュ化された電話番号を使用してデバイス上の変換測定を開始します。

iOSのみで利用可能です。

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.tsAPIのパブリックがアップストリームで変更されたら、再度Syncを実行してください。

Getting Startedから続けて

Capgoを使用している場合 Getting Started ダッシュボードとAPIの運用計画を行うには、 APIの概要 APIの概要の実装詳細については導入導入の実装詳細については APIのキー APIのキーについての実装詳細デバイスデバイスの実装詳細バンドルバンドルの実装詳細