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

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

API 개요

`getAppInstanceId`

앱 인스턴스 아이디를 가져옵니다.

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`

__CAPGO_KEEP_2__

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

await FirebaseAnalytics.setCurrentScreen({} as SetCurrentScreenOptions);

`logEvent`

__CAPGO_KEEP_3__

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

await FirebaseAnalytics.logEvent({} as LogEventOptions);

`setSessionTimeoutDuration`

__CAPGO_KEEP_4__

__CAPGO_KEEP_5__

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`

자동 데이터 수집이 활성화되어 있는지 여부를 반환합니다.

웹에서만 사용 가능합니다.

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

await FirebaseAnalytics.isEnabled();

`resetAnalyticsData`

이 앱의 모든 분석 데이터를 장치에서 삭제하고 앱 인스턴스 ID를 초기화합니다.

안드로이드 및 iOS에서만 사용 가능합니다.

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

await FirebaseAnalytics.resetAnalyticsData();

`initiateOnDeviceConversionMeasurementWithEmailAddress`

이메일 주소와 함께 장치 내 변환 측정치를 시작합니다.

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의 공개 버전이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하기

__CAPGO_KEEP_0__가 업스트림에서 변경될 때 다시 싱크를 실행하세요. Getting Started를 사용 중입니다. 대시보드와 API 운영을 계획하고 연결하세요. API 개요 API Overview의 구현 세부 정보에 대해 소개 소개의 구현 세부 정보에 대해 API 키 API Keys의 구현 세부 정보에 대해 장치 장치의 구현 세부 정보에 대해 번들 번들의 구현 세부 정보에 대해