Passer à la navigation principale

Installer le référentiel plugin Capacitor

Lire les données de référencement Google Play et d'attribution Apple AdServices à partir de Capacitor

Installer

bun add @capgo/capacitor-install-referrer bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-install-referrer
  • pnpm add @capgo/capacitor-install-referrer
  • yarn add @capgo/capacitor-install-referrer

Guide

Comment utiliser Install Referrer dans Capacitor

Tester sur appareil

Télécharger l'application Capgo, puis scanner le code QR code.

Install Referrer plugin preview QR code

En utilisant @capgo/capacitor-install-referrer

@capgo/capacitor-install-referrer lit les signaux d'attribution d'installation dans les applications Capacitor.

Utilisez-le lorsque vous avez besoin de données d'installation Referrer Google Play sur Android et de jetons d'attribution Apple AdServices sur iOS via un seul API.

Installer

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

Ceci que ce plugin expose

  • getReferrer renvoie les détails d'attribution d'installation pour Android ou iOS.
  • GetReferrer est un alias de compatibilité déprécié pour la migration depuis cap-play-install-referrer.
  • Android renvoie la chaîne de référentiel de Play, le timestamp du clic, le timestamp d'installation et le drapeau d'application instantanée.
  • iOS retourne un jeton d'attribution AdServices et peut optionnellement récupérer le payload d'attribution d'Apple.

Exemple d'utilisation

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

const result = await InstallReferrer.getReferrer();

if (result.platform === 'android') {
  console.log(result.referrer);
}

if (result.platform === 'ios') {
  console.log(result.attributionToken);
}

Payload d'attribution Apple

const result = await InstallReferrer.getReferrer({
  fetchAppleAttribution: true,
  appleAttributionRetryCount: 3,
  appleAttributionRetryDelayMs: 5000,
});

console.log(result.appleAttribution);

Remarques sur les plateformes

L'Android utilise le service Google Play Install Referrer et nécessite une installation de magasin Play pour des données de référentiel réelles. L'iOS utilise Apple AdServices car Apple ne fournit pas un équivalent de référentiel de magasin App Store générique.

Référence complète

Continuez à partir de l'utilisation de @capgo/capacitor-install-referrer

Si vous utilisez Utilisation de @capgo/capacitor-install-referrer pour planifier le travail de plugin natif, connectez-l’à @capgo/capacitor-install-referrer pour les détails d'implémentation dans @capgo/capacitor-install-referrer Getting Started pour les détails d'implémentation dans Démarrage Répertoire de plugin Capgo pour le flux de travail du produit dans Répertoire de plugin Capgo Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, et Ajouter ou Mettre à Jour les Plugins pour les détails d'implémentation dans Ajouter ou Mettre à Jour les Plugins

FAQ

FAQ du plugin Install Referrer

Comment installer le plugin Install Referrer dans une application Capacitor?

Exécutez « bun add @capgo/capacitor-install-referrer » (ou « npm install @capgo/capacitor-install-referrer »), puis exécutez « bunx cap sync » afin que les projets iOS et Android prennent en charge le code natif. Importez-l’à partir de « @capgo/capacitor-install-referrer » dans votre application code.

Fonctionne-t-il avec React, Vue et Angular @capgo/capacitor-install-referrer ?

Oui. Install Referrer est un Capacitor package, il fonctionne donc avec tout framework web qui s'exécute à l'intérieur de Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript pur.

Quelle version de Capacitor supporte @capgo/capacitor-install-referrer ?

Capgo plugins suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à votre version majeure de Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le README du GitHub liste les versions maintenues.

Est-ce que @capgo/capacitor-install-referrer est gratuit et open source ?

Oui. Le code source de code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-install-referrer/ et le package est gratuit à installer à partir de npm. Les rapports de bogues et les demandes de modification sont les bienvenus.

Puis-je mettre à jour code qui utilise Install Referrer sans passer par une revue de l'App Store ?

L'installation ou la mise à niveau du plugin change le code natif, il nécessite donc une nouvelle mise à jour de l'application. Après cela, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être déployées instantanément avec les mises à jour Capgo.

Ship Install Referrer changes without waiting for app review

Une fois le plugin est dans votre build de magasin, les mises à jour en direct Capgo transmettent vos modifications de JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Démarrer avec Capgo