Saltar al contenido

@capgo/capacitor-appsflyer

Añade atribución de AppsFlyer, analytics, deep links diferidos y soporte de OneLink a tu app Capacitor

Añade atribución de AppsFlyer, analytics, deep links diferidos y soporte de OneLink a tu app Capacitor

Empieza con initSDK() y los demás métodos principales detallados abajo.

PlataformaSoporteNotas
iOSSíNativo
AndroidSíNativo
WebNoProtege con Capacitor.getPlatform()
  • initSDK - Usa este método para inicializar e iniciar AppsFlyer SDK. Este API debe llamarse en cuanto se lance la app.
  • startSDK - Usa este método para iniciar AppsFlyer SDK, 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 reportes de raw-data y en las Postback APIs para cruzarlo con tus IDs internos.
MétodoDescripción
addListener('conversion_callback', listener)Escucha los callbacks de conversión, incluyendo onConversionDataSuccess y onConversionDataFail, con OnConversionDataResult payloads.
addListener('oaoa_callback', listener)Escucha los callbacks de atribución de app-open, incluyendo onAppOpenAttribution y onAttributionFailure, con OnAppOpenAttribution payloads.
addListener('udl_callback', listener)Escucha los callbacks unificados de deep links con OnDeepLink payloads.
initSDKUsa este método para inicializar y arrancar el SDK de AppsFlyer. Este API debe llamarse en cuanto se inicie la app.
startSDKUsa este método para arrancar el SDK de AppsFlyer, solo en modo de inicio manual.
logEventRegistra un evento in-app.
setCustomerUserIdConfigurar tu propio customer ID te permite cruzar tu ID único con el ID único de AppsFlyer y 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.
setCurrencyCodeEstablece la moneda usada en las compras in-app. Proporciona un code ISO 4217 de tres caracteres.
updateServerUninstallTokenPasa tokens GCM/FCM en Android o tokens APNs en iOS si otro plugin ya los recopiló. Úsalo para reenviar tokens de medición de desinstalación a AppsFlyer.
setAppInviteOneLinkEstablece el OneLink ID usado como link base para la atribución de invitaciones.
setOneLinkCustomDomainRegistra dominios OneLink de marca para que AppsFlyer pueda resolver los parámetros de atribución ocultos en los enlaces cortos.
appendParametersToDeepLinkingURLPermite la atribución de App Links deep links sin OneLink. Llama a este método antes de startSDK(). Incluye al menos pid y is_retargeting=true en el mapa de parámetros.
setResolveDeepLinkURLsÚsalo cuando un AppsFlyer OneLink esté dentro de otro Universal Link. Permite que el SDK resuelva la URL envuelta para que el deep linking siga funcionando correctamente.
addPushNotificationDeepLinkPathConfigura cómo SDK extrae los valores de deep link de los payloads de las notificaciones push.
setSharingFilterEvita que los eventos se propaguen a los partners de AppsFlyer especificados.
setSharingFilterForAllPartnersDetiene la propagación de eventos a todos los partners de AppsFlyer. Sobrescribe setSharingFilter.
setSharingFilterForPartnersEvita que los eventos se propaguen a los partners de AppsFlyer especificados.
setAdditionalDataEstablece datos adicionales de clave-valor que se envían a AppsFlyer.
getAppsFlyerUIDObtiene el ID de dispositivo único de AppsFlyer (creado en cada nueva instalación de la app).
anonymizeUserOpt-out del usuario final para la analítica de AppsFlyer (anonimizar datos de usuario).
stopUna vez que se invoca este API, nuestro SDK deja de comunicarse con nuestros servidores y deja de funcionar. Útil al implementar el opt-in/opt-out del usuario.
disableSKAdNetworkExcluir de SKAdNetwork.
disableAdvertisingIdentifierDesactiva 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).
disableCollectASAExcluir de las atribuciones de Apple Search Ads.
setHostConfigurar un host personalizado.
generateInviteLinkPermite que tus usuarios actuales inviten a amigos y contactos como nuevos usuarios de tu app.
validateAndLogInAppPurchaseAndroidAPI 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.
validateAndLogInAppPurchaseIosConsulta las definiciones de origen para ver el comportamiento actual.
getSdkVersionObtén la versión de SDK de AppsFlyer usada en la app.
enableFacebookDeferredApplinksHabilitar la recopilación de Facebook Deferred AppLinks. Requiere Facebook SDK y la app de Facebook en el dispositivo cliente. Este API debe invocarse antes de inicializar el SDK de AppsFlyer para funcionar correctamente.
sendPushNotificationDataMedir y obtener datos de campañas de push-notifications.
setCurrentDeviceLanguageEstablecer el idioma del dispositivo. Los datos se mostrarán en los Raw Data Reports.
logCrossPromoteImpressionRegistra una impresión como parte de una campaña de cross-promotion. Asegúrate de usar el ID de la app promocionada tal como aparece en el dashboard de AppsFlyer.
setUserEmailsConfigura los emails de usuario y encriptalos.
logLocationRegistra manualmente la ubicación del usuario.
setPhoneNumberSe enviará como un string encriptado con SHA-256.
setPartnerDataPermite 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 una CMP compatible con TCF v2.2, usa el siguiente método para proporcionar los datos de consentimiento directamente a SDK.
logAdRevenueAl 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 una CMP compatible con TCF v2.2, usa el siguiente método para proporcionar los datos de consentimiento directamente a SDK.
isSDKStartedUsa este método para verificar si el SDK de AppsFlyer ya se ha iniciado en la sesión actual.
isSDKStoppedUsa este método para verificar si el SDK de AppsFlyer está detenido actualmente.
disableAppSetIdDesactiva 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.
validateAndLogInAppPurchaseV2API 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.

Esta referencia se sincroniza desde src/definitions.ts en capacitor-appsflyer.

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