Démarrage

Copiez une commande de configuration avec les étapes d'installation et la guide markdown complet 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

bun add @capgo/capacitor-install-referrer
bunx cap sync

Importer

import { InstallReferrer } from '@capgo/capacitor-install-referrer';

Lire les détails d'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 les informations d'attribution d'Apple sur iOS

Si vous souhaitez que les code natifs appellent l'endpoint d'attribution d'Apple, passez 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);

Apple peut renvoyer 404 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 d'être rejeté. Voir iOS attribution pour les détails de la plateforme.

Alias de compatibilité

GetReferrer() est disponible pour les applications en train de migrer de cap-play-install-referrer.

const result = await InstallReferrer.GetReferrer();

Les nouvelles code devraient utiliser getReferrer().