Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Werkzeug mit der folgenden Befehlszeile hinzu:

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 unten aufgeführten Plattform-spezifischen Anweisungen 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';

Übersicht über API

initSDK

Verwenden Sie diese Methode, um AppsFlyer zu initialisieren und zu starten SDK. Diese API sollte sofort nach dem App-Start aufgerufen werden.

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

const result = await AppsFlyer.initSDK({
  devKey: 'dev-key-123',
  appID: 'app-id-123',
});
console.log(result);

startSDK

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

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

const result = await AppsFlyer.startSDK();
console.log(result);

logEvent

Ein Ereignis im App anlegen.

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

const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);

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 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({ cuid: 'cuid' });

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({ currencyCode: 'USD' });

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({ token: 'token-123' });

setAppInviteOneLink

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

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

await AppsFlyer.setAppInviteOneLink({ onelinkID: 'onelink-id-123' });

setOneLinkCustomDomain

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

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

await AppsFlyer.setOneLinkCustomDomain({ domains: ['example.com'] });

appendParametersToDeepLinkingURL

Aktiviert die Zuschreibung 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 dem Parameter-Map.

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

await AppsFlyer.appendParametersToDeepLinkingURL({
  contains: 'contains',
  parameters: {},
});

setResolveDeepLinkURLs

Verwenden Sie dies, wenn ein AppsFlyer OneLink innerhalb eines anderen Universal Links eingeschlossen ist. Es ermöglicht es der SDK, die umschlossene URL zu lösen, sodass die tiefere Verlinkung noch richtig funktioniert.

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

await AppsFlyer.setResolveDeepLinkURLs({ urls: ['https://example.com'] });

addPushNotificationDeepLinkPath

Konfiguriert, wie die SDK Werte für tiefere Verlinkungen aus Push-Benachrichtigungs-Payloads extrahiert.

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

await AppsFlyer.addPushNotificationDeepLinkPath({ path: ['path/to/file'] });

setSharingFilter

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

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

await AppsFlyer.setSharingFilter({ filters: ['filter'] });

setSharingFilterForAllPartners

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

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Unterbindet Ereignisse, die an die angegebenen AppsFlyer-Partner weitergeleitet werden.

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

await AppsFlyer.setSharingFilterForPartners({ filters: ['filter'] });

setAdditionalData

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

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

await AppsFlyer.setAdditionalData({ additionalData: {} });

getAppsFlyerUID

AppsFlyer-UID für das Gerät abrufen (erstellt für jede neue Installation einer App).

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

const result = await AppsFlyer.getAppsFlyerUID();
console.log(result);

anonymizeUser

Benutzerdaten anonymisieren (End User Opt-Out von AppsFlyer-Analysen).

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

await AppsFlyer.anonymizeUser({ anonymizeUser: true });

stop

Wenn diese API ausgelöst wird, kommuniziert unsere SDK nicht mehr mit unseren Servern und funktioniert nicht mehr.

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

const result = await AppsFlyer.stop();
console.log(result);

disableSKAdNetwork

SKAdNetwork deaktivieren

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

await AppsFlyer.disableSKAdNetwork({ shouldDisable: true });

disableAdvertisingIdentifier

Deaktiviert die Erfassung verschiedener Werbe-IDs durch das 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({ shouldDisable: true });

disableCollectASA

Deaktiviert die Zuschreibung von Apple Search Ads.

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

await AppsFlyer.disableCollectASA({ shouldDisable: true });

setHost

Ein benutzerdefinierten Host einrichten.

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

await AppsFlyer.setHost({
  hostPrefixName: 'host-prefix',
  hostName: 'host',
});

generateInviteLink

Erwähnen Sie Ihre bestehenden Benutzer, die ihre Freunde und Kontakte als neue Benutzer zu Ihrer App einladen können.

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

const result = await AppsFlyer.generateInviteLink({ brandDomain: 'example.com' });
console.log(result);

validateAndLogInAppPurchaseAndroid

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

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

const result = await AppsFlyer.validateAndLogInAppPurchaseAndroid({
  currency: 'USD',
  publicKey: 'public-key-123',
  signature: 'signature',
  purchaseData: 'purchase-data',
  price: 'price',
});
console.log(result);

validateAndLogInAppPurchaseIos

Siehe die Quelldefinitionen für den aktuellen Vertrag.

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

const result = await AppsFlyer.validateAndLogInAppPurchaseIos({
  currency: 'USD',
  inAppPurchase: 'in-app-purchase',
  price: 'price',
  transactionId: 'transaction-id-123',
});
console.log(result);

getSdkVersion

Get the AppsFlyer SDK version used in app.

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

