AppsFlyer plugin Capacitor

Uso de @capgo/capacitor-appsflyer

Plugin de Capacitor para atribución, analytics y deep links de AppsFlyer.

Instalar

bun add @capgo/capacitor-appsflyer
bunx cap sync

bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.

Importar

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

API de un vistazo

Método	Descripción
initSDK	Usa este método para inicializar y arrancar el SDK de AppsFlyer. Este API debe llamarse en cuanto se inicie la app.
startSDK	Usa este método para arrancar el SDK de AppsFlyer, solo en modo de inicio manual.
logEvent	Registra un evento in-app.
setCustomerUserId	Configurar tu propio customer ID te permite cruzar tu ID único con el ID único de AppsFlyer y con los IDs de otros dispositivos. Este ID está disponible en los informes de raw data y en las Postback APIs para cruzarlo con tus IDs internos.
setCurrencyCode	Establece la moneda para las compras in-app. La moneda code debe ser un código ISO 4217 de 3 caracteres code.
updateServerUninstallToken	(Android) Permite enviar al servidor de AppsFlyer los tokens GCM/FCM recopilados por plugins de terceros. Puede usarse para el log de desinstalaciones. (iOS) Permite enviar al servidor de AppsFlyer los tokens APN recopilados por plugins de terceros. Puede usarse para el log de desinstalaciones.
setAppInviteOneLink	Configura el OneLink ID para la atribución de invitaciones de usuario. El enlace generado para la invitación usará este OneLink como base.
setOneLinkCustomDomain	Para que el SDK de AppsFlyer resuelva correctamente los parámetros de atribución ocultos (decodificados en el ID del shortlink), se debe proporcionar a este método cualquier dominio configurado como dominio de marca en el AppsFlyer Dashboard.
appendParametersToDeepLinkingURL	Permite que los dueños de apps que usan App Links para deep linking (sin OneLink) atribuyan sesiones iniciadas mediante un dominio asociado a su app. Llama a este método antes de start. Debes incluir estos parámetros en el Map: pid e is_retargeting debe ser true.
setResolveDeepLinkURLs	Los anunciantes pueden envolver un AppsFlyer OneLink dentro de otro Universal Link. Este Universal Link abrirá la app, pero los datos de deep linking no llegarán a AppsFlyer. setResolveDeepLinkURLs permite configurar el SDK para resolver las URLs de OneLink y que el deep linking funcione correctamente.
addPushNotificationDeepLinkPath	Configura cómo SDK extrae los valores de deep link de los payloads de las notificaciones push.
setSharingFilter	Evita que los eventos se propaguen a los partners de AppsFlyer especificados.
setSharingFilterForAllPartners	Detiene la propagación de eventos a todos los partners de AppsFlyer. Sobrescribe setSharingFilter.
setSharingFilterForPartners	Evita que los eventos se propaguen a los partners de AppsFlyer especificados.
setAdditionalData	Establece datos adicionales para enviar a AppsFlyer. Ver.
getAppsFlyerUID	Obtiene el ID de dispositivo único de AppsFlyer (creado para cada nueva instalación de una app).
anonymizeUser	Opt-out del usuario para la analítica de AppsFlyer (anonimizar datos de usuario).
stop	Una vez invocado este API, nuestro SDK dejará de comunicarse con nuestros servidores y dejará de funcionar. Útil al implementar el opt-in/opt-out del usuario.
disableSKAdNetwork	Opt-out de SKAdNetwork.
disableAdvertisingIdentifier	Desactiva la recopilación de diversos IDs de publicidad por parte de SDK. Esto incluye Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID y Amazon Advertising ID (AAID).
disableCollectASA	Excluir las atribuciones de Apple Search Ads.
setHost	Configurar un host personalizado.
generateInviteLink	Permite que tus usuarios actuales inviten a amigos y contactos como nuevos usuarios de tu app.
validateAndLogInAppPurchaseAndroid	API para la verificación en servidor de compras in-app. Se registrará automáticamente un evento af_purchase con los valores correspondientes si la validación es exitosa.
validateAndLogInAppPurchaseIos	Consulta las definiciones de origen para ver el comportamiento actual.
getSdkVersion	Obtén la versión de SDK de AppsFlyer usada en la app.
enableFacebookDeferredApplinks	Habilita la recopilación de Facebook Deferred AppLinks. Requiere Facebook SDK y la app de Facebook en el dispositivo. Este API debe invocarse antes de inicializar el SDK de AppsFlyer para funcionar correctamente.
sendPushNotificationData	Mide y obtén datos de campañas de push-notifications.
setCurrentDeviceLanguage	Establece el idioma del dispositivo. Los datos se mostrarán en los Raw Data Reports.
logCrossPromoteImpression	registra una impresión como parte de una campaña de cross-promotion. Asegúrate de usar el App ID promocionado tal como aparece en el dashboard de AppsFlyer.
setUserEmails	Configura los emails de usuario y encriptalos.
logLocation	Registra manualmente la ubicación del usuario.
setPhoneNumber	Se enviará como un string encriptado con SHA-256.
setPartnerData	Permite enviar datos personalizados para integraciones con partners.
logInvite	Úsalo para registrar el evento in-app de invitación de usuario (af_invite).
setDisableNetworkData	Úsalo para desactivar la recolección del nombre del operador de red (carrier) y del operador SIM del dispositivo.
enableTCFDataCollection	Úsalo para activar/desactivar la recolección automática de datos de consentimiento para usuarios que usan una CMP. El valor del flag se mantendrá entre sesiones de la app.
setConsentData	Úsalo para configurar los datos de consentimiento del usuario manualmente. Si tu app no usa un CMP compatible con TCF v2.2, usa este método para enviar los datos de consentimiento directamente a SDK.
logAdRevenue	Al atribuir ingresos publicitarios, los propietarios de apps obtienen una visión completa del LTV de los usuarios y el ROI de las campañas. Los ingresos publicitarios se generan mostrando anuncios en videos recompensados, offer walls, intersticiales y banners dentro de una app. Usa este método para registrar tus ingresos publicitarios.
setConsentDataV2	Úsalo para configurar los datos de consentimiento del usuario manualmente. Si tu app no usa un CMP compatible con TCF v2.2, usa este método para enviar los datos de consentimiento directamente a SDK.
isSDKStarted	Usa este método para verificar si el SDK de AppsFlyer ya se ha iniciado en la sesión actual.
isSDKStopped	Usa este método para verificar si el SDK de AppsFlyer está detenido actualmente.
disableAppSetId	Desactiva la recopilación del AppSet ID. Si se llama antes del init de SDK, no se recopilará el App Set ID. Si se llama después del init, se recopilará pero no se enviará en el payload de las peticiones. Solo Android.
validateAndLogInAppPurchaseV2	API para la verificación en el servidor de compras in-app V2. Se registrará automáticamente un evento af_purchase con los valores pertinentes si la validación es exitosa.

