Iniciar

Instalar

bun add @capgo/capacitor-appsflyer
bunx cap sync

Importar

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 Resumen

initSDK

Utilice este método para inicializar y empezar a utilizar AppsFlyer SDK. Este API debe llamarse tan pronto como se lance la aplicación.

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

await AppsFlyer.initSDK({} as AFInit);

startSDK

Utilice este método para empezar a utilizar AppsFlyer SDK, solo en modo de inicio manual.

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

await AppsFlyer.startSDK();

logEvent

Registre un evento en la aplicación.

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

await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

Establecer su propio ID de cliente le permite cruzarreferenciar su propio ID único con el ID único de AppsFlyer y los IDs de otros dispositivos. Este ID está disponible en informes de datos brutos y en las API de Postback para cruzarreferenciar con sus IDs internos.

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

await AppsFlyer.setCustomerUserId({} as AFCuid);

setCurrencyCode

Establece la moneda utilizada para las compras en la aplicación. Proporcione un código de tres caracteres de ISO 4217 code.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Transmita tokens de GCM/FCM en Android o tokens APNs en iOS cuando otro plugin los haya recopilado. Utilice esto para enviar tokens de medición de desinstalación a AppsFlyer.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

Establece el ID de OneLink utilizado como enlace base para la atribución de invitaciones.

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Registra dominios personalizados de OneLink para que AppsFlyer pueda resolver parámetros de atribución ocultos en enlaces cortos.

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Habilita la atribución para enlaces de App Links profundos sin OneLink. Llame a este método antes de startSDK()Incluya al menos pid y is_retargeting=true en el mapa de parámetros.

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Use esto cuando un enlace de AppsFlyer OneLink esté envuelto en otro enlace Universal. Permite que el SDK resuelva la URL envuelta para que el enrutamiento profundo siga funcionando correctamente.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Configura cómo SDK extrae valores de enlaces profundos de los payloads de notificaciones push.

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Detiene eventos de propagarse a los socios de AppsFlyer especificados.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Detiene eventos de propagarse a todos los socios de AppsFlyer. Sobreescribe setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Detiene eventos de propagarse a los socios de AppsFlyer especificados.

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Establece datos clave-valor adicionales para enviar a AppsFlyer.

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

await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

Obtenga el ID único de dispositivo de AppsFlyer (creado para cada nueva instalación de una aplicación).

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

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

Opt-out del usuario de la analítica de AppsFlyer (anonymizar datos de usuario).

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Una vez que se invoca este API, nuestro SDK ya no se comunica con nuestros servidores y deja de funcionar. Útil al implementar la opt-in/opt-out del usuario.

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

await AppsFlyer.stop();

disableSKAdNetwork

Darse de baja en SKAdNetwork

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Deshabilita la recopilación de varios identificadores de publicidad por parte de SDK. Esto incluye Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID y Amazon Advertising ID (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Darse de baja en las atribuciones de Apple Search Ads.

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

await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Establecer un host personalizado.

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

await AppsFlyer.setHost({} as AFHost);

generateInviteLink

Permitir a sus usuarios existentes que inviten a sus amigos y contactos como nuevos usuarios a su aplicación

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

API para la verificación del servidor de compras en la aplicación. Si la validación es exitosa, se registrará automáticamente un evento af_purchase con los valores relevantes

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

await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);

validateAndLogInAppPurchaseIos

Consulte las definiciones de origen para el contrato actual

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

await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Obtenga la versión de SDK de AppsFlyer utilizada en la aplicación

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

Mida y obtenga datos de las campañas de notificaciones push.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Establezca el idioma del dispositivo. Los datos se mostrarán en Informes de Datos Brutos

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

logCrossPromoteImpression

Registre una impresión como parte de una campaña de promoción transversal. Asegúrese de utilizar el ID de la aplicación promocionada tal como aparece en la consola de AppsFlyer.

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

await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Establecer correos electrónicos del usuario y cifrarlos.

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Registrar manualmente la ubicación del usuario.

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Se enviará como una cadena cifrada SHA-256.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Permite enviar datos personalizados para fines de integración de socios.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Use para registrar un evento de invitación de usuario en la aplicación (af_invite).

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

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Use para excluir la recopilación del nombre del operador de red (carrier) y el nombre del operador SIM del dispositivo.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Use para habilitar/deshabilitar la recopilación automática de datos de consentimiento, para usuarios que utilizan un CMP. El valor de la bandera se persistirá entre sesiones de la aplicación.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Use este método para establecer los datos de consentimiento del usuario manualmente. Si su aplicación no utiliza un CMP compatible con TCF v2.2, utilice el siguiente método para proporcionar los datos de consentimiento directamente al SDK.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Al atribuir la renta publicitaria, los propietarios de la aplicación obtienen una visión completa del LTV del usuario y el ROI de la campaña. La renta publicitaria se genera al mostrar anuncios en videos recompensados, paredes de ofertas, intersticiales y banners en la aplicación. Puede utilizar este método para registrar su renta publicitaria.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Use este método para establecer los datos de consentimiento del usuario manualmente. Si su aplicación no utiliza un CMP compatible con TCF v2.2, utilice el siguiente método para proporcionar los datos de consentimiento directamente a la SDK.

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Use este método para verificar si el SDK de AppsFlyer ya ha sido iniciado en la sesión actual.

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

await AppsFlyer.isSDKStarted();

isSDKStopped

Use este método para verificar si el SDK de AppsFlyer está actualmente detenido.

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Deshabilita la recopilación de ID de AppSet. Si se llama antes de SDK init, el ID de AppSet no se recopilará. Si se llama después de init, el ID de AppSet se recopilará pero no se enviará en payloads de solicitud. Solo para Android.

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

await AppsFlyer.disableAppSetId();

validateAndLogInAppPurchaseV2

API para la verificación del servidor de compras en la aplicación V2. Se registrará automáticamente un evento af_purchase con los valores relevantes si la validación es exitosa.

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

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.ts. Re-ejecutar la sincronización cuando los cambios públicos API cambien en la fuente.