Guía
Cómo usar AppsFlyer en Capacitor
Usando @capgo/capacitor-appsflyer
Capacitor plugin para atribución, análisis y enlaces profundos de AppsFlyer
Instalar
bun add @capgo/capacitor-appsflyer
bunx cap sync
bunx cap sync copia el plugin nativo code en tus proyectos nativos. Ejecútalo de nuevo después de cada actualización del plugin.
Importar
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
API a la vista
| Método | Descripción |
|---|---|
initSDK |
Use este método para inicializar y iniciar AppsFlyer SDK. Este API debe llamarse tan pronto como se lance la aplicación. |
startSDK |
Use este método para iniciar AppsFlyer SDK, solo en modo de inicio manual. |
logEvent |
Registra un evento en la aplicación. |
setCustomerUserId |
Establecer su propio ID de cliente le permite cruzarreferenciar su propio ID único con el ID único de AppsFlyer y otros IDs de dispositivos. Este ID está disponible en informes de datos brutos y en las API de postback para cruzarreferenciar con sus IDs internos. |
setCurrencyCode |
Establece la moneda para compras en la aplicación. La moneda code debe ser un código ISO 4217 de 3 caracteres code. |
updateServerUninstallToken |
(Android) Permite pasar tokens de GCM/FCM que se recopilaron mediante plugins de terceros al servidor de AppsFlyer. Se puede utilizar para el registro de desinstalación. (iOS) Permite pasar tokens de APN que se recopilaron mediante plugins de terceros al servidor de AppsFlyer. Se puede utilizar para el registro de desinstalación. |
setAppInviteOneLink |
Establezca el ID de OneLink que se debe utilizar para atribuir invitaciones de usuario. El enlace que se genere para la invitación del usuario utilizará este OneLink como enlace base. |
setOneLinkCustomDomain |
Para que AppsFlyer SDK resuelva con éxito los parámetros de atribución ocultos (descompuestos en el ID de enlace corto), se debe proporcionar a este método cualquier dominio que esté configurado como dominio de marca en la consola de AppsFlyer. |
appendParametersToDeepLinkingURL |
Activa a los propietarios de aplicaciones que utilizan App Links para enlazar en profundidad (sin OneLink) para atribuir sesiones iniciadas a través de un dominio asociado con su aplicación. Llame a este método antes de llamar a start. Debe proporcionar los siguientes parámetros en el mapa de parámetros: pid es_retargeting debe estar configurado en true. |
setResolveDeepLinkURLs |
Los anunciantes pueden envolver una AppsFlyer OneLink dentro de otra Universal Link. Esta Universal Link invocará la aplicación, pero cualquier dato de enlace en profundidad no se propagará a AppsFlyer. setResolveDeepLinkURLs le permite configurar el SDK para resolver las URLs de la OneLink envuelta, de modo que el enlace en profundidad pueda ocurrir correctamente. |
addPushNotificationDeepLinkPath |
Configura cómo el SDK extrae valores de enlaces profundos de payloads de notificaciones push. |
setSharingFilter |
Detiene los eventos de propagación a los socios de AppsFlyer especificados. |
setSharingFilterForAllPartners |
Detiene los eventos de propagación a todos los socios de AppsFlyer. Sobreescribe setSharingFilter. |
setSharingFilterForPartners |
Detiene los eventos de propagación a los socios de AppsFlyer especificados. |
setAdditionalData |
Establece datos adicionales para enviar a AppsFlyer. Consulte. |
getAppsFlyerUID |
Obtenga el ID de dispositivo único de AppsFlyer (creado para cada nueva instalación de una aplicación). |
anonymizeUser |
Opt-out de los datos de usuario de AppsFlyer (Anonimizar datos de usuario). |
stop |
Una vez que se invoque este API, nuestro SDK ya no se comunica con nuestros servidores y deja de funcionar. Útil al implementar la opt-in/opt-out de los usuarios. |
disableSKAdNetwork |
Opt-out de SKAdNetwork. |
disableAdvertisingIdentifier |
Deshabilita la recopilación de diversas Identificaciones de Publicidad por parte del SDK. Esto incluye Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID y Amazon Advertising ID (AAID). |
disableCollectASA |
Opt-out de las atribuciones de Apple Search Ads. |
setHost |
Establecer un host personalizado. |
generateInviteLink |
Permitir a sus usuarios existentes invitar a sus amigos y contactos como nuevos usuarios a su aplicación. |
validateAndLogInAppPurchaseAndroid |
API para la verificación del servidor de compras en la aplicación. Se registrará automáticamente un evento af_purchase con los valores relevantes si la validación es exitosa. |
validateAndLogInAppPurchaseIos |
Consulte las definiciones de origen para el comportamiento actual. |
getSdkVersion |
Obtenga la versión de AppsFlyer SDK utilizada en la aplicación. |
enableFacebookDeferredApplinks |
Habilite la recopilación de Facebook Deferred AppLinks. Requiere Facebook SDK y la aplicación de Facebook en el dispositivo objetivo/cliente. Este API debe invocarse antes de inicializar la instancia de AppsFlyer SDK para funcionar correctamente. |
sendPushNotificationData |
Medir y obtener datos de las campañas de notificaciones push. |
setCurrentDeviceLanguage |
Establecer el idioma del dispositivo. Los datos se mostrarán en los Informes de datos brutos. |
logCrossPromoteImpression |
registra una impresión como parte de una campaña de promoción cruzada. Asegúrese de utilizar el ID de aplicación promocionado tal como aparece dentro de la consola de AppsFlyer. |
setUserEmails |
Set the user emails and encrypt them. |
logLocation |
Registrar manualmente la ubicación del usuario. |
setPhoneNumber |
Se enviará como una cadena cifrada con SHA-256. |
setPartnerData |
Permite enviar datos personalizados para fines de integración de socios. |
logInvite |
Use to log a user-invite in-app event (af_invite). |
setDisableNetworkData |
Use para desactivar la recopilación del nombre del operador de red (carrier) y el nombre del operador SIM del dispositivo. |
enableTCFDataCollection |
Use para activar/desactivar 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. |
setConsentData |
Use 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. |
logAdRevenue |
Al atribuir los ingresos publicitarios, los propietarios de la aplicación obtienen una visión completa del LTV del usuario y el ROI de la campaña. Los ingresos publicitarios se generan al mostrar anuncios en videos recompensados, paredes de ofertas, intersticiales y banners en una aplicación. Puede utilizar este método para registrar sus ingresos publicitarios. |
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 al SDK. |
isSDKStarted |
Use este método para verificar si el SDK de AppsFlyer ya ha sido iniciado en la sesión actual. |
isSDKStopped |
Use este método para verificar si el SDK de AppsFlyer está actualmente detenido. |
disableAppSetId |
Desactiva la recopilación de ID de AppSet. Si se llama antes de la inicialización de SDK, el ID de App Set no se recopilará. Si se llama después de la inicialización, el ID de App Set se recopilará pero no se enviará en los payloads de solicitud. Solo para Android. |
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. |
Ejemplos
initSDK()
Utilice este método para inicializar y iniciar AppsFlyer SDK. Este API debe llamarse tan pronto como se lance la aplicación.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.initSDK({
devKey: 'dev-key-123',
appID: 'app-id-123',
});
console.log(result);
startSDK()
Utilice este método para iniciar AppsFlyer SDK, solo en modo de inicio manual.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();
console.log(result);
logEvent()
Registre un evento en la aplicación.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });
console.log(result);
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({ cuid: 'cuid' });
setCurrencyCode()
Establece la moneda para compras en la aplicación. La moneda code debe ser un código de moneda ISO 4217 de 3 caracteres code.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });
updateServerUninstallToken()
(Android) Allows to pass GCM/FCM Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall log. (iOS) Allows to pass APN Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for log Uninstall.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });
La tabla anterior muestra los 44 métodos básicos. Los ayudantes de escucha y versión, y el contrato completo de cada método, se documentan en el repositorio de GitHub.
Escuchar eventos
addListener devuelve un manejador. Llame handle.remove() cuando la pantalla se desmonta.
Referencia completa
Sigue adelante desde el uso de @capgo/capacitor-appsflyer
Si estás utilizando Usando @capgo/capacitor-appsflyer para planificar el trabajo de plugin nativo, conectarlo con @capgo/capacitor-appsFlyer para los detalles de implementación en @capgo/capacitor-appsflyer Getting Started para los detalles de implementación en Getting Started Capgo Directorio de Plugins para el flujo de trabajo del producto en Capgo Directorio de Plugins Capacitor Plugins por Capgo para los detalles de implementación en Capacitor Plugins por Capgo, y Agregar o Actualizar Plugins para los detalles de implementación en Agregar o Actualizar Plugins.