Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-appsflyer
npx cap sync

Importer

import { AppsFlyer } from '@capgo/capacitor-appsflyer';
import type {
  AFAdRevenueData,
  AFAndroidInAppPurchase,
  AFAnonymizeUser,
  AFAppendToDeepLink,
  AFConsentData,
  AFConsentOptions,
  AFCuid,
  AFCurrency,
  AFData,
  AFDisable,
  AFEmails,
  AFEnableTCFDataCollection,
  AFEvent,
  AFFbDAL,
  AFFilters,
  AFHost,
  AFInit,
  AFIosInAppPurchase,
  AFLanguage,
  AFLatLng,
  AFLinkGenerator,
  AFLogInvite,
  AFOnelinkDomain,
  AFOnelinkID,
  AFPartnerData,
  AFPath,
  AFPhone,
  AFPromotion,
  AFPurchaseDetailsV2,
  AFPushPayload,
  AFUninstall,
  AFUrls,
} from '@capgo/capacitor-appsflyer';

Démarrage rapide

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.initSDK({
  devKey: 'dev-key-123',
  appID: 'app-id-123',
});
console.log(result);

Exemple : startSDK

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.startSDK();
console.log(result);

Exemple : logEvent

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);

Erreurs courantes

• Écouteurs: supprimez les handles lors du démontage des écrans.
• Sync native : exécuter npx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Aperçu de API

initSDK

Utilisez cette méthode pour initialiser et démarrer le SDK d'AppsFlyer. Ce API doit être appelé dès le lancement de l'application.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.initSDK({
  devKey: 'dev-key-123',
  appID: 'app-id-123',
});
console.log(result);

startSDK

Utilisez cette méthode pour démarrer le SDK d'AppsFlyer, uniquement en mode démarrage manuel.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.startSDK();
console.log(result);

logEvent

Enregistrer un événement in-app.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);

setCustomerUserId

Définir votre propre ID client vous permet de faire le lien entre votre ID unique et l'ID unique d'AppsFlyer ainsi que les IDs d'autres appareils. Cet ID est disponible dans les rapports de données brutes et dans les API Postback pour le recoupement avec vos IDs internes.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });

setCurrencyCode

Définit la devise utilisée pour les achats in-app. Fournissez un code ISO 4217 à trois caractères.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });

updateServerUninstallToken

Passez les tokens GCM/FCM sur Android ou les tokens APNs sur iOS lorsqu'un autre plugin les a collectés. Utilisez ceci pour transmettre les tokens de mesure de désinstallation à AppsFlyer.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });

setAppInviteOneLink

Définit l'ID OneLink utilisé comme lien de base pour l'attribution d'invitation.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setAppInviteOneLink({ onelinkID: 'onelink-id-123' });

setOneLinkCustomDomain

Enregistre vos domaines OneLink personnalisés pour qu'AppsFlyer puisse résoudre les paramètres d'attribution cachés dans les liens courts.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setOneLinkCustomDomain({ domains: ['example.com'] });

appendParametersToDeepLinkingURL

Active l'attribution pour les deep links App Links sans OneLink. Appelez cette méthode avant startSDK(). Inclure au moins pid et is_retargeting=true dans la map de paramètres.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.appendParametersToDeepLinkingURL({
  contains: 'contains',
  parameters: {},
});

setResolveDeepLinkURLs

Utilisez cette option lorsqu'un OneLink AppsFlyer est imbriqué dans un autre Universal Link. Elle permet à SDK de résoudre l'URL imbriquée pour que le deep linking continue de fonctionner correctement.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setResolveDeepLinkURLs({ urls: ['https://example.com'] });

addPushNotificationDeepLinkPath

Configure la manière dont SDK extrait les valeurs des deep links depuis les payloads de notifications push.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.addPushNotificationDeepLinkPath({ path: ['path/to/file'] });

setSharingFilter

Empêche la propagation des événements vers les partenaires AppsFlyer spécifiés.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setSharingFilter({ filters: ['filter'] });

