Getting Started

Copiez un prompt de configuration avec les étapes d'installation et le 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';

Lisez 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 code natif appelle 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 retourner 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 de rejeter. Voir l'attribution iOS pour les détails de la plateforme.

Compatibilité Alias

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

const result = await InstallReferrer.GetReferrer();

Les nouvelles code devraient utiliser getReferrer().

Continuez de la section Démarrage rapide

Démarrage rapide pour planifier le travail de plugin natif, connectez-le avec Utilisation de @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-install-referrer pour la capacité native dans l'utilisation de @capgo/capacitor-install-referrer, for the native capability in Using @capgo/capacitor-install-referrer, Capgo Plugin Directory pour le flux de travail du produit dans le Répertoire de Plugin Capgo les Plugins Capacitor par Capgo pour le détail d'implémentation dans les Plugins Capacitor par Capgo, Ajouter ou Mettre à Jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour les Plugins, et Alternatives de Plugin d'Entreprise Ionic pour le flux de travail du produit dans Alternatives de Plugin d'Entreprise Ionic.