@capgo/capacitor-appsflyer

Resumen

Capacitor plugin para AppsFlyer de atribución, análisis y enlaces profundos.

Capacidades básicas

• initSDK - Utilice este método para inicializar y iniciar AppsFlyer SDK. Este API debe llamarse tan pronto como se lance la aplicación.
• startSDK - Utilice este método para iniciar AppsFlyer SDK, solo en modo de inicio manual.
• logEvent - Registre 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 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.

API pública API

Método	Descripción
addListener('conversion_callback', listener)	Escucha las llamadas de retorno de conversión, incluyendo onConversionDataSuccess y onConversionDataFail, con OnConversionDataResult paquetes de datos.
addListener('oaoa_callback', listener)	Escucha las llamadas de retorno de atribución de apertura de aplicación, incluyendo onAppOpenAttribution y onAttributionFailure, con OnAppOpenAttribution paquetes de datos.
addListener('udl_callback', listener)	Escucha las llamadas de retorno de enlaces profundos unificados con OnDeepLink paquetes de datos.
initSDK	Utiliza este método para inicializar y iniciar AppsFlyer SDK. Este API debe llamarse tan pronto como se lance la aplicación.
startSDK	Use this method to start 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 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.
setCurrencyCode	Establece la moneda utilizada para las compras en la aplicación. Proporcione un código de tres caracteres de la norma ISO 4217 code.
updateServerUninstallToken	Pasa los tokens de GCM/FCM en Android o tokens de APNs en iOS cuando otro plugin los haya recopilado. Utilice esto para enviar tokens de medición de desinstalación a AppsFlyer.
setAppInviteOneLink	Establece el ID de OneLink utilizado como enlace base para la atribución de invitaciones.
setOneLinkCustomDomain	Registra dominios de OneLink personalizados para que AppsFlyer pueda resolver los parámetros de atribución ocultos en enlaces cortos.
appendParametersToDeepLinkingURL	Habilita la atribución para enlaces profundos de App Links sin OneLink. Llame a este método antes de startSDK(). Incluya al menos pid y is_retargeting=true en el mapa de parámetros.
setResolveDeepLinkURLs	Utilice esto cuando un enlace de AppsFlyer OneLink está envuelto en otro enlace Universal. Le permite al SDK resolver la URL envuelta para que la enrutamiento profundo siga funcionando correctamente.
addPushNotificationDeepLinkPath	Configura cómo el SDK extrae valores de enlaces profundos de payloads de notificaciones push.
setSharingFilter	Detiene eventos de propagarse a los socios de AppsFlyer especificados.
setSharingFilterForAllPartners	Detiene eventos de propagarse a todos los socios de AppsFlyer. Sobreescribe el filtro de compartición establecido.
setSharingFilterForPartners	Detiene eventos de propagarse a los socios de AppsFlyer especificados.
setAdditionalData	Establece datos clave-valor adicionales para enviar a AppsFlyer.
getAppsFlyerUID	Obtiene el ID de dispositivo único de AppsFlyer (creado para cada nueva instalación de una aplicación).
anonymizeUser	Opt-out de los usuarios de la analítica de AppsFlyer (Anonimiza los datos de usuario).
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 opción de entrada del usuario (opt-in/opt-out).
disableSKAdNetwork	Opt-out de SKAdNetwork.
disableAdvertisingIdentifier	Deshabilita la recopilación de diversas Identificaciones de Publicidad por el SDK. Esto incluye la Identidad para Anunciantes de Apple (IDFA), la Identificación de Publicidad de Google (GAID), OAID y la Identificación de Publicidad de Amazon (AAID).
disableCollectASA	Opt-out de las atribuciones de Apple Search Ads.
setHost	Establece un host personalizado.
generateInviteLink	Permitir a sus usuarios existentes que inviten 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 SDK de AppsFlyer utilizada en la aplicación.
enableFacebookDeferredApplinks	Habilite la recopilación de enlaces de aplicación diferidos de Facebook. Requiere Facebook SDK y la aplicación de Facebook en el dispositivo objetivo/cliente. Este API debe ser invocado antes de inicializar la instancia de AppsFlyer SDK para funcionar correctamente.
sendPushNotificationData	Medir y obtener datos de las campañas de notificaciones push.
setCurrentDeviceLanguage	Establezca 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 promocionada tal como aparece en la consola de AppsFlyer.
setUserEmails	Establezca los correos electrónicos del usuario y los cifre.
logLocation	Registre manualmente la ubicación del usuario.
setPhoneNumber	Se enviará como una cadena cifrada SHA-256.
setPartnerData	Permite enviar datos personalizados para fines de integración de socios.
logInvite	Use to log a evento de invitación de usuario en la aplicación (af_invite).
setDisableNetworkData	Use to opt-out of collecting the nombre del operador de red (carrier) and nombre del operador de SIM del dispositivo.
enableTCFDataCollection	Use to opt-in/out the 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 this to set the datos de consentimiento de usuario manualmente. Si su aplicación no utiliza un CMP compatible con TCF v2.2, use el siguiente método para proporcionar los datos de consentimiento directamente a la SDK.
logAdRevenue	Al atribuir la ganancia de publicidad, los propietarios de la aplicación obtienen una visión completa del LTV de usuario y el ROI de la campaña. La ganancia de publicidad se genera al mostrar anuncios en videos recompensados, paredes de ofertas, intersticiales y banners en una aplicación. Puede utilizar este método para registrar su ganancia de publicidad.
setConsentDataV2	Use this to set the datos de consentimiento de usuario manualmente. Si su aplicación no utiliza un CMP compatible con TCF v2.2, use el siguiente método para proporcionar los datos de consentimiento directamente a la SDK.
isSDKStarted	Use this method to check whether la instancia de AppsFlyer SDK ya ha sido iniciada en la sesión actual.
isSDKStopped	Use this method to check whether la instancia de AppsFlyer SDK está actualmente detenida.
disableAppSetId	Deshabilita la recopilación de ID de AppSet. Si se llama antes de SDK init, el ID de App Set no se recopilará. Si se llama después de init, el ID de App Set se recopilará pero no se enviará en payloads de solicitud. Solo para Android.
validateAndLogInAppPurchaseV2	API para la verificación del servidor de compras en la aplicación V2. Un evento af_purchase con los valores relevantes se registrará automáticamente si la validación es exitosa.

Fuente de Verdad

Esta referencia está sincronizada desde src/definitions.ts en capacitor-appsflyer.