setSharingFilterForAllPartners

Empêche la propagation des événements vers tous les partenaires AppsFlyer. Écrase setSharingFilter.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Empêche la propagation des événements vers les partenaires AppsFlyer spécifiés.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setSharingFilterForPartners({ filters: ['filter'] });

setAdditionalData

Définit des données clés-valeurs supplémentaires à envoyer à AppsFlyer.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setAdditionalData({ additionalData: {} });

getAppsFlyerUID

Récupère l'ID unique de l'appareil AppsFlyer (créé à chaque nouvelle installation de l'app).

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.getAppsFlyerUID();
console.log(result);

anonymizeUser

End User Opt-Out from AppsFlyer analytics (Anonymize user data).

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.anonymizeUser({ anonymizeUser: true });

stop

Une fois ce API invoqué, notre SDK ne communique plus avec nos serveurs et cesse de fonctionner.\nUtile lors de l'implémentation de l'opt-in/opt-out de l'utilisateur.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.stop();
console.log(result);

disableSKAdNetwork

Se désinscrire de SKAdNetwork

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableSKAdNetwork({ shouldDisable: true });

disableAdvertisingIdentifier

Désactive la collecte de divers identifiants publicitaires par le SDK. Cela inclut l'IDFA (Apple Identity for Advertisers), le GAID (Google Advertising ID), l'OAID et l'AAID (Amazon Advertising ID).

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableAdvertisingIdentifier({ shouldDisable: true });

disableCollectASA

Désactiver les attributions Apple Search Ads.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableCollectASA({ shouldDisable: true });

setHost

Définir un hôte personnalisé.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setHost({
  hostPrefixName: 'host-prefix',
  hostName: 'host',
});

generateInviteLink

Permettre à vos utilisateurs existants d'inviter leurs amis et contacts comme nouveaux utilisateurs de votre application

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.generateInviteLink({ brandDomain: 'example.com' });
console.log(result);

validateAndLogInAppPurchaseAndroid

API pour la vérification côté serveur des achats in-app. Un événement af_purchase avec les valeurs pertinentes sera automatiquement logué si la validation réussit.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.validateAndLogInAppPurchaseAndroid({
  currency: 'USD',
  publicKey: 'public-key-123',
  signature: 'signature',
  purchaseData: 'purchase-data',
  price: 'price',
});
console.log(result);

validateAndLogInAppPurchaseIos

Consultez les définitions source pour le contrat actuel.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.validateAndLogInAppPurchaseIos({
  currency: 'USD',
  inAppPurchase: 'in-app-purchase',
  price: 'price',
  transactionId: 'transaction-id-123',
});
console.log(result);

getSdkVersion

Récupérer la version SDK d'AppsFlyer utilisée dans l'app.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.getSdkVersion();
console.log(result);

enableFacebookDeferredApplinks

Active la collecte des Facebook Deferred AppLinks. Nécessite le SDK Facebook et l'application Facebook sur l'appareil cible. Ce API doit être appelé avant d'initialiser le SDK AppsFlyer pour fonctionner correctement.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.enableFacebookDeferredApplinks({ enableFacebookDAL: true });
console.log(result);

sendPushNotificationData

Mesurer et récupérer les données des campagnes de notifications push.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.sendPushNotificationData({ pushPayload: {} });

setCurrentDeviceLanguage

Définit la langue de l'appareil. Les données seront affichées dans les Raw Data Reports

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.setCurrentDeviceLanguage({ language: 'en-US' });
console.log(result);

logCrossPromoteImpression

Enregistre une impression dans le cadre d'une campagne de cross-promotion. Assurez-vous d'utiliser l'ID de l'application promue tel qu'il apparaît dans le dashboard AppsFlyer.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.logCrossPromoteImpression({
  appID: 'app-id-123',
  campaign: 'campaign',
  parameters: {},
});
console.log(result);

setUserEmails

