Iniciación

Instalar

bun add @capgo/capacitor-appsflyer
bunx cap sync

Importar

import { AppsFlyer } from '@capgo/capacitor-appsflyer';
import type {
  AFAdRevenueData,
  AFAndroidInAppPurchase,
  AFAnonymizeUser,
  AFAppendToDeepLink,
  AFConsentData,
  AFConsentOptions,
  AFCuid,
  AFCurrency,
  AFData,
  AFDisable,
  AFEmails,
  AFEnableTCFDataCollection,
  AFEvent,
  AFFbDAL,
  AFFilters,
  AFHost,
  AFInit,
  AFIosInAppPurchase,
  AFLanguage,
  AFLatLng,
  AFLinkGenerator,
  AFLogInvite,
  AFOnelinkDomain,
  AFOnelinkID,
  AFPartnerData,
  AFPath,
  AFPhone,
  AFPromotion,
  AFPurchaseDetailsV2,
  AFPushPayload,
  AFUninstall,
  AFUrls,
} from '@capgo/capacitor-appsflyer';

API Resumen

initSDK

Utilice este método para inicializar y iniciar AppsFlyer SDK. Este API debe llamarse tan pronto como se inicie la aplicación.

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

await AppsFlyer.initSDK({} as AFInit);

startSDK

Utilice este método para iniciar AppsFlyer SDK, solo en modo de inicio manual.

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

await AppsFlyer.startSDK();

logEvent

Registrar un evento en la aplicación.

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

await AppsFlyer.logEvent({} as AFEvent);

setCustomerUserId

Establecer su propio ID de cliente 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({} as AFCuid);

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.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Pasa 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 deshabilitación a AppsFlyer.

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

await AppsFlyer.updateServerUninstallToken({} as AFUninstall);

setAppInviteOneLink

Establece el ID de OneLink utilizado como enlace base para la atribución de invitaciones.

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

await AppsFlyer.setAppInviteOneLink({} as AFOnelinkID);

setOneLinkCustomDomain

Registra dominios de OneLink personalizados para que AppsFlyer pueda resolver parámetros de atribución ocultos en enlaces cortos.

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

await AppsFlyer.setOneLinkCustomDomain({} as AFOnelinkDomain);

appendParametersToDeepLinkingURL

Habilita la atribución para enlaces profundos de App Links sin OneLink. Llama a este método antes de startSDK()Incluye al menos pid y en el mapa de parámetros. is_retargeting=true Copiar a portapapeles

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Le permite a SDK resolver la URL envuelta para que el enrutamiento profundo siga funcionando correctamente.

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

await AppsFlyer.setResolveDeepLinkURLs({} as AFUrls);

addPushNotificationDeepLinkPath

Configura cómo SDK extrae valores de enlace profundo de payloads de notificaciones push.

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Detiene eventos de propagarse a los socios de AppsFlyer especificados.

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

await AppsFlyer.setSharingFilter({} as AFFilters);

setSharingFilterForAllPartners

Detiene los eventos de propagación a todos los socios de AppsFlyer. Sobrescribe setSharingFilter.

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

await AppsFlyer.setSharingFilterForAllPartners();

setSharingFilterForPartners

Detiene los eventos de propagación a los socios de AppsFlyer especificados.

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

await AppsFlyer.setSharingFilterForPartners({} as AFFilters);

setAdditionalData

Establece datos clave-valor adicionales para enviar a AppsFlyer.

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

await AppsFlyer.setAdditionalData({} as AFData);

getAppsFlyerUID

Obtiene el ID único de dispositivo de AppsFlyer (creado para cada nueva instalación de una aplicación).

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

await AppsFlyer.getAppsFlyerUID();

anonymizeUser

Opt-out del usuario final de la analítica de AppsFlyer (Anonimizar datos de usuario).

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

await AppsFlyer.anonymizeUser({} as AFAnonymizeUser);

stop

