AppsFlyer Capacitor Plugin

Verwendung von @capgo/capacitor-appsflyer

Capacitor Plugin für AppsFlyer Attribution, Analytics und Deep Links.

Installieren

bun add @capgo/capacitor-appsflyer
bunx cap sync

bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.

Importieren

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

API auf einen Blick

Methode	Beschreibung
initSDK	Nutze diese Methode, um AppsFlyer SDK zu initialisieren und zu starten. Dieser API sollte direkt nach dem App-Start aufgerufen werden.
startSDK	Nutze diese Methode, um AppsFlyer SDK zu starten, jedoch nur im manuellen Startmodus.
logEvent	Ein In-App-Event loggen.
setCustomerUserId	Durch das Setzen einer eigenen Customer ID kannst du deine eindeutige ID mit der AppsFlyer-ID und den IDs anderer Geräte abgleichen. Diese ID ist in Raw-Data-Reports sowie in den Postback APIs zur Referenzierung mit deinen internen IDs verfügbar.
setCurrencyCode	Legt die Währung für In-App-Käufe fest. Die Währung code muss ein 3-stelliger ISO 4217 code sein.
updateServerUninstallToken	(Android) Ermöglicht das Senden von GCM/FCM-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für Uninstall-Logs genutzt werden. (iOS) Ermöglicht das Senden von APN-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für Uninstall-Logs genutzt werden.
setAppInviteOneLink	Setze die OneLink ID, die für das Attributing von User-Invites verwendet werden soll. Der für die Einladung generierte Link nutzt diesen OneLink als Basis-Link.
setOneLinkCustomDomain	Damit SDK von AppsFlyer versteckte Attributionsparameter (die in der Shortlink-ID dekodiert werden) erfolgreich auflösen kann, muss jede Domain, die im AppsFlyer Dashboard als Branded Domain konfiguriert ist, an diese Methode übergeben werden.
appendParametersToDeepLinkingURL	Ermöglicht App-Besitzern, die App Links für Deep Linking (ohne OneLink) nutzen, Sessions zu attribuieren, die über eine mit ihrer App verknüpfte Domain gestartet wurden. Rufen Sie diese Methode vor start auf. In der Parameter-Map müssen Sie folgende Parameter angeben: pid; is_retargeting muss auf true gesetzt sein.
setResolveDeepLinkURLs	Advertiser können einen AppsFlyer OneLink in einen anderen Universal Link einbetten. Dieser Universal Link öffnet zwar die App, aber die Deep-Linking-Daten werden nicht an AppsFlyer weitergegeben. Mit setResolveDeepLinkURLs können Sie SDK so konfigurieren, dass die eingebetteten OneLink-URLs aufgelöst werden, damit Deep Linking korrekt funktioniert.
addPushNotificationDeepLinkPath	Konfiguriert, wie SDK Deep-Link-Werte aus Push-Notification-Payloads extrahiert.
setSharingFilter	Verhindert, dass Events an die angegebenen AppsFlyer-Partner weitergegeben werden.
setSharingFilterForAllPartners	Verhindert die Weitergabe von Events an alle AppsFlyer-Partner. Überschreibt setSharingFilter.
setSharingFilterForPartners	Verhindert, dass Events an die angegebenen AppsFlyer-Partner weitergegeben werden.
setAdditionalData	Zusätzliche Daten festlegen, die an AppsFlyer gesendet werden. Siehe.
getAppsFlyerUID	Die eindeutige Device ID von AppsFlyer abrufen (wird bei jeder neuen Installation einer App erstellt).
anonymizeUser	Opt-out für Endnutzer bei AppsFlyer Analytics (Anonymisierung der Nutzerdaten).
stop	Sobald API aufgerufen wird, kommuniziert unser SDK nicht mehr mit unseren Servern und funktioniert nicht mehr. Nützlich für die Umsetzung von Opt-in/Opt-out durch Nutzer.
disableSKAdNetwork	Opt-out von SKAdNetwork.
disableAdvertisingIdentifier	Deaktiviert die Erfassung verschiedener Advertising IDs durch SDK. Dazu gehören Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID und Amazon Advertising ID (AAID).
disableCollectASA	Opt-out von Apple Search Ads Attributionen
setHost	Einen benutzerdefinierten Host festlegen.
generateInviteLink	Ermöglicht es Ihren bestehenden Nutzern, Freunde und Kontakte als neue Nutzer in Ihre App einzuladen.
validateAndLogInAppPurchaseAndroid	API zur Server-Verifizierung von In-App-Käufen. Bei erfolgreicher Validierung wird automatisch ein af_purchase-Event mit den entsprechenden Werten geloggt.
validateAndLogInAppPurchaseIos	Zum aktuellen Verhalten siehe die Definitionen im Quellcode.
getSdkVersion	Gibt die in der App verwendete AppsFlyer SDK-Version zurück.
enableFacebookDeferredApplinks	Ermöglicht das Erfassen von Facebook Deferred AppLinks. Erfordert Facebook SDK und die Facebook-App auf dem Zielgerät. Um korrekt zu funktionieren, muss API vor der Initialisierung des AppsFlyer SDK aufgerufen werden.
sendPushNotificationData	Daten aus Push-Benachrichtigungskampagnen messen und abrufen.
setCurrentDeviceLanguage	Setzt die Sprache des Geräts. Die Daten werden in den Raw Data Reports angezeigt.
logCrossPromoteImpression	Loggt eine Impression im Rahmen einer Cross-Promotion-Kampagne. Achten Sie darauf, die beworbene App-ID so zu verwenden, wie sie im AppsFlyer-Dashboard erscheint.
setUserEmails	User-E-Mails festlegen und verschlüsseln.
logLocation	Den Standort des Nutzers manuell loggen.
setPhoneNumber	Wird als SHA-256-verschlüsselter String gesendet.
setPartnerData	Ermöglicht das Senden benutzerdefinierter Daten für Partner-Integrationen.
logInvite	Nutzt zum Loggen eines User-Invite In-App-Events (af_invite).
setDisableNetworkData	Nutzt, um das Sammeln des Netzbetreibers (carrier) und des SIM-Betreibers vom Gerät zu deaktivieren.
enableTCFDataCollection	Nutzt zum Opt-in/out der automatischen Erfassung von Consent-Daten für Nutzer mit einer CMP. Der Flag-Wert wird über App-Sessions hinweg gespeichert.
setConsentData	Nutzt, um Consent-Daten manuell zu setzen. Wenn deine App keine TCF v2.2-kompatible CMP nutzt, verwende diese Methode, um die Consent-Daten direkt an SDK zu übergeben.
logAdRevenue	Durch die Attribuierung von Werbeeinnahmen erhalten App-Besitzer eine vollständige Übersicht über den User LTV und den Kampagnen-ROI. Werbeeinnahmen entstehen durch Anzeigen in Rewarded Videos, Offer Walls, Interstitials und Bannern. Nutze diese Methode, um deine Werbeeinnahmen zu loggen.
setConsentDataV2	Nutzt, um Consent-Daten manuell zu setzen. Wenn deine App keine TCF v2.2-kompatible CMP nutzt, verwende diese Methode, um die Consent-Daten direkt an SDK zu übergeben.
isSDKStarted	Nutzen Sie diese Methode, um zu prüfen, ob das AppsFlyer SDK in der aktuellen Session bereits gestartet wurde.
isSDKStopped	Nutzen Sie diese Methode, um zu prüfen, ob das AppsFlyer SDK aktuell gestoppt ist.
disableAppSetId	Deaktiviert die Erfassung der AppSet ID. Wenn dies vor der Initialisierung von SDK aufgerufen wird, wird die AppSet ID nicht erfasst. Nach der Initialisierung wird sie zwar erfasst, aber nicht in den Request-Payloads gesendet. Nur für Android.
validateAndLogInAppPurchaseV2	API zur Server-Verifizierung von In-App-Käufen V2. Wenn die Validierung erfolgreich ist, wird automatisch ein af_purchase-Event mit den entsprechenden Werten geloggt.

