Démarrage
Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-install-referrer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/install-referrer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Installer
Section intitulée « Installer »bun add @capgo/capacitor-install-referrerbunx cap syncImporter
Section intitulée “Importer”import { InstallReferrer } from '@capgo/capacitor-install-referrer';Lire les détails de l'attribution
Section intitulée “Lire les détails de l'attribution”const result = await InstallReferrer.getReferrer();
if (result.platform === 'android') { console.log('Install referrer:', result.referrer); console.log('Click timestamp:', result.clickTimestampSeconds); console.log('Install timestamp:', result.installBeginTimestampSeconds);}
if (result.platform === 'ios') { console.log('AdServices token:', result.attributionToken);}Récupérer l'attribution d'Apple sur iOS
Si vous souhaitez que le natif __CAPGO_KEEP_0__ appelle l'endpoint d'attribution d'Apple, passezIf you want native code to call Apple’s attribution endpoint, pass fetchAppleAttribution.
const result = await InstallReferrer.getReferrer({ fetchAppleAttribution: true, appleAttributionRetryCount: 3, appleAttributionRetryDelayMs: 5000,});
// result.appleAttribution is the parsed Apple attribution response.// See the iOS attribution page for the Apple-provided payload fields.console.log(result.appleAttribution);pendant que les données d'attribution sont encore en cours de préparation pour un jeton valide. Les options de réessai contrôlent combien de fois le plugin natif réessaye avant de rejeter. Voir 404 l'attribution sur iOS Si vous souhaitez que le natif __CAPGO_KEEP_0__ appelle l'endpoint d'attribution d'Apple, passez les options de configuration appropriées pour le plugin natif. pour les détails de la plateforme.
Alias de compatibilité
Section intitulée “Alias de compatibilité”GetReferrer() est disponible pour les applications en cours de migration depuis cap-play-install-referrer.
const result = await InstallReferrer.GetReferrer();Les nouvelles code devraient utiliser getReferrer().