Einstieg

Installieren

bun add @capgo/capacitor-appsflyer
bunx cap sync

Importieren

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

Rufen Sie diese Methode auf, um AppsFlyer SDK zu initialisieren und zu starten. Diese API sollte so schnell wie möglich nach dem Start des Apps aufgerufen werden.

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

await AppsFlyer.initSDK({} as AFInit);

startSDK

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

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

await AppsFlyer.startSDK();

logEvent

Ereignisse in der App protokollieren.

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

await AppsFlyer.logEvent({} as AFEvent);

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 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 ein.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Übertrage GCM/FCM-Tokens auf Android oder APNs-Tokens auf iOS, wenn ein anderes Plugin sie gesammelt hat. Verwende dies, um Entfernungsmessungstoken an AppsFlyer weiterzuleiten.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

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

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Registriere benutzerdefinierte OneLink-Domains, damit AppsFlyer die in kurzen Links versteckten Attribuierungsparameter auflösen kann.

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Aktiviere die Attribution für App-Links-Deep-Links ohne OneLink. Rufe diese Methode vorher startSDK()auf. pid und is_retargeting=true in der Parameterkarte.

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Verwenden Sie dies, wenn eine AppsFlyer OneLink innerhalb einer anderen Universal Link eingeschlossen ist. Es ermöglicht es der SDK , die eingeschlossene URL so tief zu verlinken, dass die Verlinkung noch richtig funktioniert.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

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

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Unterbindet die Weitergabe von Ereignissen an die angegebenen AppsFlyer-Partner.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Unterdrückt Ereignisse, die an alle AppsFlyer-Partner weitergeleitet werden. Überschreibt 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

Ermittelt die einzigartige Gerätekennung von AppsFlyer (erstellt für jeden neuen Installationsvorgang einer App).

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

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

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

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Sobald dieser API aufgerufen wird, kommuniziert unsere SDK nicht mehr mit unseren Servern und funktioniert nicht mehr. Zu empfehlen, wenn Sie die Implementierung von Benutzer-Opt-in/Opt-out durchführen.

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

await AppsFlyer.stop();

disableSKAdNetwork

Opt-out von SKAdNetwork

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Deaktiviert die Sammlung verschiedener Werbe-IDs durch die SDK. 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

Opt-out von Attributen für Apple Search Ads.

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

Auf die Zwischenablage kopieren

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

API for server verification of in-app purchases. An af_purchase event with the relevant values will be automatically logged if the validation is successful.

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

Enable the collection of Facebook Deferred AppLinks. Requires Facebook SDK and Facebook app on target/client device. This API must be invoked before initializing the AppsFlyer SDK in order to function properly.

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Abschnitt mit dem Titel “sendPushNotificationData”

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Die Sprache der Geräte einstellen. Die Daten werden in den Rohdatenberichten angezeigt

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Ein Eindruck als Teil einer Kreuzwerbungs-Kampagne protokolliert. Stellen Sie sicher, dass Sie die ID der beworbenen App verwenden, wie sie in der AppsFlyer-Dashboard angezeigt wird

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

await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Die Benutzer-E-Mail-Adressen setzen und sie verschlüsseln

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Die Standortdaten des Benutzers manuell protokollieren

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Als SHA-256-geschützter String gesendet.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Zurücklieferung von benutzerdefinierten Daten für die Partnerintegration.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Zur Protokollierung eines Benutzer-Invites (af_invite) verwenden.

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

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Zur Deaktivierung der Erfassung des Netzwerk-Netzbetreiber- und SIM-Netzbetreiber-Namens vom Gerät verwenden.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Verwenden Sie dies, um sich für/aus die automatische Erfassung von Zustimmungsdaten anzumelden, für Benutzer, 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

Zwischenablage

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

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.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Verwenden Sie diese Methode, um zu überprüfen, ob die 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 die AppsFlyer SDK derzeit angehalten ist.

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Die Sammlung von AppSet-IDs deaktiviert. 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 Anforderungspayloads gesendet. (Android nur)

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

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API für die Serververifizierung von In-App-Käufen V2. Wenn die Validierung erfolgreich ist, wird ein af_purchase-Ereignis mit den relevanten Werten automatisch protokolliert.

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 die Synchronisation, wenn die öffentliche API upstream geändert wird.