@capgo/capacitor-appsflyer

Übersicht

Capacitor-Plugin für AppsFlyer-Zuschreibung, -Analytik und -Tiefenlinks

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 ein In-App-Ereignis.
• setCustomerUserId - Durch Festlegen Ihres eigenen Kunden-IDs können Sie Ihre eigenen eindeutigen IDs mit den eindeutigen IDs 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.

Öffentliche API

Methode	Beschreibung
addListener('conversion_callback', listener)	Hören Sie auf Konversionsrückrufanrufe, einschließlich onConversionDataSuccess und onConversionDataFail, mit OnConversionDataResult Beitragsdaten.
addListener('oaoa_callback', listener)	Hören Sie auf App-Öffnungsattributionsrückrufanrufe, einschließlich onAppOpenAttribution und onAttributionFailure, mit OnAppOpenAttribution Beitragsdaten.
addListener('udl_callback', listener)	Hören Sie auf vereinigte tiefere Linkrückrufanrufe mit OnDeepLink Beitragsdaten.
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 der manuellen Startmodus zu starten.
logEvent	Ein Ereignis im App-Programm protokollieren.
setCustomerUserId	Legen Sie Ihren eigenen Kunden-ID fest, um Ihre eigene eindeutige ID mit der eindeutigen ID von AppsFlyer und den IDs anderer Geräte zu vergleichen. Diese ID ist in den Rohdatenberichten und in den Postback-APIs für die Vergleichbarkeit mit Ihren internen IDs verfügbar.
setCurrencyCode	Legt die Währung für In-App-Käufe fest. Geben Sie eine dreibuchstabige ISO 4217 code an.
updateServerUninstallToken	Übertragen Sie GCM/FCM-Tokens auf Android oder APNs-Tokens auf iOS, wenn ein anderer Plugin sie gesammelt hat. Verwenden Sie diese Funktion, um die Entfernungsmessungstoken von AppsFlyer an die Entfernungsmessungstoken von AppsFlyer weiterzuleiten.
setAppInviteOneLink	Legt die OneLink-ID fest, die als Basis-Link für die Einladungsattribuierung verwendet wird.
setOneLinkCustomDomain	Registrieren Sie die mit einem Markennamen versehenen OneLink-Domains, damit AppsFlyer die in kurzen Links versteckten Attribuierungsparameter auflösen kann.
appendParametersToDeepLinkingURL	Aktivieren Sie die Attribution für App-Links-Deep-Links ohne OneLink. Rufen Sie diese Methode vor startSDK(). Fügen Sie mindestens pid und is_retargeting=true in den Parametermap ein.
setResolveDeepLinkURLs	Verwenden Sie diese Funktion, wenn ein AppsFlyer-OneLink innerhalb eines anderen Universal-Links eingeschlossen ist. Es ermöglicht es der SDK, die eingeschlossene URL zu lösen, sodass die tiefgreifende Verlinkung noch richtig funktioniert.
addPushNotificationDeepLinkPath	Konfiguriert, wie der SDK Werte aus tiefen Links aus den Payloads von Push-Benachrichtigungen extrahiert.
setSharingFilter	Unterbricht Ereignisse, die an die angegebenen AppsFlyer-Partner weitergeleitet werden.
setSharingFilterForAllPartners	Unterbricht Ereignisse an alle AppsFlyer-Partner. Überschreibt die gesetzte Sharing-Filtrierung.
setSharingFilterForPartners	Unterbricht Ereignisse, die an die angegebenen AppsFlyer-Partner weitergeleitet werden.
setAdditionalData	Fügt zusätzliche Schlüssel-Wert-Daten hinzu, die an AppsFlyer gesendet werden.
getAppsFlyerUID	Holt AppsFlyers einzigartige Geräte-ID (erstellt für jeden neuen Installationsvorgang einer App).
anonymizeUser	Endbenutzer-Opt-Out von AppsFlyer-Analysen (Anonymisierung von Benutzerdaten).
stop	Einmal, wenn dieser API aufgerufen wird, funktioniert unser SDK nicht mehr mit unseren Servern und hört auf zu funktionieren. Nützlich, wenn Benutzer opt-in/opt-out implementieren.
disableSKAdNetwork	Opt-out von SKAdNetwork.
disableAdvertisingIdentifier	Deaktiviert die Sammlung verschiedener Werbe-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	Setzt eine benutzerdefinierte Host-Adresse.
generateInviteLink	Ermöglichen Sie Ihren bestehenden Benutzern, ihre Freunde und Kontakte als neue Benutzer zu Ihrer 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 Quelldefinitionen für die aktuelle Verhaltensweise.
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	Protokolliert eine Eindruck als Teil einer Cross-Promotion-Kampagne. Stellen Sie sicher, dass Sie die ID der beworbenen App wie in der AppsFlyer-Dashboard verwendet.
setUserEmails	Setzen Sie die Benutzer-E-Mails und verschlüsseln Sie sie.
logLocation	Protokollieren Sie den Standort des Benutzers manuell.
setPhoneNumber	Wird als SHA-256-verschlüsselter String gesendet.
setPartnerData	Ermöglicht das Senden von benutzerdefinierten Daten für Partner-Integration-Zwecke.
logInvite	Verwenden Sie diese Methode, um eine Benutzer-Einladung in-app zu protokollieren (af_invite).
setDisableNetworkData	Verwenden Sie diese Methode, um sich von der Sammlung des Netzwerk-Operator-Namens (carrier) und des SIM-Operator-Namens vom Gerät abzumelden.
enableTCFDataCollection	Verwenden Sie diese Methode, um das automatische Sammeln von Zustimmungsdaten für Benutzer zu aktivieren/deaktivieren, die ein CMP verwenden. Die Flag-Wert wird zwischen App-Sitzungen persistiert.
setConsentData	Verwenden Sie diese Methode, um die Zustimmungsdaten des Benutzers manuell zu setzen. 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 App-Besitzer 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	Verwenden Sie diese Methode, um die Zustimmungsdaten des Benutzers manuell zu setzen. 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	Verwenden Sie diese Methode, um zu überprüfen, ob die AppsFlyer SDK bereits in der aktuellen Sitzung gestartet wurde.
isSDKStopped	Verwenden Sie diese Methode, um zu überprüfen, ob die AppsFlyer SDK derzeit gestoppt ist.
disableAppSetId	Deaktiviert die Sammlung von App-Set-IDs. Wenn diese Methode vor der SDK-Initialisierung aufgerufen wird, werden keine App-Set-IDs gesammelt. Wenn diese Methode nach der Initialisierung aufgerufen wird, werden App-Set-IDs 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

Diese Referenz wird synchronisiert von src/definitions.ts in capacitor-Appsflyer.