Anleitung zum Starten

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 die folgende Befehl ausführen:

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 folgen Sie den Plattform-spezifischen Anweisungen unten:

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 im manuellen Startmodus zu starten.

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

await AppsFlyer.startSDK();

logEvent

Ein Ereignis im App-Verlauf 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 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 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

Hindert Ereignisse daran, an die angegebenen AppsFlyer-Partner weitergeleitet zu werden.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Hindert Ereignisse daran, an alle AppsFlyer-Partner weitergeleitet zu werden. Überschreibt setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Hindert Ereignisse daran, an die angegebenen AppsFlyer-Partner weitergeleitet zu 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).

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, kommuniziert unsere SDK nicht mehr mit unseren Servern und funktioniert nicht mehr. Zu empfehlen, wenn Benutzer-Opt-in/Opt-out implementiert wird.

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

await AppsFlyer.stop();

disableSKAdNetwork

SKAdNetwork abschalten

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Die Sammlung verschiedener Werbeeinheits-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

Apple Search Ads-Zuschreibungen abschalten

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, ihre Freunde und Kontakte als neue 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

Facebook-Deferred-AppLinks aktivieren. Erfordert Facebook SDK und eine Facebook-App auf dem Ziel-/Kunden Gerät. Dieser 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

Push-Benachrichtigungs-Kampagnen messen und Daten abrufen.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Gerätesprache festlegen. Die Daten werden in den Raw Data Reports angezeigt.

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Eindrücke einer Kreuzwerbung protokollieren. Stellen Sie sicher, dass Sie die ID der beworbenen App 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

Ermöglicht die Übermittlung von benutzerdefinierten Daten für Partnerintegrationen.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Verwenden Sie dies, um eine Benutzer-Einladungs-In-App-Ereignis (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 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

Indem Sie Werbeeinnahmen zuordnen, erhalten die App-Eigentümer einen umfassenden Überblick über die Nutzer-LTV und die Kampagnen-ROI. 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 Methode, um die Nutzerwilligungsinformationen manuell zu setzen. Wenn Ihre App kein CMP verwendet, das mit TCF v2.2 kompatibel ist, verwenden Sie die folgende Methode, um die Nutzerwilligungsinformationen 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, werden aber nicht in den Anforderungspaketen 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. Ein af_purchase-Ereignis mit den relevanten Werten wird automatisch protokolliert, wenn die Validierung erfolgreich ist.

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__-API äußerst aufgerufen wird. src/definitions.ts. Re-run the sync when the public API changes upstream.

Abschnitt mit dem Titel ‘Fortsetzung von Getting Started’

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