Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

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

Poi usa 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 la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-rudderstack
bunx cap sync

Importa

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

Avvio rapido

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

await nativePlugin.initialize({
  writeKey: 'YOUR_WRITE_KEY',
  dataPlaneUrl: 'https://your.dataplane.rudderstack.com',
});
await nativePlugin.identify({ userId: 'user_123', traits: { plan: 'pro' } });
await nativePlugin.track({ event: 'Signed Up', properties: { source: 'mobile' } });

Esempio: screen tracking

await nativePlugin.screen({
  screen: 'Checkout',
  properties: { step: 'payment' },
});

Errori comuni

• Inizializza una volta: ripetute initialize() possono duplicare lo stato di SDK, proteggendolo durante il bootstrap dell'app.
• Svuota prima del background: chiamata flush() quando iOS o Android potrebbero sospendere il processo durante l'upload.
• ID pubblicitari: helper per l'opt-in solo se la privacy policy copre la raccolta di IDFA o GAID.

Panoramica API

initialize

Inizializza il client RudderStack.

Il metodo mantiene la firma Cordova, quindi il secondo argomento può essere un oggetto config o un oggetto Rudder options.

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

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

identify

Invia una chiamata identify per l'id utente fornito.

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

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

group

Invia una chiamata group per l'id gruppo fornito.

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

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

track

Invia una chiamata track per il nome dell'evento fornito.

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

await nativePlugin.track('event');

screen

Invia una chiamata screen per il nome della schermata fornito.

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

await nativePlugin.screen('screen');

alias

Crea un alias dell'utente corrente con un nuovo identificatore.

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

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

reset

Resetta lo stato corrente dell'identità RudderStack.

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

await nativePlugin.reset();

flush

Svuota immediatamente gli eventi in coda.

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

await nativePlugin.flush();

putDeviceToken

Imposta il push token che RudderStack inoltra alle destinazioni supportate.

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

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

setAdvertisingId

Consulta le definizioni nel sorgente per il contratto attuale.

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

Consulta le definizioni nel sorgente per il contratto attuale.

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

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

putAnonymousId

Sets a custom anonymous id value.

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

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

optOut

Toggles RudderStack tracking opt-out.

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

await nativePlugin.optOut(true);

Riferimento ai tipi

RudderConfiguration

Chiavi di configurazione supportate per gli SDK nativi di 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

Opzioni di RudderStack per singola 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 Traits accettato da identify e group.

export type RudderTraits = Record<string, any>;

RudderProperties

Payload Properties accettato da track e screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

Payload della versione del plugin.

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

RudderLogLevelValue

Valori del log level di RudderStack esposti per facilitare la migrazione.

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

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-rudderstack per la funzionalità nativa in Utilizzo di @capgo/capacitor-rudderstack, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.