@capgo/capacitor-appsflyer

Übersicht

Capacitor-Plugin für AppsFlyer-Zuschreibung, -Analytik und -Deep-Links.

Kernfunktionen

• initSDK - Verwenden Sie diese Methode, um AppsFlyer SDK zu initialisieren und zu starten. Diese API sollte so schnell wie möglich nach dem App-Start aufgerufen werden.
• startSDK - Verwenden Sie diese Methode, um AppsFlyer SDK nur im manuellen Startmodus zu starten.
• logEvent - Melden Sie einen in-App-Ereignis.
• setCustomerUserId - Mit der eigenen Kunden-ID können Sie Ihre eigene eindeutige ID mit der eindeutigen ID von AppsFlyer und den IDs anderer Geräte abgleichen. Diese ID ist in den Rohdatenberichten und in den Postback-APIs für den Abgleich mit Ihren internen IDs verfügbar.

Öffentlich API

Methode	Beschreibung
addListener('conversion_callback', listener)	Hören Sie auf Konversionsrückrufe, einschließlich onConversionDataSuccess und onConversionDataFail, mit OnConversionDataResult Beiträgen.
addListener('oaoa_callback', listener)	Hören Sie auf App-Öffnungsattributionsrückrufe, einschließlich onAppOpenAttribution und onAttributionFailure, mit OnAppOpenAttribution Payloads.
addListener('udl_callback', listener)	Hören Sie auf einheitliche tiefen Link-Rückruf mit OnDeepLink Payloads.
initSDK	Verwenden Sie diese Methode, um AppsFlyer SDK zu initialisieren und zu starten. Diese API sollte so schnell wie möglich nach dem App-Start aufgerufen werden.
startSDK	Verwenden Sie diese Methode, um AppsFlyer SDK nur in manueller Startmodus zu starten.
logEvent	Loggen Sie ein in-App-Ereignis.
setCustomerUserId	Durch Festlegen Ihres eigenen Kunden-IDs können Sie Ihr eigenes eindeutiges ID mit den eindeutigen IDs von AppsFlyer und anderen Geräten überkreuzreferenzieren. Dieses ID ist in den Rohdatenberichten und in den Postback-APIs für die Überkreuzreferenzierung mit Ihren internen IDs verfügbar.
setCurrencyCode	Setzt die Währung, die für in-App-Käufe verwendet wird. Geben Sie eine dreibuchstabige ISO 4217 code an.
updateServerUninstallToken	Übergeben Sie GCM/FCM-Tokens auf Android oder APNs-Tokens auf iOS, wenn ein anderes Plugin sie gesammelt hat. Verwenden Sie dies, um die Entfernungsmessungstoken an AppsFlyer weiterzuleiten.
setAppInviteOneLink	Setzt die OneLink-ID, die als Basislink für Einladungsattribuierung verwendet wird.
setOneLinkCustomDomain	Registrieren Sie die mit einem Markennamen versehenen OneLink-Domains, damit AppsFlyer die in kurzen Links versteckten Attribution-Parameter auflösen kann.
appendParametersToDeepLinkingURL	Aktivieren Sie die Attribution für App-Links tiefen Links ohne OneLink. Rufen Sie diese Methode vorher auf. startSDK(). Zumindest pid und is_retargeting=true in dem Parameter-Map.
setResolveDeepLinkURLs	Verwenden Sie diese, wenn ein AppsFlyer OneLink innerhalb eines anderen Universal Links eingeschlossen ist. Es ermöglicht es der SDK , die umschlossene URL so tief zu verlinken, dass die Verlinkung noch richtig funktioniert.
addPushNotificationDeepLinkPath	Konfiguriert, wie die SDK tief verlinkte Werte aus Push-Benachrichtigungen extrahiert.
setSharingFilter	Unterbricht Ereignisse, die an die angegebenen AppsFlyer-Partner weitergeleitet werden.
setSharingFilterForAllPartners	Unterbricht Ereignisse, die an alle AppsFlyer-Partner weitergeleitet werden. Überträgt die gesetzte Sharing-Filtrierung.
setSharingFilterForPartners	Unterbricht Ereignisse, die an die angegebenen AppsFlyer-Partner weitergeleitet werden.
setAdditionalData	Setzt zusätzliche Schlüssel-Wert-Daten zum Senden an AppsFlyer.
getAppsFlyerUID	Holt die einzigartige Gerätekennung von AppsFlyer (erstellt für jeden neuen Installationsvorgang einer App).
anonymizeUser	Endbenutzer-Opt-Out von AppsFlyer-Analysen (Anonymisierung von Benutzerdaten).
stop	Sobald diese API aufgerufen wird, kommuniziert unsere SDK nicht mehr mit unseren Servern und funktioniert nicht mehr. Nützlich, wenn Benutzer opt-in/opt-out implementiert werden.
disableSKAdNetwork	Opt-out von SKAdNetwork.
disableAdvertisingIdentifier	Deaktiviert die Sammlung verschiedener Werbeeinheit-IDs durch den 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-Zuschreibungen.
setHost	Eine benutzerdefinierte Host-Adresse setzen.
generateInviteLink	Ermöglicht es Ihren bestehenden Benutzern, ihre Freunde und Kontakte als neue Benutzer zu Ihrem App einzuladen.
validateAndLogInAppPurchaseAndroid	API für die Server-Verifizierung von In-App-Käufen. Ein af_purchase-Ereignis mit den relevanten Werten wird automatisch protokolliert, wenn die Validierung erfolgreich ist.
validateAndLogInAppPurchaseIos	Siehe die Quellendefinitionen für die aktuelle Funktionalität.
getSdkVersion	Ermitteln Sie die AppsFlyer SDK-Version, die in der App verwendet wird.
enableFacebookDeferredApplinks	Aktivieren Sie die Sammlung von Facebook Deferred AppLinks. Erfordert Facebook SDK und Facebook-App auf Ziel-/Klienten-Gerät. Diese API muss vor der Initialisierung der AppsFlyer SDK aufgerufen werden, um richtig zu funktionieren.
sendPushNotificationData	Messung und Datenabruf aus Push-Benachrichtigungs-Kampagnen.
setCurrentDeviceLanguage	Setzen Sie die Sprache des Geräts. Die Daten werden in den Raw Data Reports angezeigt.
logCrossPromoteImpression	Protokollieren Sie eine Eindruck als Teil einer Cross-Promotion-Kampagne. Stellen Sie sicher, dass Sie die ID der beworbenen App verwenden, wie sie in der AppsFlyer-Dashboard erscheint.
setUserEmails	Setze die Benutzer-E-Mail-Adressen und verschlüssere sie.
logLocation	Logge den Standort des Benutzers manuell.
setPhoneNumber	Wird als SHA-256 verschlüsselter String gesendet.
setPartnerData	Ermöglicht das Senden von benutzerdefinierten Daten für Partnerintegrationszwecke.
logInvite	Verwende dies, um eine Benutzer-Einladung in-app zu protokollieren (af_invite).
setDisableNetworkData	Verwende dies, um sich von der Sammlung des Netzwerk-Operator- und SIM-Operator-Name von der App abzumelden (carrier) und Sim-Operator-Name.
enableTCFDataCollection	Verwende dies, um das automatische Sammeln von Zustimmungsdaten zuzulassen oder abzulehnen, für Benutzer, die ein CMP verwenden. Die Flag-Wert wird zwischen den App-Sitzungen persistiert.
setConsentData	Verwende dies, um die Benutzer-Zustimmungsdaten manuell festzulegen. Wenn Ihre App kein CMP verwendet, das mit TCF v2.2 kompatibel ist, verwenden Sie die folgende Methode, um die Zustimmungsdaten direkt an die SDK zu liefern.
logAdRevenue	Durch die Attribution von Werbeeinnahmen erhalten die App-Eigentümer einen umfassenden Überblick über die Nutzer-LTV und die Kampagnen-ROI. Die Werbeeinnahmen werden durch die Anzeige von Videos, Werbeanzeigen, interaktiven Werbeanzeigen und Bannern in einer App generiert. Sie können diese Methode verwenden, um Ihre Werbeeinnahmen zu protokollieren.
setConsentDataV2	Verwende dies, um die Benutzer-Zustimmungsdaten manuell festzulegen. Wenn Ihre App kein CMP verwendet, das mit TCF v2.2 kompatibel ist, verwenden Sie die folgende Methode, um die Zustimmungsdaten direkt an die SDK zu liefern.
isSDKStarted	Verwende diese Methode, um zu überprüfen, ob die AppsFlyer-SDK bereits in der aktuellen Sitzung gestartet wurde.
isSDKStopped	Verwende diese Methode, um zu überprüfen, ob die AppsFlyer-SDK derzeit gestoppt ist.
disableAppSetId	Deaktiviert die Sammlung der App-Set-ID. Wenn diese Funktion vor SDK-Initialisierung aufgerufen wird, wird die App-Set-ID nicht gesammelt. Wenn diese Funktion nach der Initialisierung aufgerufen wird, wird die App-Set-ID gesammelt, aber nicht in den Anforderungspayloads gesendet. Nur für Android.
validateAndLogInAppPurchaseV2	API für die Server-Verifizierung von In-App-Käufen V2. Ein af_purchase-Ereignis mit den relevanten Werten wird automatisch protokolliert, wenn die Validierung erfolgreich ist.

Quelle der Wahrheit

Dieses Referenzwerk wird von src/definitions.ts in capacitor-appsflyer.