Beispiele

initSDK()

Nutze diese Methode, um AppsFlyer SDK zu initialisieren und zu starten. Dieser API sollte direkt nach dem App-Start aufgerufen werden.

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

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

startSDK()

Nutze diese Methode, um AppsFlyer SDK zu starten, jedoch nur im manuellen Startmodus.

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

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

logEvent()

Ein In-App-Event loggen.

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

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

setCustomerUserId()

Durch das Setzen einer eigenen Customer ID kannst du deine eindeutige ID mit der AppsFlyer-ID und den IDs anderer Geräte abgleichen. Diese ID ist in Raw-Data-Reports sowie in den Postback APIs für den Abgleich mit deinen internen IDs verfügbar.

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

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

setCurrencyCode()

Legt die Währung für In-App-Käufe fest. Die Währung code muss ein 3-stelliger ISO 4217 code sein.

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

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

updateServerUninstallToken()

(Android) Ermöglicht das Senden von GCM/FCM-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für Uninstall-Logs genutzt werden. (iOS) Ermöglicht das Senden von APN-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für Uninstall-Logs genutzt werden.

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

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

Die obige Tabelle listet die 44 Kernmethoden auf. Listener, Version-Helper und der vollständige Contract jeder Methode sind in der GitHub Repository.

Events abonnieren

addListener gibt ein Handle zurück. Rufe handle.remove() wenn der Screen unmountet wird.

Vollständige Referenz

• GitHub Repository
• Dokumentation
• API-Referenz

Weiter mit der Nutzung von @capgo/capacitor-appsflyer

Wenn du es nutzt Nutzung von @capgo/capacitor-appsflyer Um die Arbeit an nativen Plugins zu planen, verbinde sie mit @capgo/capacitor-appsflyer für die Implementierungsdetails in @capgo/capacitor-appsflyer, Erste Schritte für die Implementierungsdetails in Erste Schritte, Capgo Plugin-Verzeichnis für den Produkt-Workflow im Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.