Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice la siguiente solicitud:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.

Si prefiere la configuración manual, instale el plugin ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

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 lance 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 compras en la aplicación. Proporciona un código de tres caracteres de ISO 4217 code.

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

await AppsFlyer.setCurrencyCode({} as AFCurrency);

updateServerUninstallToken

Proporciona tokens GCM/FCM en Android o tokens APNs en iOS cuando otro plugin los haya recopilado. Utilice esto para enviar tokens de medición de desinstalació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 Enlace Uno 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 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.

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

await AppsFlyer.appendParametersToDeepLinkingURL({} as AFAppendToDeepLink);

setResolveDeepLinkURLs

Use esto cuando un enlace de AppsFlyer OneLink está envuelto dentro de otro enlace Universal. 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 enlaces profundos de payloads de notificaciones push.

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

await AppsFlyer.addPushNotificationDeepLinkPath({} as AFPath);

setSharingFilter

Detiene los eventos de propagación 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

Obtenga el ID de dispositivo único 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 (anonymizar los datos del 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 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).

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

await AppsFlyer.disableAdvertisingIdentifier({} as AFDisable);

disableCollectASA

Optar por salir de las atribuciones de Apple Search Ads.

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

Permitir a sus usuarios existentes que inviten a sus amigos y contactos como nuevos usuarios a su aplicación.

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

await AppsFlyer.generateInviteLink({} as AFLinkGenerator);

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.

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. Este API debe ser invocado 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 campañas de notificaciones push.

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

await AppsFlyer.sendPushNotificationData({} as AFPushPayload);

setCurrentDeviceLanguage

Establecer 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 transversal. 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

Establecer los correos electrónicos de usuario y cifrarlos.

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

await AppsFlyer.setUserEmails({} as AFEmails);

logLocation

Registrar manualmente la ubicación del usuario

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

await AppsFlyer.logLocation({} as AFLatLng);

setPhoneNumber

Se enviará como una cadena cifrada 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 de usuario 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 SIM del dispositivo.

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

await AppsFlyer.setDisableNetworkData({} as AFDisable);

enableTCFDataCollection

Utilice para habilitar/deshabilitar la recopilación automática de datos de consentimiento, para usuarios que utilizan un CMP.

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

await AppsFlyer.enableTCFDataCollection({} as AFEnableTCFDataCollection);

setConsentData

Use this to set user consent data manually. If your app doesn’t use a CMP compatible with TCF v2.2, use the following method to manually provide the consent data directly to the SDK.

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

await AppsFlyer.setConsentData({} as AFConsentData);

logAdRevenue

Copiar al portapapeles

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

await AppsFlyer.logAdRevenue({} as AFAdRevenueData);

setConsentDataV2

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

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

await AppsFlyer.setConsentDataV2({} as AFConsentOptions);

isSDKStarted

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

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

await AppsFlyer.isSDKStarted();

isSDKStopped

Utilice este método para verificar si el SDK de AppsFlyer 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 la inicialización de SDK, el ID de aplicación no se recopilará. Si se llama después de la inicialización, 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. Un evento af_purchase con los valores relevantes se registrará automáticamente 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.ts . Re-ejecutar la sincronización cuando el público API cambie en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola de dashboard y API operaciones, conecta con ella Usando @capgo/capacitor-appsflyer para la capacidad nativa en Usando @capgo/capacitor-appsflyer, Resumen de API para el detalle de implementación en Resumen de API, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.