Définir les e-mails des utilisateurs et les chiffrer.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.setUserEmails({ emails: ['user@example.com'] });
console.log(result);

logLocation

Enregistrer manuellement la position de l'utilisateur

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.logLocation({
  latitude: 48.8566,
  longitude: 2.3522,
});
console.log(result);

setPhoneNumber

Sera envoyé sous forme de chaîne chiffrée en SHA-256.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.setPhoneNumber({ phone: '+15555550123' });
console.log(result);

setPartnerData

Permet d'envoyer des données personnalisées pour l'intégration de partenaires.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.setPartnerData({
  data: {},
  partnerId: 'partner-id-123',
});
console.log(result);

logInvite

Use to log a user-invite in-app event (af_invite).

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.logInvite({
  eventParameters: {},
  channel: 'channel',
});
console.log(result);

setDisableNetworkData

À utiliser pour refuser la collecte du nom de l'opérateur réseau (carrier) et du nom de l'opérateur SIM de l'appareil.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setDisableNetworkData({ shouldDisable: true });

enableTCFDataCollection

Permet d'activer ou de désactiver la collecte automatique des données de consentement pour les utilisateurs utilisant une CMP. La valeur du flag est conservée entre les sessions de l'application.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.enableTCFDataCollection({ shouldEnableTCFDataCollection: true });

setConsentData

Utilisez cette méthode pour définir manuellement les données de consentement utilisateur. Si votre application n'utilise pas de CMP compatible avec TCF v2.2, utilisez la méthode suivante pour fournir manuellement les données de consentement directement au SDK.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setConsentData({ data: { isUserSubjectToGDPR: true } });

logAdRevenue

By attributing ad revenue, app owners gain the complete view of user LTV and campaign ROI. Ad revenue is generated by displaying ads on rewarded videos, offer walls, interstitials, and banners in an app. You can use this method to log your ad revenue.

import { AppsFlyer, MediationNetwork } from '@capgo/capacitor-appsflyer';

await AppsFlyer.logAdRevenue({
  monetizationNetwork: 'monetization-network',
  mediationNetwork: MediationNetwork.IRONSOURCE,
  currencyIso4217Code: 'USD',
  revenue: 1,
});

setConsentDataV2

Utilisez cette méthode pour définir manuellement les données de consentement utilisateur. Si votre application n'utilise pas de CMP compatible avec TCF v2.2, utilisez la méthode suivante pour fournir manuellement les données de consentement directement au SDK.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.setConsentDataV2({
  isUserSubjectToGDPR: true,
  hasConsentForDataUsage: true,
  hasConsentForAdsPersonalization: true,
  hasConsentForAdStorage: true,
});

isSDKStarted

Utilisez cette méthode pour vérifier si le SDK d'AppsFlyer a déjà été démarré dans la session actuelle.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.isSDKStarted();
console.log(result);

isSDKStopped

Utilisez cette méthode pour vérifier si le SDK d'AppsFlyer est actuellement arrêté.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.isSDKStopped();
console.log(result);

disableAppSetId

Désactive la collecte de l'AppSet ID. Si cette méthode est appelée avant l'initialisation de SDK, l'App Set ID ne sera pas collecté. Si elle est appelée après l'initialisation, l'App Set ID sera collecté mais ne sera pas inclus dans les payloads des requêtes. Android uniquement.

import { AppsFlyer } from '@capgo/capacitor-appsflyer';

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API pour la vérification côté serveur des achats in-app V2. Un événement af_purchase avec les valeurs correspondantes sera automatiquement logué si la validation réussit.

import { AppsFlyer, AFPurchaseType } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.validateAndLogInAppPurchaseV2({
  purchaseDetails: {
    purchaseType: AFPurchaseType.oneTimePurchase,
    purchaseToken: 'purchase-token-123',
    productId: 'product-id-123',
  },
});
console.log(result);

Source de vérité

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-appsflyer pour la capacité native dans l'utilisation de @capgo/capacitor-appsflyer, 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, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.