Anleitung
Verwendung von AppsFlyer in Capacitor
Verwendung von @capgo/capacitor-appsflyer
Capacitor-Plugin für die Attribution, Analytics und tiefen Links von AppsFlyer
Installieren
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync kopiert die Plugin-Native code in Ihre native Projekte. Führen Sie es erneut aus, nachdem Sie jedes Plugin aktualisiert haben.
Importieren
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
API im Überblick
| Methode | Beschreibung |
|---|---|
initSDK |
Verwenden Sie diese Methode, um AppsFlyer zu initialisieren und zu starten SDK. Diese API sollte sofort nach dem App-Start aufgerufen werden. |
startSDK |
Verwenden Sie diese Methode, um AppsFlyer SDK nur im manuellen Startmodus zu starten. |
logEvent |
Ereignis protokollieren |
setCustomerUserId |
Die Festlegung Ihres eigenen Kunden-IDs ermöglicht es Ihnen, Ihre eigenen eindeutigen IDs mit den eindeutigen IDs 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 |
Währung für In-App-Käufe setzen. Die Währung code sollte ein 3-stelliger ISO 4217-Code code sein. |
updateServerUninstallToken |
(Android) Ermöglicht die Weitergabe von GCM/FCM-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für die Uninstall-Protokollierung verwendet werden. (iOS) Ermöglicht die Weitergabe von APN-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für die Protokollierung von Uninstall verwendet werden. |
setAppInviteOneLink |
Setzen Sie die OneLink-ID, die für die Zuschreibung von Benutzer-Einladungen verwendet werden soll. Die für den Benutzer-Einladung generierte URL wird auf dieser OneLink als Basis-URL verwendet. |
setOneLinkCustomDomain |
Damit AppsFlyer SDK erfolgreich versteckte (in der Kurzlink-ID dekodierte) Zuschreibungsparameter auflösen kann, sollten alle als markiertes Domäne im AppsFlyer-Dashboard konfigurierten Domänen dieser Methode zur Verfügung gestellt werden. |
appendParametersToDeepLinkingURL |
Erstellt Sitzungen, die über eine mit der App verbundene Domain initiiert wurden, ohne dass OneLink verwendet wird. Aufrufen Sie diese Methode vor dem Aufrufen von start. Sie müssen die folgenden Parameter in der parameters Map bereitstellen: pid ist_retargeting muss auf true gesetzt werden. |
setResolveDeepLinkURLs |
Advertiser können einen AppsFlyer OneLink innerhalb eines anderen Universal Links einhüllen. Dieser Universal Link ruft die App auf, aber die tiefen-Link-Daten werden nicht an AppsFlyer weitergeleitet. setResolveDeepLinkURLs ermöglicht Ihnen, die SDK zu konfigurieren, um die umhüllten OneLink-URLs zu lösen, sodass tiefes Linken korrekt erfolgen kann. |
addPushNotificationDeepLinkPath |
Konfiguriert, wie die SDK tiefgreifende Verknüpfungswerte aus Push-Benachrichtigungen aus den Payloads extrahiert. |
setSharingFilter |
Unterbricht die Ereignis-Übertragung an die angegebenen AppsFlyer-Partner. |
setSharingFilterForAllPartners |
Unterbricht die Ereignis-Übertragung an alle AppsFlyer-Partner. Überschreibt setSharingFilter. |
setSharingFilterForPartners |
Unterbricht die Ereignis-Übertragung an die angegebenen AppsFlyer-Partner. |
setAdditionalData |
Setzt zusätzliche Daten, die an AppsFlyer gesendet werden sollen. Siehe. |
getAppsFlyerUID |
Erhält die einzigartige Geräte-ID von AppsFlyer (erstellt für jeden neuen Installationsvorgang einer App). |
anonymizeUser |
Endbenutzer-Opt-Out von AppsFlyer-Analysen (Anonymisierung von Benutzerdaten). |
stop |
Einmal wird dieser API aufgerufen, funktioniert unser SDK nicht mehr mit unseren Servern und hält auf. Nützlich bei der Implementierung von Benutzer-Opt-in/Opt-out. |
disableSKAdNetwork |
Opt-out von SKAdNetwork. |
disableAdvertisingIdentifier |
Unterbricht die Sammlung verschiedener Werbe-IDs durch die SDK. Dies umfasst Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID und Amazon Advertising ID (AAID). |
disableCollectASA |
Opt-out von Apple Search Ads-Attributionen. |
setHost |
Benennen Sie einen benutzerdefinierten Host. |
generateInviteLink |
Ermöglichen Sie es Ihren bestehenden Benutzern, ihre Freunde und Kontakte als neue Benutzer zu Ihrer App einzuladen. |
validateAndLogInAppPurchaseAndroid |
API für die Servervalidierung 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 Verhaltensweise. |
getSdkVersion |
Get the AppsFlyer SDK version used in app. |
enableFacebookDeferredApplinks |
Aktivieren Sie die Sammlung von Facebook-Deferred-AppLinks. Erfordert Facebook SDK und Facebook-App auf Zielgerät/Client. 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 Rohdatenberichten angezeigt. |
logCrossPromoteImpression |
protokolliert eine Eindrücke als Teil einer Querwerbungskampagne. Stellen Sie sicher, dass Sie die angezeigte App-ID verwenden, wie sie in der AppsFlyer-Dashboard erscheint. |
setUserEmails |
Set the user emails and encrypt them. |
logLocation |
Manuell den Standort des Benutzers protokollieren. |
setPhoneNumber |
Wird als SHA-256-verschlüsselter String gesendet. |
setPartnerData |
Ermöglicht das Senden von benutzerdefinierten Daten für Zwecke der Partnerintegration. |
logInvite |
Use to log a user-invite in-app event (af_invite). |
setDisableNetworkData |
Verwenden Sie dies, um die automatische Erfassung der Netzwerk- und SIM-Operator-Name vom Gerät aus zu deaktivieren. |
enableTCFDataCollection |
Verwenden Sie dies, um das automatische Sammeln von Zustimmungsdaten für Benutzer einzuschalten/auszuschalten, die ein CMP verwenden. Die Flag-Wert wird zwischen den App-Sitzungen persistiert. |
setConsentData |
Verwenden Sie dies, 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 Zuweisung von Werbeeinnahmen erhalten App-Besitzer einen umfassenden Überblick über die Nutzer-LTV und die Kampagnen-ROI. Die Werbeeinnahmen werden durch die Anzeige von Videos, Werbe-Wänden, Interstitiellen 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 wurde. |
disableAppSetId |
Disables AppSet ID collection. If called before SDK init, App Set ID will not be collected. If called after init, App Set ID will be collected but not sent in request payloads. Android only. |
validateAndLogInAppPurchaseV2 |
API für die Server-Überprüfung von In-App-Käufen V2. Ein af_purchase-Ereignis mit den relevanten Werten wird automatisch protokolliert, wenn die Validierung erfolgreich ist. |
Beispiele
initSDK()
Verwenden Sie diese Methode, um AppsFlyer zu initialisieren und zu starten SDK. Diese API sollte sofort 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()
Verwenden Sie diese Methode, um AppsFlyer SDK nur in manueller Start-Modus zu starten.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();
console.log(result);
logEvent()
Ein In-App-Ereignis protokollieren.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);
setCustomerUserId()
Durch die Festlegung Ihres eigenen Kunden-IDs können Sie Ihre eigene eindeutige ID mit der eindeutigen ID von AppsFlyer und den IDs anderer Geräte vergleichen. Diese ID ist in den Rohdatenberichten und in den Postback-APIs für die Vergleichbarkeit mit Ihren internen IDs verfügbar.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });
setCurrencyCode()
Setzt die Währung für In-App-Käufe. Die Währung code sollte ein 3-stelliges ISO 4217-code sein.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) Erlaubt die Weitergabe von GCM/FCM-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für die Protokollierung von Uninstall verwendet werden. (iOS) Erlaubt die Weitergabe von APN-Tokens, die von Drittanbieter-Plugins gesammelt wurden, an den AppsFlyer-Server. Kann für die Protokollierung von Uninstall verwendet werden.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });
Die Tabelle oben listet die 44 Kernmethoden auf. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind im GitHub-Repository.
Ereignisse abhören
addListener eine Verbindung zurückgeben. Aufrufen handle.remove() wenn sich das Bildschirmfenster auflöst.
Vollständige Referenz
Weitermachen von Using @capgo/capacitor-appsflyer
Wenn Sie Using verwenden Verwendung von @capgo/capacitor-appsflyer Um native Plugin-Arbeit zu planen, verbinden Sie es mit @capgo/capacitor-AppsFlyer für die Implementierungsdetails in @capgo/capacitor-appsflyer Getting Started für die Implementierungsdetails in Getting Started, Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins.