Anfang an

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um den Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie die folgende Befehl ausführen:

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

Dann verwenden Sie den folgenden Befehl:

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

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

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-Optionen-Objekt sein.

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

await nativePlugin.initialize('value');

identify

Eine Identifizierungsanforderung für den bereitgestellten Benutzer-ID sendet.

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

await nativePlugin.identify('value');

group

Sendet eine Gruppenanruf für die bereitgestellte Gruppen-ID.

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

await nativePlugin.group('value');

track

Sendet einen Verfolgungsanruf für den bereitgestellten Ereignisnamen.

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

await nativePlugin.track('value');

screen

Sendet einen Bildschirmanruf für den bereitgestellten Bildschirmnamen.

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

await nativePlugin.screen('value');

alias

Setzt den aktuellen Benutzer auf einen neuen Identifikator um.

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

await nativePlugin.alias('value');

reset

Setzt den aktuellen RudderStack-Identitätszustand zurück.

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

await nativePlugin.reset();

flush

Queued Events sofort leert.

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

await nativePlugin.flush();

putDeviceToken

Setzt das Push-Token, das RudderStack an unterstützte Ziele weiterleitet.

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

await nativePlugin.putDeviceToken('value');

setAdvertisingId

Siehe die Quelldefinitionen für den aktuellen Vertrag.

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

await nativePlugin.setAdvertisingId('value');

putAdvertisingId

Setzt einen benutzerdefinierten Werbe-ID-Wert.

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

await nativePlugin.putAdvertisingId('value');

setAnonymousId

Siehe die Quelldefinitionen für den aktuellen Vertrag.

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

await nativePlugin.setAnonymousId('value');

putAnonymousId

Setzt einen benutzerdefinierten anonymen ID-Wert.

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

await nativePlugin.putAnonymousId('value');

optOut

Schaltet die RudderStack-Tracking-Opt-Out-Funktion ein.

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

await nativePlugin.optOut(true);

Typenreferenz

RudderConfiguration

Unterstützte Konfigurations Schlüssel für die zugrunde liegenden RudderStack-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-Optionen pro Aufruf.

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

Traits-Payload, die von identify und group.

export type RudderTraits = Record<string, any>;

RudderProperties

Eigenschaften-Payload, die von 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

Werte für die Protokollierungsstufe von RudderStack zur Migrationserleichterung

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

Hauptquelle

Diese Seite wird aus dem Plugin generiert. src/definitions.tsLäuft die Synchronisation neu, wenn sich die öffentliche API upstream ändert.

Weitergehen von Getting Started

Wenn Sie "Getting Started" verwenden, um das Dashboard und die __CAPGO_KEEP_0__-Operationen zu planen, verbinden Sie es mit Getting Started Verwenden Sie @API/__CAPGO_KEEP_1__-rudderstack für die native Fähigkeit in Verwenden Sie @capgo/capacitor-rudderstack for the native capability in Using @capgo/capacitor-rudderstack, für die Implementierungsdetails in API Übersicht for the implementation detail in API Overview, Einführung zur Implementierungsdetail in Einführung API Schlüssel zur Implementierungsdetail in API Schlüssel, und Geräte zur Implementierungsdetail in Geräte.