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.

インストール

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

インポート

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

API Overview

`getAppInstanceId`

__CAPGO_KEEP_0__を取得します。

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`

__CAPGO_KEEP_0__を設定します。

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`

Webのみ

クリップボードにコピー

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

await FirebaseAnalytics.isEnabled();

`resetAnalyticsData`

__CAPGO_KEEP_0__を削除し、デバイスからこのアプリの分析データをすべて消去します。アプリのインスタンスIDをリセットします。

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

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

await FirebaseAnalytics.resetAnalyticsData();

`initiateOnDeviceConversionMeasurementWithEmailAddress`

このメールアドレスでデバイス上の変換測定を開始します。

__CAPGO_KEEP_1__のみiOSで利用可能です。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({} as InitiateOnDeviceConversionMeasurementWithEmailAddressOptions);

`initiateOnDeviceConversionMeasurementWithPhoneNumber`

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

__CAPGO_KEEP_1__のみiOSで利用可能です。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions);

`initiateOnDeviceConversionMeasurementWithHashedEmailAddress`

__CAPGO_KEEP_0__をハッシュ化したメールアドレスでオンデバイス変換測定を開始します。

__CAPGO_KEEP_0__はiOSのみで利用可能です。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({} as InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions);

`initiateOnDeviceConversionMeasurementWithHashedPhoneNumber`

__CAPGO_KEEP_0__をハッシュ化した電話番号でオンデバイス変換測定を開始します。

__CAPGO_KEEP_0__はiOSのみで利用可能です。

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

await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber({} as InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions);

Type Reference

`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. upstream の API が変更されたときに再度 Sync を実行してください。

Getting Started から続けてください。

あなたが「Getting Started」を使用している場合 Getting Started を使用してダッシュボードと __CAPGO_KEEP_0__ の操作を計画する場合、 API Overview API Overview の実装詳細については、 for the implementation detail in API Overview, Introduction の実装詳細については、 __CAPGO_KEEP_0__ Keys API Keys の実装詳細については、 for the implementation detail in API Keys, デバイスデバイスの実装詳細については、バンドルバンドルの実装詳細については、