Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el complemento ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-rudderstack
bunx cap sync

Importar

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

API Resumen

initialize

Inicializa el cliente de RudderStack.

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

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

await nativePlugin.initialize('value');

identify

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

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

await nativePlugin.identify('value');

group

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

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

await nativePlugin.group('value');

track

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

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

await nativePlugin.track('value');

screen

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

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

await nativePlugin.screen('value');

alias

Asigna al usuario actual un nuevo identificador.

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

await nativePlugin.alias('value');

reset

Reinicia el estado de identidad de RudderStack actual.

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

await nativePlugin.reset();

flush

Limpia los eventos programados de inmediato.

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

await nativePlugin.flush();

putDeviceToken

Establece el token de empuje que RudderStack envía a los destinos compatibles.

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

await nativePlugin.putDeviceToken('value');

setAdvertisingId

Consulte las definiciones de origen para el contrato actual.

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

await nativePlugin.setAdvertisingId('value');

putAdvertisingId

Establece un valor de ID de publicidad personalizado.

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

await nativePlugin.putAdvertisingId('value');

setAnonymousId

Consulte las definiciones de origen para el contrato actual.

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

await nativePlugin.setAnonymousId('value');

putAnonymousId

Establece un valor de identificador anónimo personalizado.

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

await nativePlugin.putAnonymousId('value');

optOut

Activa/desactiva la opción de exclusión de seguimiento de RudderStack.

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

await nativePlugin.optOut(true);

Referencia de tipos

RudderConfiguration

Claves de configuración admitidas para los SDK nativos subyacentes de 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

Opciones de llamada de RudderStack.

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 de características aceptado por identify y group.

export type RudderTraits = Record<string, any>;

RudderProperties

Payload de propiedades aceptado por track y screen.

export type RudderProperties = Record<string, any>;

PluginVersionResult

Payload de versión del plugin.

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

RudderLogLevelValue

Niveles de registro de RudderStack expuestos para conveniencia de migración.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.ts. Re-ejecutar la sincronización cuando el público API cambie en la fuente.

Seguir adelante desde Inicio

Si estás utilizando Iniciación para planificar la consola y API operaciones, conecte 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, Claves de API para el detalle de implementación en Claves de API, y Dispositivos para el detalle de implementación en Dispositivos.