Anleitung zum Einrichten

Installieren

bun add @capgo/capacitor-appsflyer
bunx cap sync

Einrichtungsanleitung

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';

API Übersicht

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.

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

await AppsFlyer.initSDK({} as AFInit);

startSDK

Verwenden Sie diese Methode, um AppsFlyer SDK nur in manueller Startmodus zu starten.

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

await AppsFlyer.startSDK();

logEvent

Ein in-App-Ereignis protokollieren.

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

await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

Durch die Einstellung 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({} as AFCuid);

setCurrencyCode

Legt die für In-App-Käufe verwendete Währung fest. Geben Sie eine dreibuchstabige ISO 4217 code.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Übertragen Sie GCM/FCM-Tokens auf Android oder APNs-Tokens auf iOS, wenn ein anderes Plugin sie gesammelt hat. Verwenden Sie diese Funktion, um die Entfernungsmessungstoken an AppsFlyer weiterzuleiten.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

Legt die OneLink-ID fest, die als Basis-Link für die Einladungsattribuierung verwendet wird.

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Registriert benannte OneLink-Domains, damit AppsFlyer die in kurzen Links versteckten Attribution-Parameter auflösen kann.

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Aktiviert die Attribution für App-Links-Deep-Links ohne OneLink. Rufen Sie diese Methode vorher auf startSDK(). Fügen Sie mindestens pid und is_retargeting=true in die Parametermap ein.

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Verwenden Sie dies, wenn ein AppsFlyer OneLink innerhalb eines anderen Universal-Links eingehüllt ist. Es lässt die SDK die umschlossene URL auflösen, so dass die tiefgreifende Verlinkung noch richtig funktioniert.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Konfiguriert, wie SDK Werte aus den Payloads von Push-Benachrichtigungen extrahiert.

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Unterdrückt Ereignisse, die an die angegebenen AppsFlyer-Partner weitergeleitet werden.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Unterdrückt Ereignisse, die an alle AppsFlyer-Partner weitergeleitet werden. Überprüft setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Unterdrückt Ereignisse, die an die angegebenen AppsFlyer-Partner weitergeleitet werden.

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Setzt zusätzliche Schlüssel-Wert-Daten, die an AppsFlyer gesendet werden.

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

await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

AppsFlyer-UID des Geräts (erstellt für jede neue Installation einer App) erhalten.

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

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

Endbenutzer-Opt-Out von AppsFlyer-Analytics (Anonymisierung von Benutzerdaten).

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Wenn dieser API aufgerufen wird, unterbricht unsere SDK die Kommunikation mit unseren Servern und funktioniert nicht mehr. Zum Implementieren von Benutzer-Opt-in/Opt-out.

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

await AppsFlyer.stop();

disableSKAdNetwork

SKAdNetwork ausgeschlossen

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Die Sammlung verschiedener Werbe-IDs durch den SDK. wird unterdrückt. Dazu gehören Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID und Amazon Advertising ID (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Apple Search Ads-Zuschreibungen werden ausgeschlossen.

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

await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Einen benutzerdefinierten Host festlegen.

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

await AppsFlyer.setHost({} as AFHost);

generateInviteLink

Ermöglichen Sie Ihren bestehenden Benutzern, ihren Freunden und Kontakten als neuen Benutzer zu Ihrer App einzuladen

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

API für die Server-Überprüfung von In-App-Käufen. Ein af_purchase-Ereignis mit den relevanten Werten wird automatisch protokolliert, wenn die Überprüfung erfolgreich ist

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

await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);

validateAndLogInAppPurchaseIos

Siehe die Quelldefinitionen für den aktuellen Vertrag

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

await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Ermitteln Sie die AppsFlyer SDK-Version, die in der App verwendet wird

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

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

Aktivieren Sie die Sammlung von Facebook Deferred AppLinks. Erfordert Facebook SDK und Facebook-Anwendung auf Ziel-/Kunden-Endgerät. Diese API muss vor der Initialisierung der AppsFlyer SDK aufgerufen werden, um ordnungsgemäß zu funktionieren.

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Messung und Datenabruf aus Push-Benachrichtigungs-Kampagnen.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Setzen Sie die Sprache des Geräts. Die Daten werden in den Rohdatenberichten angezeigt.

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Loggt eine Eindruck als Teil einer Kreuzwerbung. Stellen Sie sicher, dass Sie die angezeigte Anwendungs-ID wie in der AppsFlyer-Dashboard verwenden.

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

await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Setzen Sie die Benutzer-E-Mail-Adressen und verschlüsseln Sie sie.

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Der Standort des Benutzers manuell protokollieren

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Wird als SHA-256 verschlüsselter String gesendet.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Zulässige Übertragung von benutzerdefinierten Daten für Partnerintegrationszwecke.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Verwenden Sie dies, um eine Benutzer-Einladungs-App-Event (af_invite) zu protokollieren.

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

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Verwenden Sie dies, um die Sammlung des Netzwerk-Operator-Namens (Carrier) und des SIM-Operator-Namens vom Gerät abzuschalten.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Verwenden Sie dies, um die automatische Sammlung von Zustimmungsdaten für Benutzer zu aktivieren/zu deaktivieren, die ein CMP verwenden.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Use this to set user consent data manually. If your app doesn’t use a CMP compatible with TCF v2.2, use the following method to manually provide the consent data directly to the SDK.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Durch die Zuweisung der Werbeeinnahmen erhalten die App-Besitzer einen umfassenden Überblick über die LTV der Benutzer und die ROI der Kampagnen. Die Werbeeinnahmen werden durch die Anzeige von Videos, Werbeanzeigen, interaktiven Werbeanzeigen und Bannern in einer App generiert. Mit dieser Methode können Sie Ihre Werbeeinnahmen protokollieren.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Verwenden Sie diese Methode, um die Benutzer-Einwilligungsdaten manuell zu setzen. Wenn Ihre App kein CMP verwendet, das mit TCF v2.2 kompatibel ist, verwenden Sie die folgende Methode, um die Einwilligungsdaten direkt an den SDK zu liefern.

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Verwenden Sie diese Methode, um zu überprüfen, ob der AppsFlyer SDK bereits in der aktuellen Sitzung gestartet wurde.

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

await AppsFlyer.isSDKStarted();

isSDKStopped

Verwenden Sie diese Methode, um zu überprüfen, ob der AppsFlyer SDK derzeit angehalten ist.

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Deaktiviert die Sammlung von AppSet-IDs. Wenn vor SDK initialisiert, wird die App-Set-ID nicht gesammelt. Wenn nach der Initialisierung aufgerufen, wird die App-Set-ID gesammelt, aber nicht in den Anforderungspayloads gesendet. Nur für Android.

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

await AppsFlyer.disableAppSetId();

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 Überprüfung erfolgreich ist.

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

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run the sync when the public API changes upstream.