Getting Started

설치

Capgo의 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-rudderstack` plugin in my project.

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:

bun add @capgo/capacitor-rudderstack
bunx cap sync

설치

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

API 개요

initialize

RudderStack 클라이언트를 초기화합니다.

메서드는 Cordova 서명이 유지되므로 두 번째 인자는 config 객체 또는 Rudder 옵션 객체 둘 중 하나여야 합니다.

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

await nativePlugin.initialize('value');

identify

사용자 ID를 제공하여 identify 호출을 보냅니다.

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

await nativePlugin.identify('value');

group

지정된 그룹 ID를 제공하여 그룹 호출을 보냅니다.

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

await nativePlugin.group('value');

track

지정된 이벤트 이름을 제공하여 트랙 호출을 보냅니다.

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 identity 상태를 초기화합니다.

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

await nativePlugin.reset();

flush

즉시 큐에 쌓인 이벤트를 모두 삭제합니다.

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

await nativePlugin.flush();

putDeviceToken

RudderStack가 지원하는 목적지로 푸시 토큰을 전달합니다.

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

await nativePlugin.putDeviceToken('value');

setAdvertisingId

현재 계약의 소스 정의를 참조하세요.

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

await nativePlugin.setAdvertisingId('value');

putAdvertisingId

광고 ID를 사용자 지정 값으로 설정합니다.

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

await nativePlugin.putAdvertisingId('value');

setAnonymousId

현재 계약의 소스 정의를 참조하세요.

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

await nativePlugin.setAnonymousId('value');

putAnonymousId

익명 ID를 사용자 지정 값으로 설정합니다.

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

await nativePlugin.putAnonymousId('value');

optOut

루더 스택 추적을 차단/허용합니다.

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

await nativePlugin.optOut(true);

타입 참조

RudderConfiguration

루더 스택 내장 네이티브 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

루더 스택 호출당 옵션.

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 그리고 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

로그 수준을 위한 데이터

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

실제 데이터

이 페이지는 플러그인의 src/definitions.ts. 다시 싱크를 실행할 때 공개 API upstream에서 변경되면.

Getting Started에서 계속하기

이 플러그인을 사용하는 경우 Getting Started 계획 대시보드 및 API 작업을 위해 Using @capgo/capacitor-rudderstack Using @capgo/capacitor-rudderstack for the native capability in Using @API/__CAPGO_KEEP_1__-rudderstack for the implementation detail in API Overview Introduction Capgo 구현 세부 정보에 대한 설명 API 키 for the implementation detail in API Keys, and 장치 Capgo 구현 세부 정보에 대한 설명