Guía
Cómo usar RudderStack en Capacitor
Usando @capgo/capacitor-rudderstack
Capacitor API que refleja la superficie pública de rudder-sdk-cordova.
Instalar
bun add @capgo/capacitor-rudderstack
bunx cap sync
bunx cap sync copia el nativo code del plugin en tus proyectos nativos. Correlo de nuevo después de cada actualización del plugin.
Importar
import { nativePlugin } from '@capgo/capacitor-rudderstack';
Vista general de API
| Metodo | Descripción |
|---|---|
initialize |
Inicializa el cliente de RudderStack. |
identify |
Envía una llamada de identificación para el ID de usuario proporcionado. |
group |
Envía una llamada de grupo para el ID de grupo proporcionado. |
track |
Sends a track call for the provided event name. |
screen |
Envía una llamada de pantalla para el nombre de pantalla proporcionado. |
alias |
Asigna el usuario actual a un nuevo identificador. |
reset |
Reinicia el estado de identidad de RudderStack actual. |
flush |
Envía los eventos programados de inmediato. |
putDeviceToken |
Establece el token de empuje que RudderStack envía a los destinos compatibles. |
setAdvertisingId |
Consulte las definiciones de origen para el comportamiento actual. |
putAdvertisingId |
Sets a custom advertising id value. |
setAnonymousId |
Ver las definiciones de origen para el comportamiento actual. |
putAnonymousId |
Establece un valor de ID anónimo personalizado. |
optOut |
Toggles RudderStack tracking opt-out. |
Ejemplos
initialize()
Inicia el cliente de RudderStack.
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()
Sends a track call for the provided event name.
import { nativePlugin } from '@capgo/capacitor-rudderstack';
await nativePlugin.track('event');
screen()
Envía una llamada de seguimiento para el nombre de evento 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');
La tabla anterior muestra los 14 métodos básicos. Los ayudantes de escucha y versión, así como el contrato completo de cada método, se documentan en el repositorio de GitHub.
Referencia completa
Sigue adelante desde Using @capgo/capacitor-rudderstack
Si estás utilizando Usando @capgo/capacitor-rudderstack planificar la consola y las operaciones API, conecte con @capgo/capacitor-rudderstack para obtener detalles de implementación en @capgo/capacitor-rudderstack Inicio rápido para obtener detalles de implementación en Inicio rápido, API Resumen para los detalles de implementación en API Resumen Introducción para los detalles de implementación en Introducción, y API Claves para los detalles de implementación en API Claves.