Einstieg

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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

Dann verwenden Sie die folgende Anfrage:

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 die Plattform-spezifischen Anweisungen unten befolgen:

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

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

Die Einstellung Ihres eigenen Kunden-IDs ermöglicht es Ihnen, Ihre eigene einzigartige ID mit der einzigartigen ID von AppsFlyer und den IDs anderer Geräte zu vergleichen. Diese ID ist in den Rohdatenberichten und in den Postback-APIs für das Vergleichen 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

Übermitteln Sie GCM/FCM-Tokens auf Android oder APNs-Tokens auf iOS, wenn ein anderer Plugin diese 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 benutzerdefinierte 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 context

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Use this when an AppsFlyer OneLink is wrapped inside another Universal Link. It lets the SDK resolve the wrapped URL so deep linking still works correctly.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Konfiguriert, wie SDK Werte aus den Push-Benachrichtigungs-Payloads 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. Übertrifft 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

AppsFlyers einzigartige Gerätekennung (erstellt für jeden neuen Installationsvorgang einer App) erhalten.

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

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

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

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Wenn dieser API aufgerufen wird, funktioniert unsere SDK nicht mehr mit unseren Servern und hört auf zu funktionieren. Zu empfehlen, wenn Benutzer-Opt-in/Opt-out implementiert wird.

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

await AppsFlyer.stop();

disableSKAdNetwork

SKAdNetwork ausschließen

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Die Sammlung verschiedener Werbe-IDs durch SDK wird deaktiviert. 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 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

Erstatten Sie Ihren bestehenden Benutzern die Möglichkeit, ihre Freunde und Kontakte als neue Benutzer zu Ihrem App einzuladen

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

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

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

Erhalten 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

Abschnitt mit dem Titel ‘setCurrentDeviceLanguage’

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Abschnitt mit dem Titel ‘logCrossPromoteImpression’

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

Ermöglicht das Senden von benutzerdefinierten Daten für Partner-Integration-Zwecke.

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 das Sammeln der Netzwerk-Operator-Name (Carrier) und SIM-Operator-Name vom Gerät auszuschließen.

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

Indem Sie Werbeeinnahmen zuordnen, erhalten die App-Besitzer einen umfassenden Überblick über die LTV der Benutzer und die ROI der Kampagnen. Die Werbeeinnahmen werden durch die Anzeige von Werbung in 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 diese Funktion, um die Benutzerdaten zur Zustimmung 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.

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

Deaktiviert die Sammlung von AppSet-IDs. Wenn dieser Aufruf vor der SDK-Initialisierung erfolgt, werden keine App-Set-IDs gesammelt. Wenn dieser Aufruf nach der Initialisierung erfolgt, werden App-Set-IDs 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 Serververifizierung von In-App-Käufen V2. Wenn die Validierung erfolgreich ist, wird automatisch ein af_purchase-Ereignis mit den relevanten Werten protokolliert.

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

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. Re-run die Synchronisierung, wenn die öffentliche __CAPGO_KEEP_0__-Version upstream geändert wurde. src/definitions.ts. Re-run the sync when the public API changes upstream.

Abschnitt mit dem Titel ‘Fortsetzung von Getting Started’

Wenn Sie AppsFlyer verwenden Einstieg um das Dashboard und die API-Funktionen zu planen, verbinden Sie es mit Verwendung von @capgo/capacitor-appsflyer für die native Fähigkeit in Verwendung von @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äten.