Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo Skills zu Ihrem AI-Tool hinzu, indem Sie folgenden Befehl verwenden:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Dann verwenden Sie die folgende Anfrage:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-rudderstack` plugin in my project.

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen Plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-rudderstack
bunx cap sync

Importieren

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

API Übersicht

initialize

Initialisiert den RudderStack-Klienten.

Die Methode hält die Cordova-Signatur, daher kann der zweite Parameter entweder ein Konfigurationsobjekt oder ein Rudder-Options-Objekt sein.

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

await nativePlugin.initialize('write-key-123');

identify

Sendet einen Identify-Aufruf für die bereitgestellte Benutzer-ID.

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

await nativePlugin.identify('user-id-123');

group

Sendet einen Gruppenaufruf für die bereitgestellte Gruppen-ID.

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

await nativePlugin.group('group-id-123');

track

Sendet einen Track-Aufruf für den bereitgestellten Ereignisnamen.

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

await nativePlugin.track('event');

screen

Sendet einen Bildschirm-Aufruf für den bereitgestellten Bildschirmnamen.

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

await nativePlugin.screen('screen');

alias

Der aktuelle Benutzer wird einem neuen Identifikator zugeordnet.

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

await nativePlugin.alias('new-id-123');

reset

Der aktuelle RudderStack-Identitätszustand wird zurückgesetzt.

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

await nativePlugin.reset();

flush

Gepackte Ereignisse werden sofort abgeflossen.

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

await nativePlugin.flush();

putDeviceToken

Der Push-Token wird gesetzt, der von RudderStack an unterstützte Ziele weitergeleitet wird.

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

await nativePlugin.putDeviceToken('device-token-123');

setAdvertisingId

Siehe die Quellendefinitionen für den aktuellen Vertrag.

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

await nativePlugin.setAdvertisingId('advertising-id-123');

putAdvertisingId

Setzt einen benutzerdefinierten Werbe-Id-Wert.

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

await nativePlugin.putAdvertisingId('advertising-id-123');

setAnonymousId

Siehe die Quellendefinitionen für den aktuellen Vertrag.

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

await nativePlugin.setAnonymousId('anonymous-id-123');

putAnonymousId

Setzt einen benutzerdefinierten anonymen Id-Wert.

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

await nativePlugin.putAnonymousId('anonymous-id-123');

optOut

Aktiviert/Deaktiviert RudderStack-Tracking.

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

await nativePlugin.optOut(true);

Typenreferenz

RudderConfiguration

Unterstützte Konfigurations Schlüssel für die zugrunde liegenden RudderStack-Native-SDKs.

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-Aufrufoptionen.

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

RudderTraits-Payload, die akzeptiert wird identify und group.

export type RudderTraits = Record<string, any>;

RudderProperties

RudderProperties-Payload, die akzeptiert wird track und screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

Plugin-Version-Payload

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

RudderLogLevelValue

RudderStack Log-Einstellungen zur Migrationserleichterung.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.ts. Re-run the sync when the public API changes upstream.

Weiter von Getting Started

Wenn Sie das verwenden Getting Started um das Dashboard und API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-rudderstack für die native Fähigkeit in @capgo/capacitor-rudderstack, API Übersicht für die Implementierungsdetail in API Übersicht, Einführung für die Implementierungsdetail in Einführung, API Schlüssel für die Implementierungsdetail in API Schlüssel, und Geräte für die Implementierungsdetail in Geräte.