スタートガイド

インストール

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.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

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

インポート

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

クイックスタート

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

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

例: getSessionId

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,
});

よくある落とし穴

• ネイティブ同期: 実行 npx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

API の概要

getAppInstanceId

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

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

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

Webのみ利用可能です。

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

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

resetAnalyticsData

デバイスからこのアプリのアナリティクスデータをすべて消去します。 アプリのインスタンスIDをリセットします。

Android と iOS でのみ利用できます。

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

電話番号を使用して、デバイス上のコンバージョン測定を開始します。

iOS でのみ利用できます。

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

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

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;
}

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー API Keys の実装の詳細については、 デバイス Devices の実装詳細については、および Bundle Bundlesの実装詳細については