Getting Started

Installa

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

bun add @capgo/capacitor-rudderstack
bunx cap sync

Importa

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

Panoramica di API

initialize

Inizializza il client RudderStack.

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

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

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

identify

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

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

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

group

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

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

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

track

Invia una chiamata di tracciamento per il nome evento fornito.

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

await nativePlugin.track('event');

screen

Invia una chiamata dello schermo per il nome dello schermo fornito.

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

await nativePlugin.screen('screen');

alias

Alias il corrente utente ad un nuovo identificatore.

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

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

reset

Ripristina lo stato di identificazione RudderStack corrente.

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

await nativePlugin.reset();

flush

Scarta 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('device-token-123');

setAdvertisingId

Vedi le definizioni di riferimento per il contratto corrente.

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

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

putAdvertisingId

Sets a custom advertising id value.

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

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

setAnonymousId

Vedi le definizioni di riferimento per il contratto corrente.

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

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

putAnonymousId

Imposta un valore di ID anonimo personalizzato.

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

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

optOut

Abilita/disabilita l'opt-out di RudderStack.

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

await nativePlugin.optOut(true);

Riferimento di tipo

RudderConfiguration

Chiavi di configurazione supportate per i relativi SDK nativi di RudderStack.

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 caratteristiche accettate da identify e group.

export type RudderTraits = Record<string, any>;

RudderProperties

Payload di proprietà accettate da track e screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

Version payload del plugin.

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

RudderLogLevelValue

Valori di livello di log RudderStack esposti per comodità di migrazione.

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

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.tsRieccere lo sync quando le informazioni pubbliche API cambiano in alto flusso.

Continua da qui: Iniziata

Se stai utilizzando Avvio rapido per pianificare il dashboard e le API operazioni, connettilo con Utilizzo di @capgo/capacitor-rudderstack per la capacità nativa in Utilizzo di @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.