RudderStack Plugin Capacitor

Utilisation de @capgo/capacitor-rudderstack

Capacitor API qui reflète la surface publique de rudder-sdk-cordova.

Installer

bun add @capgo/capacitor-rudderstack
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode	Description
initialize	Initialise le client RudderStack.
identify	Envoie un appel identify pour l'ID utilisateur fourni.
group	Envoie un appel group pour l'ID de groupe fourni.
track	Envoie un appel track pour le nom d'événement fourni.
screen	Envoie un appel screen pour le nom d'écran fourni.
alias	Crée un alias de l'utilisateur actuel vers un nouvel identifiant.
reset	Réinitialise l'état d'identité RudderStack actuel.
flush	Envoie immédiatement les événements en attente.
putDeviceToken	Définit le token push que RudderStack transmet aux destinations prises en charge.
setAdvertisingId	Consultez les définitions source pour le comportement actuel.
putAdvertisingId	Définit une valeur d'ID publicitaire personnalisée.
setAnonymousId	Consultez les définitions source pour le comportement actuel.
putAnonymousId	Définit une valeur d'ID anonyme personnalisée.
optOut	Active ou désactive l'opt-out du suivi RudderStack.

Exemples

initialize()

Initialise le client RudderStack.

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

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

identify()

Envoie un appel identify pour l'ID utilisateur fourni.

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

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

group()

Envoie un appel group pour l'ID de groupe fourni.

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

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

track()

Envoie un appel track pour le nom d'événement fourni.

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

await nativePlugin.track('event');

screen()

Envoie un appel screen pour le nom d'écran fourni.

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

await nativePlugin.screen('screen');

alias()

Crée un alias de l'utilisateur actuel vers un nouvel identifiant.

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

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

Le tableau ci-dessus liste les 14 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuer depuis Utiliser @capgo/capacitor-rudderstack

Si vous utilisez Utilisation de @capgo/capacitor-rudderstack pour planifier les opérations du dashboard et de API, connectez-l’avec @capgo/capacitor-rudderstack pour les détails d'implémentation dans @capgo/capacitor-rudderstack, Prise en main pour les détails d'implémentation dans Getting Started Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'Introduction, et Clés API pour les détails d'implémentation dans les clés API.