Inizia con l'installazione

Installazione

bun add @capgo/capacitor-rudderstack
bunx cap sync

Importazione

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

API Panoramica

initialize

Inizializza il client RudderStack.

Il metodo mantiene la firma di Cordova, quindi il secondo argomento può essere sia un oggetto di configurazione che un oggetto di opzioni Rudder.

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

await nativePlugin.initialize('value');

identify

Invia una chiamata di identificazione per l'ID utente fornito.

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

await nativePlugin.identify('value');

group

Invia una chiamata di gruppo per l'ID gruppo fornito.

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

await nativePlugin.group('value');

track

Invia una chiamata di traccia per il nome evento fornito.

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

await nativePlugin.track('value');

screen

Invia un chiamata di schermo per il nome dello schermo fornito.

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

await nativePlugin.screen('value');

alias

Alias il corrente utente a un nuovo identificatore.

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

await nativePlugin.alias('value');

reset

Ripristina lo stato di identità corrente di RudderStack.

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

await nativePlugin.reset();

flush

Svuota gli eventi in coda immediatamente.

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

await nativePlugin.flush();

putDeviceToken

Imposta il token di push che RudderStack invia ai destinatari supportati.

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

await nativePlugin.putDeviceToken('value');

setAdvertisingId

Vedi le definizioni di riferimento per il contratto corrente.

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

await nativePlugin.setAdvertisingId('value');

putAdvertisingId

Imposta un valore di ID pubblicitario personalizzato.

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

await nativePlugin.putAdvertisingId('value');

setAnonymousId

Vedi le definizioni di riferimento per il contratto corrente.

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

await nativePlugin.setAnonymousId('value');

putAnonymousId

Imposta un valore di id anonimo personalizzato.

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

await nativePlugin.putAnonymousId('value');

optOut

Abilita o disabilita la tracciatura RudderStack.

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

await nativePlugin.optOut(true);

Riferimento di tipo

RudderConfiguration

Chiavi di configurazione supportate per gli SDK nativi RudderStack sottostanti.

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 opzioni per chiamata.

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

Payload di Traits accettati da identify e group.

export type RudderTraits = Record<string, any>;

RudderProperties

Payload di Properties accettati da track e screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

Payload di versione del plugin.

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

RudderLogLevelValue

I valori di livello di registro RudderStack esposti per comodità di migrazione.

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

Fonte di Verità

Questa pagina è generata dal plugin. src/definitions.tsRiavvia la sincronizzazione quando i dati pubblici API cambiano in modo upstream.

Continua da Inizia con

Se stai utilizzando Inizia con per pianificare il dashboard e le API operazioni, connettilo con Usando @capgo/capacitor-rudderstack per la capacità nativa in Usando @capgo/capacitor-rudderstack, Panoramica di API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi di API per i dettagli di implementazione in Chiavi di API, e Dispositivi per i dettagli di implementazione in Dispositivi.