Getting Started

설치

bun add @capgo/capacitor-rudderstack
bunx cap sync

import

import { nativePlugin } from '@capgo/capacitor-rudderstack';

API 개요

initialize

Initializes the RudderStack client.

The method keeps the Cordova signature, so the second argument may be either a config object or a Rudder options object.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.initialize('value');

identify

Sends an identify call for the provided user id.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.identify('value');

group

Sends a group call for the provided group id.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.group('value');

track

Sends a track call for the provided event name.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.track('value');

screen

스크린 이름을 제공하여 스크린 콜을 보냅니다.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.screen('value');

alias

현재 사용자를 새로운 식별자로.alias합니다.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.alias('value');

reset

현재 RudderStack 식별자 상태를 초기화합니다.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.reset();

flush

임시 저장된 이벤트를 즉시 플러시합니다.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.flush();

putDeviceToken

__CAPGO_KEEP_1__

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.putDeviceToken('value');

setAdvertisingId

__CAPGO_KEEP_4__

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.setAdvertisingId('value');

putAdvertisingId

__CAPGO_KEEP_7__

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.putAdvertisingId('value');

setAnonymousId

__CAPGO_KEEP_10__

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.setAnonymousId('value');

putAnonymousId

개인 식별자 값을 설정합니다.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.putAnonymousId('value');

optOut

RudderStack 추적을 비활성화합니다.

import { nativePlugin } from '@capgo/capacitor-rudderstack';

await nativePlugin.optOut(true);

Type Reference

RudderConfiguration

RudderStack 네이티브 SDK의 지원되는 구성 키입니다.

export interface RudderConfiguration {
  /**
   * RudderStack data plane URL.
   */
  dataPlaneUrl?: string;

  /**
   * Number of events to batch before a flush.
   */
  flushQueueSize?: number;

  /**
   * Database row threshold that triggers pruning on Android and iOS.
   */
  dbCountThreshold?: number;

  /**
   * Server config refresh interval in hours.
   */
  configRefreshInterval?: number;

  /**
   * RudderStack log verbosity.
   */
  logLevel?: RudderLogLevelValue;

  /**
   * Sleep timeout / sleep count used by the native SDK.
   */
  sleepTimeOut?: number;

  /**
   * Android only. Lets the native SDK collect the advertising identifier automatically.
   */
  autoCollectAdvertId?: boolean;

  /**
   * Tracks `Application Installed`, `Application Updated`, and `Application Opened` automatically.
   */
  trackLifecycleEvents?: boolean;

  /**
   * RudderStack control plane URL.
   */
  controlPlaneUrl?: string;

  /**
   * Enables automatic screen tracking where supported by the native SDK.
   */
  recordScreenViews?: boolean;

  /**
   * Ignored in this Capacitor port.
   *
   * The Cordova SDK uses this field to bootstrap native destination factories from companion plugins.
   * Those extension packages are not implemented in this first Capacitor release.
   */
  factories?: any[];
}

RudderOptions

RudderStack per-call 옵션.

export interface RudderOptions {
  /**
   * External identifiers forwarded with the event.
   */
  externalIds?: Record<string, string>;

  /**
   * Destination enablement flags keyed by integration name.
   */
  integrations?: Record<string, boolean>;
}

RudderTraits

속성 identify Traits payload accepted by group.

export type RudderTraits = Record<string, any>;

RudderProperties

RudderProperties track 속성 screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

복사

export interface PluginVersionResult {
  /**
   * Version identifier returned by the platform implementation.
   */
  version: string;
}

RudderLogLevelValue

이동 편의를 위해 제공되는 RudderStack 로그 수준 값.

export type RudderLogLevelValue = 0 | 1 | 2 | 3 | 4 | 5;

진실의 원천

이 플러그인의 src/definitions.ts. upstream에서 API이 변경될 때마다 다시 동기화 하세요.

Getting Started에서 계속하기

Capgo CLI를 사용하는 경우 Getting Started API 대시보드와 운영을 계획하고 연결하기 위해 Using @capgo/capacitor-rudderstack capgo의 원시 기능을 사용하는 경우 Using @capgo/capacitor-rudderstack API 개요 API의 구현 세부 사항에 대해 __CAPGO_KEEP_0__ 소개 __CAPGO_KEEP_0__의 구현 세부 사항에 대해 API 키 API의 구현 세부 사항에 대해 및 __CAPGO_KEEP_0__ 장치 __CAPGO_KEEP_0__의 구현 세부 사항에 대해