Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um den Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie den folgenden Befehl ausführen:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Verwenden Sie dann den folgenden Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten aufgeführten plattform-spezifischen Anweisungen:

bun add @capgo/capacitor-appsflyer
bunx cap sync

Import

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

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

Setzt die OneLink-ID, die als Basis-Link für die Zuschreibung von Einladungen verwendet wird.

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

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

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Aktiviert die Zuschreibung für App-Links-Deep-Links ohne OneLink. Rufen Sie diese Methode vorher auf startSDK()Zumindest pid und is_retargeting=true in der Parameterkarte.

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 das SDK die umschlossene URL so tief einbinden, dass die Einbindung noch richtig funktioniert.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Konfiguriert, wie das SDK Werte aus den Payloads von 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

Unterbindet die Weitergabe von Ereignissen an alle AppsFlyer-Partner. Überschreibt setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

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

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Setzt zusätzliche Schlüssel-Wert-Daten zum Senden an AppsFlyer.

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

await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

Holt 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-Analytics (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 Zustimmung oder Ablehnung des Benutzers implementieren möchten.

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

await AppsFlyer.stop();

disableSKAdNetwork

SKAdNetwork-Ablehnung

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Die Sammlung verschiedener Werbe-IDs durch das SDK wird deaktiviert. Dazu gehören der Apple-Identity-for-Advertisers (IDFA), der Google-Advertising-Id (GAID), OAID und Amazon Advertising-Id (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Ablehnung der Apple Search Ads-Zuschreibungen.

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 Quellendefinitionen 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-App auf Ziel-/Client-Gerät. Diese API muss vor der Initialisierung der AppsFlyer SDK aufgerufen werden, um richtig 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

Legen Sie die Sprache des Geräts fest. Die Daten werden in den Raw Data Reports angezeigt.

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Ein Eindruck als Teil einer Cross-Promotion-Kampagne protokollieren. Stellen Sie sicher, dass Sie die ID der beworbenen App verwenden, wie sie in der AppsFlyer-Dashboard-Ansicht erscheint.

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

Zur Übermittlung von benutzerdefinierten Daten für die Zwecke der Partnerintegration verwendet.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Zur Protokollierung eines Benutzer-Einladungsereignisses im App (af_invite) verwendet.

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

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Zur Deaktivierung der Erfassung des Netzwerk- und SIM-Netzbetreiber-Names vom Gerät verwendet.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Zur Aktivierung/Deaktivierung der automatischen Erfassung von Zustimmungsdaten, für Benutzer, die ein CMP verwenden.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Verwenden Sie diesen, um die Zustimmungsdaten des Benutzers manuell zu setzen. Wenn Ihre App kein CMP verwendet, das mit TCF v2.2 kompatibel ist, verwenden Sie den folgenden Methoden, um die Zustimmungsdaten direkt an die SDK zu liefern.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Durch die Zuweisung von Werbeeinnahmen erhalten App-Besitzer einen umfassenden Überblick über die Nutzergesamtwert und die Kampagnen-ROI. Die Werbeeinnahmen werden durch die Anzeige von Werbung auf belohnten Videos, Angebotswänden, Interstitiellen und Bannern in einer App generiert. Sie können diese Methode verwenden, um Ihre Werbeeinnahmen zu protokollieren.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Verwenden Sie diesen, um die Zustimmungsdaten des Benutzers manuell zu setzen. Wenn Ihre App kein CMP verwendet, das mit TCF v2.2 kompatibel ist, verwenden Sie den folgenden Methoden, um die Zustimmungsdaten direkt an die SDK zu liefern.

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

App-Set-ID-Kollektion deaktivieren. Wenn diese Methode vor der SDK-Initialisierung aufgerufen wird, wird die App-Set-ID nicht gesammelt. Wenn diese Methode nach der Initialisierung aufgerufen wird, wird die App-Set-ID gesammelt, aber nicht in Anfrage-Payloads gesendet. Nur für Android.

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

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API für die Server-Verifizierung 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);

Abschnitt mit dem Titel „Quelle der Wahrheit“

Diese Seite wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Hintergrund ändert, führen Sie die Synchronisierung erneut durch.

Weitergehen von Getting Started

Wenn Sie " Getting Started " zum Planen von Dashboard und API-Operationen verwenden, verbinden Sie es mit Mit @capgo/capacitor-appsflyer für die native Fähigkeit in Mit @capgo/capacitor-appsflyer, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.