Ejemplos

initSDK()

Usa este método para inicializar y arrancar el SDK de AppsFlyer. Este API debe llamarse en cuanto se inicie la app.

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

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

startSDK()

Usa este método para arrancar el SDK de AppsFlyer, solo en modo de inicio manual.

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

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

logEvent()

Registra un evento in-app.

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

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

setCustomerUserId()

Configurar tu propio customer ID te permite cruzar tu ID único con el ID único de AppsFlyer y con los IDs de otros dispositivos. Este ID está disponible en los informes de raw data y en las Postback APIs para cruzarlo con tus IDs internos.

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

await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });

setCurrencyCode()

Establece la moneda para las compras in-app. La moneda code debe ser un código ISO 4217 de 3 caracteres code.

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

await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });

updateServerUninstallToken()

(Android) Permite enviar al servidor de AppsFlyer los tokens GCM/FCM recopilados por plugins de terceros. Puede usarse para el log de desinstalaciones. (iOS) Permite enviar al servidor de AppsFlyer los tokens APN recopilados por plugins de terceros. Puede usarse para el log de desinstalaciones.

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

await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });

La tabla anterior enumera los 44 métodos principales. Los helpers de listener y de versión, y el contrato completo de cada método, están documentados en repositorio GitHub.

Escuchar eventos

addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonta.

Referencia completa

• repositorio GitHub
• Documentación
• Referencia de API

Continúa desde Uso de @capgo/capacitor-appsflyer

Si estás usando Uso de @capgo/capacitor-appsflyer para planificar el trabajo con plugins nativos, conéctalo con @capgo/capacitor-appsflyer para el detalle de implementación en @capgo/capacitor-appsflyer, Primeros pasos para los detalles de implementación en Primeros pasos, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para los detalles de implementación en Capacitor Plugins de Capgo, y Añadir o actualizar plugins para los detalles de implementación al añadir o actualizar plugins.