AppsFlyerLib
Resumen General
AppsFlyerLib
es la clase principal del SDK de AppsFlyer para Android y encapsula la mayoría de los métodos.
Regresa al índice de referencia del SDK.
Importar la biblioteca
import com.appsflyer.AppsFlyerLib;
Acceder a la instancia del SDK
Acceder a la instancia única del SDK
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
Métodos
addPushNotificationDeepLinkPath
Firma de método
void addPushNotificationDeepLinkPath(java.lang.String... deepLinkPath)
Descripción
Configura cómo el SDK extrae valores de enlaces profundos de las cargas útiles de notificaciones push.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String... | deepLinkPath | Una serie de String s que corresponde a la ruta JSON del enlace profundo. |
Devoluciones
void
.
Ejemplo de uso
Configuración básica:
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("af_push_link")
Configuración avanzada:
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link");
AppsFlyerLib.getInstance().addPushNotificationDeepLinkPath("deeply", "nested", "deep_link")
Esta llamada coincide con la siguiente estructura de carga útil:
{
"deeply": {
"nested": {
"deep_link": "https://yourdeeplink2.onelink.me"
}
}
}
anonymizeUser
Firma de método
void anonymizeUser(boolean shouldAnonymize)
Descripción
Anonimiza las instalaciones, eventos y sesiones de un usuario.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | shouldAnonymize | Por defecto, false . |
Devoluciones
void
Ejemplo de uso
AppsFlyerLib.getInstance().anonymizeUser(true);
AppsFlyerLib.getInstance().anonymizeUser(true)
appendParametersToDeepLinkingURL
Firma de método
void appendParametersToDeepLinkingURL(java.lang.String contains,
java.util.Map<java.lang.String,java.lang.String> parameters)
Descripción
Permite a los propietarios que utilizan App Links para enlaces profundos (sin OneLink) atribuir sesiones iniciadas a través de un dominio asociado a su aplicación.
Llamar a este método antes de llamar a
start
Debes proporcionar los siguientes parámetros en el parameters
Map
:
pid
is_retargeting
debe configurarse entrue
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | contains | Una cadena incluida en la URL del enlace profundo |
Map<String, String> | parameters | Parámetros de atribución que se agregarán a las URL coincidentes |
Devoluciones
void
Ejemplo de uso
HashMap<String, String> urlParameters = new HashMap<>();
urlParameters.put("pid", "exampleDomain"); // Required
urlParameters.put("is_retargeting", "true"); // Required
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com", urlParameters);
AppsFlyerLib.getInstance().appendParametersToDeepLinkingURL("example.com",
mapOf("pid" to "exampleDomain", "is_retargeting" to "true")) // Required
En el ejemplo anterior, la URL de atribución resultante enviada a los servidores de AppsFlyer es:
example.com?pid=exampleDomain&is_retargeting=true
enableFacebookDeferredApplinks
Firma de método
void enableFacebookDeferredApplinks(boolean isEnabled)
Descripción
Habilita la colección de enlaces de aplicaciones diferidos de Facebook. Requiere el SDK de Facebook y la aplicación de Facebook en el dispositivo del cliente/objetivo.
Esta API debe invocarse antes de inicializar el SDK de AppsFlyer para que funcione correctamente.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | isEnabled | En caso de que el SDK de AppsFlyer procese los enlaces de aplicaciones diferidos de Facebook. |
Devoluciones
void
enableLocationCollection
Eliminado en V6.8.0
Firma de método
AppsFlyerLib enableLocationCollection(boolean flag)
Descripción
Habilita el SDK de AppsFlyer para recopilar la última ubicación conocida. Requiere los permisos de manifiesto ACCESS_COARSE_LOCATION
and ACCESS_FINE_LOCATION
.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | flag |
Devoluciones
void
enableTCFDataCollection
Firma de método
AppsFlyerLib enableTCFDataCollection (boolean flag)
Descripción
Enables the collection of Transparency and Consent Framework (TCF) data from SharedPreferences
. The data was placed in SharedPreferences
by the device TCF v2.2 compatible Consent Management Platform (CMP).
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Booleano | flag | A boolean value to enable (true ) or disable (false ) the collection of TCF data. The SDK collects TCF data when the flag is set to true . |
Devoluciones
void
getAppsFlyerUID
Firma de método
java.lang.String getAppsFlyerUID(Context context)
Descripción
Obtén el ID de dispositivo único de AppsFlyer. El SDK genera un ID de dispositivo único de AppsFlyer tras la instalación de la aplicación. Cuando se inicia el SDK, este ID se registra como el ID de la primera instalación de la aplicación.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
Devoluciones
ID de dispositivo exclusivo de AppsFlyer.
Ejemplo de uso
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this);
String appsFlyerId = AppsFlyerLib.getInstance().getAppsFlyerUID(this)
getAttributionId
Firma de método
java.lang.String getAttributionId(Context context)
Descripción
Obtiene el ID de atribución de Facebook, si existe.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
Devoluciones
void
Ejemplo de uso
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this);
String attributionId = AppsFlyerLib.getInstance().getAttributionId(this)
getHostName
Firma de método
java.lang.String getHostName()
Descripción
Obtener el nombre del host.
El valor predeterminado es "appsflyer.com".
Argumentos de entrada
Esta función no toma parámetros.
Devoluciones
Tipo | Descripción |
---|---|
String | Nombre de host configurado actualmente. |
Ejemplo de uso
getHostPrefix
Firma de método
java.lang.String getHostPrefix()
Descripción
Obtener el prefijo de host personalizado.
Argumentos de entrada
Esta función no toma parámetros.
Devoluciones
Prefijo de host.
getInstance
Firma de método
AppsFlyerLib getInstance()
Descripción
Devuelve la instancia del SDK, mediante la cual puedes acceder a los métodos que se describen en este documento.
Argumentos de entrada
Esta función no toma parámetros.
Devoluciones
Instancia única de AppsFlyerLib.
getOutOfStore
Firma de método
java.lang.String getOutOfStore(Context context)
Descripción
Obtener el valor del referente de la tienda de aplicaciones de terceros.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
Devoluciones
AF_Store
valor.
getSdkVersion
Firma de método
java.lang.String getSdkVersion()
Descripción
Obtener la versión del SDK de AppsFlyer que se usa en la aplicación.
Argumentos de entrada
Esta función no toma parámetros.
Devoluciones
Versión del SDK de AppsFlyer.
init
Firma de método
AppsFlyerLib init(java.lang.String key,
AppsFlyerConversionListener conversionDataListener,
Context context)
Descripción
Usa este método para inicializar el SDK de AppsFlyer. Esta API debe llamarse dentro de la aplicación, en el método onCreate
.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | key | Clave de desarrollador de AppsFlyer |
AppsFlyerConversionDataListener | conversionDataListener | (Opcional) implementa AppsFlyerConversionDataListener para acceder a los datos de conversión de AppsFlyer. Puede ser nulo. |
Context | context | Contexto de la aplicación. |
Devoluciones
void
Ejemplo de uso
Consulta la inicialización del SDK.
isPreInstalledApp
Firma de método
boolean isPreInstalledApp(Context context)
Descripción
Indicador booleano para la preinstalación por el fabricante.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
Devoluciones
boolean
.
Ejemplo de uso
isStopped
Firma de método
boolean isStopped()
Descripción
Verifica si el SDK se detuvo.
Argumentos de entrada
Esta función no toma parámetros.
Devoluciones
Tipo | Descripción |
---|---|
boolean | true si se detiene, false en caso contrario. |
Ejemplo de uso
logAdRevenue
Added in v6.15.0
Firma de método
public abstract void logAdRevenue(
@NonNull AFAdRevenueData adRevenueData,
@Nullable Map<String, Object> additionalParameters
);
Descripción
The method sends an ad revenue event to AppsFlyer. See more information in Ad revenue.
Parámetros de entrada
Nombre | Tipo | Descripción |
---|---|---|
adRevenueData | AFAdRevenueData | An object that encapsulates all the mandatory parameters of the adRevenue event. The object is passed to the logAdRevenue method. |
additionalParameters | Map<String, Object> | An optional dictionary containing additional parameters to log with the adRevenue event. |
Devoluciones
void
.
AFAdRevenueData
An object that encapsulates all mandatory adRevenue
data received from the mediation network.
Definition
data class AFAdRevenueData(
val monetizationNetwork: String,
val mediationNetwork: MediationNetwork,
val currencyIso4217Code: String,
val revenue: Double
)
AFAdRevenueData parameters
Nombre | Tipo | Descripción |
---|---|---|
monetizationNetwork | String | The monetization network name. |
mediationNetwork | MediationNetwork | The mediation network enum. |
currencyIso4217Code | String | The ad revenue event currency is a String validated against currencyIso4217Code |
revenue | Double | The ad revenue event amount. |
MediationNetwork
Nombre | Tipo | Comments |
---|---|---|
ironsource | String | |
applovinmax | String | |
googleadmob | String | |
fyber | String | |
appodeal | String | |
admost | String | |
topon | String | |
tradplus | String | |
yandex | String | |
chartboost | String | |
unity | String | |
customMediation | String | La solución de mediación no está en la lista de partners de mediación admitidos. |
directMonetizationNetwork | String | La app se integra directamente con las redes de monetización sin mediación. |
logEvent
Firma de método
void logEvent(Context context,
java.lang.String eventName,
java.util.Map<java.lang.String,java.lang.Object> eventValues)
Descripción
Registra un evento in-app.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación |
String | eventName | Nombre del evento |
Map | eventValues | Valores del evento |
Devoluciones
void
Ejemplo de uso
logEvent
Firma de método
void logEvent(Context context,
java.lang.String eventName,
java.util.Map<java.lang.String,java.lang.Object> eventValues,
AppsFlyerRequestListener listener)
Descripción
Igual que logEvent, con AppsFlyerRequestListener. HttpURLConnection.HTTP_OK
desde el
servidor invocará el método AppsFlyerRequestListener #onSuccess (). AppsFlyerRequestListener#onError(int, String) devolverá
el error en caso de que ocurra uno
Argumentos de entrada
Esta función no toma parámetros. Devuelve
void
Ejemplo de uso
logLocation
Firma de método
void logLocation(Context context,
double latitude,
double longitude)
Descripción
Registra manualmente la ubicación del usuario.
Este método crea un evento in-app af_location_coordinates
, con los parámetros del evento af_lat
and af_long
.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación |
double | latitude | Latitud |
double | longitude | Longitud |
Devoluciones
void
Ejemplo de uso
logSession
Firma de método
void logSession(Context ctx)
Descripción
Si tu aplicación es una aplicación utilitaria en segundo plano, puedes utilizar esta API en onCreate() de tu actividad para registrar y enviar manualmente una sesión.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | ctx | Contexto de actividad / aplicación |
Ejemplo de uso
public void logSession(Context context);
public void logSession(Context context)
Devoluciones
void
onPause
Firma de método
void onPause(Context context)
Descripción
Solo para la plataforma Cocos2dx
Cocos2dx tiene su propio evento applicationDidEnterBackground.
Por lo tanto, JNI llamará a 'onPause' desde C++
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación |
Devoluciones
void
Ejemplo de uso
performOnAppAttribution
En desuso desde V6.3.2
Firma de método
void performOnAppAttribution(Context context,
java.net.URI link)
Descripción
Se usa para rastrear manualmente los enlaces profundos.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación |
java.net.URI | link | Enlace para resolver |
Devoluciones
void
Ejemplo de uso
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri);
AppsFlyerLib.getInstance().performOnAppAttribution(context, uri)
performOnDeepLinking
Agregado en V6.3.1+
Firma de método
public void performOnDeepLinking(@NonNull Intent intent, @NonNull Context context);
Descripción
Habilita la activación manual de la resolución de enlaces profundos. Este método permite que las aplicaciones que están retrasando la llamada a start resuelvan enlaces profundos antes de que comience el SDK.
- Si un
DeepLinkListener
está registrado, admite enlaces profundos tanto diferidos como directos. - Si un
AppsFlyerConversionListener
está registrado, solo admite enlaces profundos directos.
Se recomienda llamar a esto desde un Activity
's onResume
, para actividades que se pueden iniciar mediante enlaces profundos.
Nota: Los enlaces profundos directos que procesa esta API no se notificarán al servidor.
Ejemplo de uso
@Override
protected void onResume() {
super.onResume();
AppsFlyerLib appsflyer = AppsFlyerLib.getInstance();
appsflyer.performOnDeepLinking(getIntent(),this);
}
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Intent | intent | |
Context | context | Contexto de actividad / aplicación. |
Devoluciones
void
registerConversionListener
Firma de método
void registerConversionListener(Context context,
AppsFlyerConversionListener conversionDataListener)
Descripción
Registra un oyente de datos de conversión. También puedes usar init
para registrar al oyente.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
AppsFlyerConversionListener | conversionDataListener | The AppsFlyerConversionListener objeto para registrar. |
Devoluciones
void
Ejemplo de uso
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener);
// conversionDataListener is an object of type AppsFlyerConversionListener.
AppsFlyerLib.getInstance().registerConversionListener(getApplicationContext(), conversionDataListener)
Aquí hay un ejemplo de implementación de AppsFlyerConversionListener
.
registerValidatorListener (LEGACY)
Firma de método
void registerValidatorListener(Context context,
AppsFlyerInAppPurchaseValidatorListener validationListener)
Descripción
Registra un oyente de validación para la API validateAndLogInAppPurchase
.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
AppsFlyerInAppPurchaseValidatorListener | validationListener | The AppsFlyerInAppPurchaseValidatorListener objeto para registrar. |
Devoluciones
void
Ejemplo de uso
sendAdRevenue (LEGACY)
Deprecated in v6.15.0
(Supported until SDK v6.14.2 For versions including and above v6.15.0 use logAdRevenue
)
Firma de método
void sendAdRevenue(Context context,
java.util.Map<java.lang.String,java.lang.Object> eventValues)
Descripción
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
Map<String, Object> | validationListener |
Devoluciones
void
sendPushNotificationData
Firma de método
void sendPushNotificationData(Activity activity)
Descripción
Mide y obtiene datos de campañas de notificaciones push. Llama a este método dentro del método onCreate
de Activity
s que se inician a partir de notificaciones push.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Activity | activity | The Activity que se inicia a través de la notificación. |
Devoluciones
void
.
Ejemplo de uso
setAdditionalData
Calling
setAddiotionalData
before first launch will have the additional data included in installs, sessions, as well as in-app events.
Firma de método
void setAdditionalData(java.util.Map<java.lang.String,java.lang.Object> customData)
Descripción
Úsalo para agregar datos personalizados a la carga útil de los eventos. Aparecerá en los reportes de raw data. Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
HashMap | customData |
Devoluciones
void
.
setAndroidIdData
Firma de método
void setAndroidIdData(java.lang.String aAndroidId)
Descripción
De manera predeterminada, el SDK no recopila el IMEI ni el ID de Android si la versión de Android es superior a KitKat (4.4) y el dispositivo contiene servicios de Google Play. Usa esta API para enviar explícitamente el ID de Android a AppsFlyer.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | aAndroidId | ID de dispositivo de Android. |
Devoluciones
void
setAppId
Firma de método
void setAppId(java.lang.String id)
Descripción
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | id | ID de aplicación de Android. |
Devoluciones
void
setAppInviteOneLink
Firma de método
void setAppInviteOneLink(java.lang.String oneLinkId)
Descripción
Configura el ID de OneLink que se debe utilizar para atribuir invitaciones de usuarios. El enlace que se genera para la invitación de usuarios usará este OneLink como enlace base. Consulta la sección sobre cómo configurar OneLink para la atribución de invitaciones de usuarios.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | oneLinkId | ID de OneLink obtenido del panel de control de AppsFlyer. |
Devoluciones
void
.
setCollectAndroidID
Firma de método
void setCollectAndroidID(boolean isCollect)
Descripción
Optar a la recopilación de ID de Android. Obliga al SDK a recopilar el ID de Android.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | isCollect | Establécelo en true para habilitarlo. |
Devoluciones
void
.
setCollectIMEI
Firma de método
void setCollectIMEI(boolean isCollect)
Descripción
Optar por la recopilación de IMEI. Obliga al SDK a recopilar el IMEI.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | isCollect | Establécelo en true para habilitarlo. |
Devoluciones
void
.
setCollectOaid
Firma de método
void setCollectOaid(boolean isCollect)
Descripción
Optar por recopilar/optar por no recopilar el OAID. De forma predeterminada, el SDK intenta recopilar el OAID.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | isCollect | Por defecto, true . Establécelo en false para la exclusión opcional. |
Devoluciones
void
.
setConsentData
Firma de método
AppsFlyerLib.getInstance().setConsentData(AppsFlyerConsent afConsent)
Descripción
Transfers consent data to the SDK.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
AppsFlyerConsent | afConsent | An object containing user consent data |
setCurrencyCode
Firma de método
void setCurrencyCode(java.lang.String currencyCode)
Descripción
Establece la divisa para las compras in-app. El código de divisa debe ser un código ISO 4217 de 3 caracteres.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | currencyCode | 3 character ISO 4217 code. Defaults to "USD" . |
Devoluciones
void
.
setCustomerIdAndLogSession
Before calling this method, the method
waitForCustomerUserId
must be called
Firma de método
void setCustomerIdAndLogSession(java.lang.String id,
Context context)
Descripción
Se utiliza para configurar el ID de usuario del cliente e inicia el SDK.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | id | ID de cliente para el cliente. |
String | context | Contexto de actividad / aplicación. |
Devoluciones
void
setCustomerUserId
Firma de método
void setCustomerUserId(java.lang.String id)
DescripciónAl establecer tu propio ID de cliente, podrás establecer referencias cruzadas entre tu propio ID exclusivo, el ID exclusivo de AppsFlyer y los ID de los otros dispositivos.
El ID está disponible en los reportes de raw data y en las API de postback para hacer establecer referencias cruzadas con tus ID internos.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | id | ID de cliente para el cliente. |
Devoluciones
void
.
setDebugLog
Firma de método
void setDebugLog(boolean shouldEnable)
Descripción
Habilita los registros de depuración para el SDK de AppsFlyer. Solo debe configurarse como verdadero en entornos de desarrollo.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | shouldEnable | Por defecto, false . |
Devoluciones
void
.
Ejemplo de uso
setDisableAdvertisingIdentifiers
Agregado en V6.3.2
Firma de método
void setDisableAdvertisingIdentifiers(boolean disable);
Descripción
Deshabilita la recopilación de varios ID de publicidad por parte del SDK. Esto incluye Google Advertising ID (GAID), OAID y Amazon Advertising ID (AAID).
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | disable | Por defecto, false . |
Devoluciones
void
.
setDisableNetworkData
Añadido en V6.7.0
Firma de método
void setDisableNetworkData(boolean disable);
Descripción
Se utiliza para la exclusión opcional de la recopilación del nombre del operador de red (compañía) y del nombre del operador de la SIM del dispositivo.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | disable | Por defecto, false . |
Devoluciones
void
.
setExtension
Firma de método
void setExtension(java.lang.String extension)
Descripción
Los plugins y extensiones del SDK configurarán este campo.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | extension | Nombre de extensión. |
Devoluciones
void
.
setHost
Firma de método
void setHost(java.lang.String hostPrefixName,
java.lang.String hostName)
Descripción
Configura un host personalizado. Nota: Al iniciar el SDK V6.10, si el host se envía con un valor vacío o nulo, se ignora la llamada a la API.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | hostPrefixName | Prefijo de host. |
String | hostName | Nombre de host. |
Devoluciones
void
.
setImeiData
Firma de método
void setImeiData(java.lang.String aImei)
Descripción
De manera predeterminada, el SDK no recopila el IMEI ni el ID de Android si la versión del sistema operativo es superior a KitKat (4.4) y el dispositivo contiene servicios de Google Play.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | aImei | IMEI de dispositivo. |
Devoluciones
void
.
setIsUpdate
Firma de método
void setIsUpdate(boolean isUpdate)
Descripción
Configurar manualmente que la aplicación estaba actualizada.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | isUpdate |
Devoluciones
void
.
setLogLevel
Firma de método
void setLogLevel(AFLogger.LogLevel logLevel)
Descripción
Configura el nivel de registro del SDK.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | logLevel | Nivel de registro. |
Devoluciones
void
.
setMinTimeBetweenSessions
Firma de método
void setMinTimeBetweenSessions(int seconds)
Descripción
Configura un valor personalizado para el tiempo mínimo requerido entre sesiones.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
int | seconds | Establece el tiempo mínimo que debe transcurrir entre dos lanzamientos de la aplicación para que cuenten como dos sesiones separadas. Si no se establece, el tiempo mínimo predeterminado entre sesiones es de 5 segundos. |
Devoluciones
void
.
setOaidData
Firma de método
void setOaidData(java.lang.String oaid)
Descripción
De forma predeterminada, el SDK no recopila el OAID. Usa esta API para enviar explícitamente el OAID a AppsFlyer.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | oaid | OAID del dispositivo. |
Devoluciones
void
.
setOneLinkCustomDomain
Firma de método
void setOneLinkCustomDomain(java.lang.String... domains)
Descripción
Para que el SDK de AppsFlyer resuelva con éxito los parámetros de atribución ocultos (decodificados en ID de enlace corto), cualquier dominio que se configure como un dominio de marca en el panel de control de AppsFlyer debe proporcionarse a este método.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String... | domains | Matriz de dominios que el SDK debe tratar como dominios de marca (el SDK intentará resolverlos como OneLinks). |
Devoluciones
void
.
setOutOfStore
Firma de método
void setOutOfStore(java.lang.String sourceName)
Descripción
Especifica la tienda de aplicaciones alternativa de la cual se descargó la aplicación.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | sourceName | Nombre de tienda de aplicaciones de terceros. |
Devoluciones
void
.
Ejemplo de uso
AppsFlyerLib.getInstance().setOutOfStore("baidu");
AppsFlyerLib.getInstance().setOutOfStore("baidu")
setPartnerData
Firma de método
void setPartnerData(@NonNull String partnerId, Map<String, Object> data);
Descripción
Permite enviar datos personalizados para fines de integración de partners.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | partnerId | ID del partner (generalmente con el sufijo "_int"). |
Map | data | Los datos del cliente dependen de la configuración de integración con el partner específico. |
Devoluciones
void
.
Ejemplo de uso
Map<String, Object> partnerData = new HashMap();
partnerData.put("puid", "123456789");
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData);
val partnerData = mapOf("puid" to "123456789")
AppsFlyerLib.getInstance().setPartnerData("test_int", partnerData)
setPhoneNumber
Firma de método
void setPhoneNumber(java.lang.String phoneNumber)
Descripción
Se enviará como una cadena encriptada SHA-256.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | phoneNumber |
Devoluciones
void
.
setPreinstallAttribution
Firma de método
void setPreinstallAttribution(java.lang.String mediaSource,
java.lang.String campaign,
java.lang.String siteId)
Descripción
Especificar el nombre del fabricante o de la fuente de medios al que se atribuye la preinstalación.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String | mediaSource | Nombre del fabricante o fuente de medios para la atribución previa a la instalación. |
String | campaign | Nombre de la campaña para la atribución de preinstalación. |
String | siteId | ID de sitio para la atribución de preinstalación. |
Devoluciones
void
.
setResolveDeepLinkURLs
Firma de método
void setResolveDeepLinkURLs(java.lang.String... urls)
Descripción
Los anunciantes pueden encapsular un OneLink de AppsFlyer dentro de otro enlace universal. Este enlace universal invocará la aplicación, pero los datos de enlaces profundos no se propagarán a AppsFlyer.
setResolveDeepLinkURLs
te permite configurar el SDK para resolver las URL de OneLink encapsuladas, de modo que los enlaces profundos puedan ocurrir correctamente.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String... | urls | Asegúrate de proporcionar URL explícitas. |
Devoluciones
void
Ejemplo de uso
AppsFlyerLib.getInstance().setResolveDeepLinkURLs("clickdomain.com", "myclickdomain.com", "anotherclickdomain.com");
setSharingFilterForPartners
Agregado en V6.4
Firma de método
void setSharingFilterForPartners(java.lang.String... partners)
This function replaces the deprecated setSharingFilter
and setSharingFilterForAllPartners
Descripción
Te permite configurar cómo deben excluirse los partners del SDK del uso compartido de datos.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
String... | partners | Uno o más identificadores de partners que deseas excluir. Debes incluir solo letras/dígitos y guiones bajos. Longitud máxima del ID de partner: 45 |
Nota:
Make sure to use the exact partner ID (PID). Failing to do so may result in privacy-preservation breaches.
To find out the required partner IDs:
- Ejecuta la API para Obtener las integraciones activas para obtener una lista de todas las integraciones activas.
- Utiliza el método
media_source_name
de la respuesta API como valores de entrada a la matrizpartners
del método.
Excepciones:
- For Twitter, use
twitter
(y notwitter_int
)
Ejemplo de uso
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int"); // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int"); // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all"); // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners(); // Reset list (default)
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int") // Single partner
AppsFlyerLib.getInstance().setSharingFilterForPartners("partner1_int", "partner2_int") // Multiple partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("all") // All partners
AppsFlyerLib.getInstance().setSharingFilterForPartners("") // Reset list (default)
setSharingFilter
Obsoleto en V6.4
Firma de método
void setSharingFilter(java.lang.String... partners)
This function is deprecated and has been replaced by setSharingFilterForPartners
Descripción
Stops events from propagating to the specified AppsFlyer partners.
(Deprecated and replaced by setSharingFilterForPartners)
Input arguments
Tipo | Nombre | Descripción |
---|---|---|
String... | partners | Uno o más identificadores de partners. Debe incluir solo letras/dígitos y guiones bajos. Longitud máxima: 45 |
Devoluciones
void
setSharingFilterForAllPartners
Obsoleto en V6.4
Firma de método
void setSharingFilterForAllPartners()
This function is deprecated and has been replaced by setSharingFilterForPartners
Descripción
Evita que los eventos se propaguen a todos los partners de AppsFlyer. Sobreescribe setSharingFilter
.
Argumentos de entrada
Esta función no toma parámetros.
Devoluciones
void
setUserEmails
Firma de método
void setUserEmails(AppsFlyerProperties.EmailsCryptType cryptMethod,
java.lang.String... emails)
Descripción
Configura los correos electrónicos de los usuarios y los encripta.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
AppsFlyerProperties.EmailsCryptType | cryptMethod | Métodos de encriptación:
|
String... | emails | Uno o más correos electrónicos de usuarios. |
Devoluciones
void
.
start
Firma de método
void start(Context context,
java.lang.String key,
AppsFlyerRequestListener listener)
Descripción
Iniciar el SDK.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de la aplicación si se llama en la aplicación, en la método onCreate , Contexto de actividad si llama después del método de actividad onResume . |
String | key | Tu clave de desarrollador de AppsFlyer |
AppsFlyerRequestListener | listener | (Opcional) Agente de escucha para obtener el estado de la solicitud. |
Devoluciones
void
.
Ejemplo de uso
Consulta integrar el SDK para ver una implementación de ejemplo.
stop
Firma de método
void stop(boolean shouldStop,
Context context)
Descripción
Una vez invocada esta API, nuestro SDK ya no se comunicará con nuestros servidores y dejará de funcionar.
Útil al implementar la opción de optar por recopilar/optar por no recopilar.
Reinicio del SDK
Después de
stop(true)
se llamó, debes llamar astop(false)
y solo entonces llamar astart()
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | shouldStop | debe detenerse el registro. |
Context | context | Contexto de actividad / aplicación. |
Devoluciones
void
.
subscribeForDeepLink
Firma de método
void subscribeForDeepLink(DeepLinkListener deepLinkListener,
long timeout)
Descripción
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
DeepLinkListener | deepLinkListener | |
long | timeout | Opcional. Unidades en milisegundos |
Devoluciones
void
unregisterConversionListener
Firma de método
void unregisterConversionListener()
Descripción
Anula el registro de un previamente registrado AppsFlyerConversionListener
.
Argumentos de entrada
Esta función no toma parámetros.
Devoluciones
void
updateServerUninstallToken
Firma de método
void updateServerUninstallToken(Context context,
java.lang.String token)
Descripción
Para los desarrolladores que usan Firebase con otros fines aparte de la medición de desinstalaciones. Para más información, consulta la sección sobre medición de desinstalaciones.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
String | token | Token del dispositivo de Firebase. |
Devoluciones
void
Ejemplo de uso
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
AppsFlyerlib.getInstance().updateServerUninstallToken(getApplicationContext(), <TOKEN>);
validateAndLogInAppPurchase
Added in v6.14.0
Firma de método
public abstract void validateAndLogInAppPurchase(@NonNull AFPurchaseDetails purchaseDetails,
@Nullable Map<String, String> additionalParameters,
@Nullable AppsFlyerInAppPurchaseValidationCallback validationCallback);
Descripción
The method validates a purchase event with the store and if the validation is successful, the SDK sends an af_purchase
event to AppsFlyer.
See detailed instructions in Validate and log in-app purchase.
Argumentos de entrada
Nombre | Tipo | Descripción |
---|---|---|
purchaseDetails * | AFPurchaseDetails | An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method. |
additionalParameters | Map<String, String> | Additional parameters to log with the purchase. |
validationCallback * | AppsFlyerInAppPurchaseValidationCallback ` | A callback for delivering validation results. |
Devoluciones
void
AFPurchaseDetails
An object that encapsulates all data related to the purchase provided to the validateAndLogInAppPurchase method.
data class AFPurchaseDetails(
val purchaseType: AFPurchaseType,
val purchaseToken: String,
val productId: String,
val price: String,
val currency: String
)
AFPurchaseDetails parameters
Nombre | Tipo | Descripción |
---|---|---|
purchaseType | AFPurchaseType | Field to distinguish between one-time purchases and subscriptions. The field can accept either subscription or one-time-purchase. |
purchaseToken | String | Token that uniquely identifies a purchase for a given item and user pair. Part of the Billing Library's Purchase class . To retrieve the token call the getPurchaseToken API |
productId | String | ID of the product item that has been purchased. Also part of the Billing Library's Purchase class . |
price | String | The full price of the one-time purchase or the subscription. Also part of the Billing Library's Purchase class . |
currency | String | Currency used to make the purchase. |
validateAndLogInAppPurchase (LEGACY)
Deprecated in v6.4
Firma de método
void validateAndLogInAppPurchase(Context context,
java.lang.String publicKey,
java.lang.String signature,
java.lang.String purchaseData,
java.lang.String price,
java.lang.String currency,
java.util.Map<java.lang.String,java.lang.String> additionalParameters)
Descripción
API para la verificación del servidor de las compras in-app. Un evento af_purchase
con los valores pertinentes se enviará automáticamente si la validación tiene éxito.
Consulta las instrucciones detalladas en la validación de compras.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
Context | context | Contexto de actividad / aplicación. |
String | publicKey | Clave de licencia obtenida de Google Play Console. |
String | signature | data.INAPP_DATA_SIGNATURE from onActivityResult(int requestCode, int resultCode, Intent data) |
String | purchaseData | data.INAPP_PURCHASE_DATA from onActivityResult(int requestCode, int resultCode, Intent data) |
String | price | Precio de compra, debe derivarse de skuDetails.getStringArrayList("DETAILS_LIST") |
String | currency | Divisa de compra, debe derivarse de skuDetails.getStringArrayList("DETAILS_LIST") |
Map<String, String> | additionalParameters | Parámetros a mano alzada que se registrarán con la compra (si está validado). |
Devoluciones
void
.
waitForCustomerUserId
Firma de método
void waitForCustomerUserId(boolean wait)
Descripción
Este método difiere de la inicialización del SDK, hasta que se proporciona un customerUserID
.
Todos los eventos in-app y cualquier otra llamada a la API SDK se descartan hasta customerUserID
se proporciona y registra.
Argumentos de entrada
Tipo | Nombre | Descripción |
---|---|---|
boolean | wait |
Devoluciones
void
.
Ejemplo de uso
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
AppsFlyerLib.getInstance().waitForCustomerUserId(true);
Actualizado hace 10 días