Getting Started

Instalar

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Luego utiliza el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas del plataforma a continuación:

bun add @capgo/capacitor-rudderstack
bunx cap sync

Importar

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

API Resumen

initialize

Inicia el cliente de RudderStack.

El método mantiene la firma de Cordova, por lo que el segundo argumento puede ser una configuración de objeto o un objeto de opciones de Rudder.

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

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

identify

Envía una llamada de identificación para el ID de usuario proporcionado.

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

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

group

Envía una llamada de grupo para el id de grupo proporcionado.

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

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

track

Envía una llamada de track para el nombre de evento proporcionado.

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

await nativePlugin.track('event');

screen

Envía una llamada de pantalla para el nombre de pantalla proporcionado.

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

await nativePlugin.screen('screen');

alias

Asigna un nuevo identificador al usuario actual.

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

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

reset

Reinicia el estado de identidad RudderStack actual.

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

await nativePlugin.reset();

flush

Envía eventos programados de inmediato.

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

await nativePlugin.flush();

putDeviceToken

Establece el token de notificación que RudderStack envía a los destinos compatibles.

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

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

setAdvertisingId

Consulte las definiciones de origen para el contrato actual.

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

Consulte las definiciones de origen para el contrato actual.

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

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

putAnonymousId

Establece un valor personalizado de ID anónimo.

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);

Referencia de tipo

RudderConfiguration

Claves de configuración admitidas para los SDK nativos de RudderStack subyacentes.

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

Opciones de RudderStack por llamada.

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

Carga de características aceptada por identify y group.

export type RudderTraits = Record<string, any>;

RudderProperties

Propiedades de pago aceptadas por track y screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

Nivel de registro de RudderStack

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

RudderLogLevelValue

Esta página se genera a partir de las propiedades del plugin

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

Versión del plugin

Esta página se genera a partir de la extensión del plugin. src/definitions.ts. Re-ejecuta la sincronización cuando los datos públicos API cambien en la fuente.

Sigue adelante desde Inicio

Si estás utilizando Getting Started planificar el panel de control y las API operaciones, conectarlo con Usando @capgo/capacitor-rudderstack para la capacidad nativa en Usando @capgo/capacitor-rudderstack Resumen de API para el detalle de implementación en Resumen de API Introducción para el detalle de implementación en Introducción API Claves para los detalles de implementación en API Claves, y Dispositivos para los detalles de implementación en dispositivos.