Getting Started

Installieren

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

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

Verwenden Sie dann 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 die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die Plattform-spezifischen Anweisungen unten 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-Optionen-Objekt sein.

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

await nativePlugin.initialize('value');

identify

Sendet einen Identifizierungsaufruf für die bereitgestellte Benutzer-ID.

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

Löscht die in der Warteschlange stehenden Ereignisse sofort.

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

await nativePlugin.flush();

putDeviceToken

Setzt den Push-Token, der von RudderStack an unterstützte Ziele weitergeleitet wird.

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 Anonymous-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

RudderStack-Protokoll-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. Wiederholen Sie die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weitergehen von Getting Started

Wenn Sie das verwenden Getting Started um einen Dashboard und API-Plan zu erstellen, verbinden Sie es mit Mit @capgo/capacitor-rudderstack für die native Fähigkeit in Mit @capgo/capacitor-rudderstack für die Implementierungsdetails in API Overview für die Implementierungsdetails in API Overview Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel und Geräte für die Implementierungsdetails in Geräte.