Una vez que se invoca este API, nuestro SDK ya no se comunica con nuestros servidores y deja de funcionar. Útil cuando se implementa la opción de aceptación/rechazo del usuario.

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

await AppsFlyer.stop();

disableSKAdNetwork

Opt-out de SKAdNetwork

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

await AppsFlyer.disableSKAdNetwork({} as AFDisable);

disableAdvertisingIdentifier

Deshabilita la recopilación de diversas Identificaciones de Publicidad por parte del SDK. Esto incluye la Identidad para Anunciantes de Apple (IDFA), el Identificador de Publicidad de Google (GAID), OAID y la Identificación de Publicidad de Amazon (AAID).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Optar de las atribuciones de anuncios de búsqueda de Apple.

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

await AppsFlyer.disableCollectASA({} as AFDisable);

setHost

Establecer un host personalizado.

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

await AppsFlyer.setHost({} as AFHost);

generateInviteLink

Copiar a portapapeles

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

validateAndLogInAppPurchaseAndroid

API for server verification of in-app purchases. An af_purchase event with the relevant values will be automatically logged if the validation is successful.

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

await AppsFlyer.validateAndLogInAppPurchaseAndroid({} as AFAndroidInAppPurchase);

validateAndLogInAppPurchaseIos

Consulte las definiciones de origen para el contrato actual.

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

await AppsFlyer.validateAndLogInAppPurchaseIos({} as AFIosInAppPurchase);

getSdkVersion

Obtenga la versión de AppsFlyer SDK utilizada en la aplicación.

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

await AppsFlyer.getSdkVersion();

enableFacebookDeferredApplinks

Habilite la recopilación de Facebook Deferred AppLinks. Requiere Facebook SDK y la aplicación de Facebook en el dispositivo objetivo/cliente. Esta API debe ser invocada antes de inicializar la AppsFlyer SDK para funcionar correctamente.

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

await AppsFlyer.enableFacebookDeferredApplinks({} as AFFbDAL);

sendPushNotificationData

Medir y obtener datos de las campañas de notificaciones push.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Establece el idioma del dispositivo. Los datos se mostrarán en Informes de Datos Brutos

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

await AppsFlyer.setCurrentDeviceLanguage({} as AFLanguage);

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.

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

await AppsFlyer.logCrossPromoteImpression({} as AFPromotion);

setUserEmails

Establece los correos electrónicos del usuario y los cifra.

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Registra manualmente la ubicación del usuario

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Se enviará como una cadena cifrada con SHA-256.

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

await AppsFlyer.setPhoneNumber({} as AFPhone);

setPartnerData

Permite enviar datos personalizados para fines de integración de socios.

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

await AppsFlyer.setPartnerData({} as AFPartnerData);

logInvite

Utilice para registrar un evento de invitación en la aplicación (af_invite).

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

await AppsFlyer.logInvite({} as AFLogInvite);

setDisableNetworkData

Utilice para excluir la recopilación del nombre del operador de red (proveedor) y el nombre del operador del SIM del dispositivo.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

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.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Utilice esto 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 a la SDK.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Al atribuir los ingresos publicitarios, los propietarios de la aplicación obtienen una visión completa del LTV de los usuarios y la ROI de las campañas. 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.

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

Utilice esto 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 a la SDK.

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

Utilice este método para verificar si el AppsFlyer SDK ya ha sido iniciado en la sesión actual.

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

await AppsFlyer.isSDKStarted();

isSDKStopped

Utilice este método para verificar si el AppsFlyer SDK está actualmente detenido.

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

await AppsFlyer.isSDKStopped();

disableAppSetId

Deshabilita la recopilación de ID de aplicación. Si se llama antes de SDK init, el ID de aplicación no se recopilará. Si se llama después de init, el ID de aplicación se recopilará pero no se enviará en los payloads de solicitud. Solo para Android.

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

await AppsFlyer.disableAppSetId();

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.

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

await AppsFlyer.validateAndLogInAppPurchaseV2({} as AFPurchaseDetailsV2);

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambie en la fuente.