@capgo/capacitor-appsflyer

Resumen

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

Capacidades básicas

• initSDK - Use 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.

Público API

Método	Descripción
addListener('conversion_callback', listener)	Escuche las llamadas de retorno de conversión, incluyendo onConversionDataSuccess y onConversionDataFail, con OnConversionDataResult payloads.
addListener('oaoa_callback', listener)	Escuche las llamadas de retorno de atribución de apertura de aplicación, incluyendo onAppOpenAttribution y onAttributionFailure, con OnAppOpenAttribution payloads.
addListener('udl_callback', listener)	Escucha los callbacks de enlaces profundos unificados con OnDeepLink payloads.
initSDK	Utiliza este método para inicializar y iniciar AppsFlyer SDK. Este API debe llamarse tan pronto como se lance la aplicación.
startSDK	Utiliza 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 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. Proporciona un código de tres caracteres de ISO 4217 code.
updateServerUninstallToken	Transmite los tokens de GCM/FCM en Android o tokens de APNs en iOS cuando otro plugin los recopiló. Utiliza 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 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	Use este cuando un enlace OneLink de AppsFlyer está envuelto dentro de otro enlace Universal. Le permite a SDK resolver la URL envuelta para que el enlace profundo siga funcionando correctamente.
addPushNotificationDeepLinkPath	Configura cómo SDK extrae los valores de enlace profundo de los payloads de notificaciones push.
setSharingFilter	Detiene los eventos de propagarse a los socios de AppsFlyer especificados.
setSharingFilterForAllPartners	Detiene los eventos de propagarse a todos los socios de AppsFlyer. Sobreescribe el filtro de compartición establecido.
setSharingFilterForPartners	Detiene los eventos de propagarse a los socios de AppsFlyer especificados.
setAdditionalData	Establece datos clave-valor adicionales para enviar a AppsFlyer.
getAppsFlyerUID	Obtenga el ID de dispositivo único de AppsFlyer (creado para cada nueva instalación de una aplicación).
anonymizeUser	Opt-out de usuarios de AppsFlyer (Anonimizar datos de usuario).
stop	Una vez que se invoca este API, nuestra SDK ya no se comunica con nuestros servidores y deja de funcionar. Útil al implementar la opción de opt-in/opt-out del usuario.
disableSKAdNetwork	Opt-out de SKAdNetwork.
disableAdvertisingIdentifier	Deshabilita la recopilación de varios 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	Opt-out de atribuciones de Apple Search Ads.
setHost	Establecer un host personalizado.
generateInviteLink	Permitir que sus usuarios existentes 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. Si la validación es exitosa, se registrará automáticamente un evento af_purchase con los valores relevantes.
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 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 SDK de AppsFlyer para funcionar correctamente.
sendPushNotificationData	Medir y obtener datos de campañas de notificaciones push.
setCurrentDeviceLanguage	Establezca el idioma del dispositivo. Los datos se mostrarán en 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 la aplicación promocionada tal como aparece en la consola de AppsFlyer.
setUserEmails	Establezca los correos electrónicos del usuario y los cifre.
logLocation	Registra manualmente la ubicación del usuario.
setPhoneNumber	Se enviará como una cadena cifrada con SHA-256.
setPartnerData	Permite enviar datos personalizados con fines de integración de socios.
logInvite	Utilice para registrar un evento de invitación de usuario en la aplicación (af_invite).
setDisableNetworkData	Utilice para desactivar la recopilación del nombre del operador de red (proveedor) y el nombre del operador SIM del dispositivo.
enableTCFDataCollection	Utilice 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	Establezca los datos de consentimiento del usuario manualmente. Si su aplicación no utiliza un CMP compatible con la versión 2.2 del TCF, utilice el siguiente método para proporcionar los datos de consentimiento directamente al SDK.
logAdRevenue	Al atribuir la rentabilidad de los anuncios, los propietarios de la aplicación obtienen una visión completa del LTV del usuario y el ROI de la campaña. La rentabilidad de los anuncios 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 la rentabilidad de los anuncios.
setConsentDataV2	Establezca los datos de consentimiento del usuario manualmente. Si su aplicación no utiliza un CMP compatible con la versión 2.2 del TCF, utilice el siguiente método para proporcionar los datos de consentimiento directamente al SDK.
isSDKStarted	Use this method to check whether the AppsFlyer SDK has already been started in the current session.
isSDKStopped	Use this method to check whether the AppsFlyer SDK is currently stopped.
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. Si la validación es exitosa, se registrará automáticamente un evento af_purchase con los valores relevantes.

Fuente de Verdad

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