const result = await AppsFlyer.getSdkVersion();
console.log(result);

enableFacebookDeferredApplinks

Aktivieren Sie die Sammlung von Facebook Deferred AppLinks. Erfordert Facebook SDK und Facebook-App auf Zielgerät/Clientgerät. Diese API muss vor der Initialisierung der AppsFlyer SDK ausgeführt werden, um ordnungsgemäß zu funktionieren.

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

const result = await AppsFlyer.enableFacebookDeferredApplinks({ enableFacebookDAL: true });
console.log(result);

sendPushNotificationData

Messung und Datenabruf aus Push-Benachrichtigungs-Kampagnen.

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

await AppsFlyer.sendPushNotificationData({ pushPayload: {} });

setCurrentDeviceLanguage

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

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

const result = await AppsFlyer.setCurrentDeviceLanguage({ language: 'en-US' });
console.log(result);

logCrossPromoteImpression

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

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

const result = await AppsFlyer.logCrossPromoteImpression({
  appID: 'app-id-123',
  campaign: 'campaign',
  parameters: {},
});
console.log(result);

setUserEmails

E-Mail-Adressen der Benutzer setzen und verschlüsseln.

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

const result = await AppsFlyer.setUserEmails({ emails: ['user@example.com'] });
console.log(result);

logLocation

Der Standort des Benutzers manuell protokollieren

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

const result = await AppsFlyer.logLocation({
  latitude: 48.8566,
  longitude: 2.3522,
});
console.log(result);

setPhoneNumber

Wird als SHA-256-verschlüsselter String gesendet.

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

const result = await AppsFlyer.setPhoneNumber({ phone: '+15555550123' });
console.log(result);

setPartnerData

Ermöglicht das Senden von benutzerdefinierten Daten für Zwecke der Partnerintegration.

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

const result = await AppsFlyer.setPartnerData({
  data: {},
  partnerId: 'partner-id-123',
});
console.log(result);

logInvite

Use to log a user-invite in-app event (af_invite).

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

const result = await AppsFlyer.logInvite({
  eventParameters: {},
  channel: 'channel',
});
console.log(result);

setDisableNetworkData

Verwenden Sie dies, um das Sammeln der Netzwerk-Operator-Name (Carrier) und des SIM-Operator-Name von der Geräte zu deaktivieren.

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

await AppsFlyer.setDisableNetworkData({ shouldDisable: true });

enableTCFDataCollection

Benutzen Sie dies, um das automatische Sammeln von Zustimmungsdaten für Benutzer zu aktivieren/zu deaktivieren, die ein CMP verwenden. Flag-Wert wird zwischen Anwendungs-Sitzungen gespeichert.

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

await AppsFlyer.enableTCFDataCollection({ shouldEnableTCFDataCollection: true });

setConsentData

Verwenden Sie diesen, um die Benutzerinformedezustimmungsdaten 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.setConsentData({ data: { isUserSubjectToGDPR: true } });

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 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, MediationNetwork } from '@capgo/capacitor-appsflyer';

await AppsFlyer.logAdRevenue({
  monetizationNetwork: 'monetization-network',
  mediationNetwork: MediationNetwork.IRONSOURCE,
  currencyIso4217Code: 'USD',
  revenue: 1,
});

setConsentDataV2

Verwenden Sie diesen, um die Benutzerinformedezustimmungsdaten 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({
  isUserSubjectToGDPR: true,
  hasConsentForDataUsage: true,
  hasConsentForAdsPersonalization: true,
  hasConsentForAdStorage: true,
});

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

const result = await AppsFlyer.isSDKStarted();
console.log(result);

isSDKStopped

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

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

const result = await AppsFlyer.isSDKStopped();
console.log(result);

disableAppSetId

App-Set-ID-Sammlung deaktiviert. Wenn diese Funktion vor der SDK-Initialisierung aufgerufen wird, wird die App-Set-ID nicht gesammelt. Wenn sie nach der Initialisierung aufgerufen wird, wird die App-Set-ID gesammelt, aber nicht in den Anforderungspayloads gesendet. (Android nur).

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, AFPurchaseType } from '@capgo/capacitor-appsflyer';

const result = await AppsFlyer.validateAndLogInAppPurchaseV2({
  purchaseDetails: {
    purchaseType: AFPurchaseType.oneTimePurchase,
    purchaseToken: 'purchase-token-123',
    productId: 'product-id-123',
  },
});
console.log(result);

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Fortsetzen von Getting Started

Wenn Sie Getting Started verwenden Getting Started um das Dashboard und API-Operationen 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üsseln und Geräte Für die Implementierungsdetails in Geräten.