API maestra: métricas de adquisición de usuarios a través de API

Premium

De un vistazo: Obtén KPI seleccionados de LTV, actividad, retención, cohorte y rendimiento de campañas de Protect360 por API, en formato CSV o JSON. Selecciona 1 o más aplicaciones.

API maestra: métricas de adquisición de usuarios a través de API

API maestra:

  • Te permite obtener KPI seleccionados de LTV, actividad, retención, cohorte y rendimiento de campañas de Protect360. Los KPI disponibles son los KPI equivalentes a los que se encuentran en el panel de control, Resumen general, Activity, Retención, Cohorte y Protect360.
  • Se calcula diariamente. Los datos actualizados están disponibles para ti dentro de las 24 a 48 horas, dependiendo de la zona horaria específica de tu aplicación.
  • Es la infraestructura sobre la que se construye la tabla de pivote de AppsFlyer. 

Para usar la API maestra, define los datos que deseas ver (similar a la implementación de la Pull API). El resultado se devuelve como un archivo CSV o JSON. 

Para usar la API maestra:

  1. AppsFlyerAdmin_us-en.pngObtén el token de API. Un administrador deberá recuperar el token.
  2. Dale a tu desarrollador el token de API que se utilizará en el encabezado de autenticación.
  3. Proporciona a tus desarrolladores los parámetros que deben introducir cuando realicen la llamada a la API, como se describe en las secciones que siguen. Los parámetros determinan en qué se enfoca el reporte, cómo se organiza, y proporcionan un marco de tiempo para la presentación de reportes.
  4. Dile a tu desarrollador que siga las instrucciones de la API maestra en el centro de desarrolladores.

Parámetros de API

Parámetro

Valor Obligatorio
app_id
  • Identificador de la aplicación como se encuentra en AppsFlyer.
  • Inserta el ID de aplicación tal como se encuentra en AppsFlyer.
  • Agrega el prefijo ID a las aplicaciones iOS.
  • Usa todos los ID de aplicaciones para consultar todas tus aplicaciones.
desde

Límite inferior del rango de fechas de atribución de LTV.

  • Formato: cadena aaaa-mm-dd
  • Ejemplo: from: 2020-01-02
Sí 
a

Límite superior del rango de fechas de atribución de LTV.

  • Número de días en el rango: 1 a 31 días
  • Para un solo día: los valores from y to son idénticos. 
  • Formato: aaaa-mm-dd
  • Ejemplo: from: 2021-01-01, to: 2021-01-31 es 31 días.
 Sí
Agrupaciones

Agrupar por parámetros, separados por una coma. Consulta la tabla Agrupaciones para ver la lista disponible. 

Ejemplo: groupings=pid,geo

 Sí
KPIs

Lista de KPIs a incluir, cada uno separado por una coma. Consulta la tabla de KPIs a seguir para obtener una lista de KPIs.

Ejemplo: kpis=installs,clicks, impressions,sessions,retention_day_7

 Sí
Filters

Los datos se pueden filtrar usando una o más opciones de filtro.

No
Currency Para devolver datos usando el conjunto de divisas específico de la aplicación, establece currency=preferred. No
Timezone

Para devolver datos usando la zona horaria específica de la aplicación, establece timezone=preferred.  Consulta las reglas de localización 

No
Format

Por defecto, los datos de respuesta se reciben en formato de archivo CSV. Si prefieres obtener los datos en formato JSON, selecciona format=json.

No

Agrupaciones

Estas dimensiones se utilizan para recopilar los datos en grupos para permitir un análisis más fácil y preciso de la información. Puedes encontrar descripciones de estos campos aquí.

Agrupar por
nombre de API
Agrupar por nombre visible KPIs de LTV KPIs de retención KPIs de actividad Protect360 Cohorte

app_id

ID de aplicación

pid

Fuente de medios

af_prt

Agencia

No

c

Campaña

af_adset

Adset

No

No

af_ad

Anuncio

No

No

af_channel

Canal

No

af_siteid

ID de anunciante

af_keywords

Palabras clave

No

No

is_primary

Atribución primaria

No

No

af_c_id

ID de campaña

No

No

af_adset_id

ID de adset

No

No

No

af_ad_id

ID de anuncio

No

No

No

install_time

Hora de la Instalación

Sí*

attributed_touch_type

Tipo de Toque

No

geolocalización

Geolocalización

* En el contexto de los KPI de actividad, considera el tiempo de instalación como tiempo de evento. 

KPIs

Los KPI son las métricas utilizadas para obtener insights sobre el comportamiento de tu aplicación. Los KPI se agrupan por tipo en las pestañas que siguen. 

LTVRetenciónActividadCohorteProtect360
Valor de duración: eventos agregados segmentados por día de instalación y hasta hoy.
KPI del nombre de la API Descripción
Impresiones Número de impresiones en el periodo de tiempo seleccionado
clics Número de clics en el periodo de tiempo seleccionado
instalaciones Número de instalaciones en el periodo de tiempo seleccionado
cr Tasa de Conversión
sesiones Número de sesiones creadas por los usuarios que instalaron la app en el periodo seleccionado
loyal_users Número de usuarios leales que instalaron la app en el periodo seleccionado
loyal_users_rate Usuarios leales / Instalaciones
costo

Costo total en el período seleccionado. Ver limitaciones

ingresos Ingresos de por vida generados por los usuarios que instalaron la app en el periodo seleccionado
roi Retorno de la inversión en un tiempo determinado
arpu_ltv Ingresos medios por usuario, para los usuarios que instalaron la app en el periodo seleccionado
average_ecpi Costo efectivo por instalación (eCPI) a lo largo de un cierto período de tiempo. Disponible solo si el costo y las instalaciones están incluidas en la llamada. 
desinstalaciones Desinstalación de usuarios que instalaron la app en el periodo seleccionado
uninstalls_rate Tasa de desinstalación
event_counter_[event_name] Cantidad de ocurrencias de eventos
unique_users_[event_name] Cantidad de usuarios únicos que realizaron el evento
sales_in_usd_[event_name] Ingresos declarados como parte de los hechos declarados

KPIs calculados

Ademas de los KPIs descritos anteriormente, puedes añadir KPIs calculados a tus reportes de master API.Esto te permite tener tus propios reportes calculados incluidos en tus tus reportes de master API.

Puedes insertar cualquier número de objetos de KPI integrados en las fórmulas KPI calculadas. Cada objeto de KPI de cálculo incluye una clave y un valor. La clave es el nombre que le das al KPI y el valor es la fórmula del KPI.

Se admiten los operadores aritméticos estándar: suma (+) codificada como %2b, resta (-), multiplicación (*), división (/) codificada como %2f.

Las claves de campo KPI calculadas deben comenzar con "calculated_kpi_", seguido de cualquier cadena válida, como, "calculated_kpi_purchaserate".

 Ejemplo

Retención combinada de los primeros tres días

kpis=installs,loyal_users_rate&calculated_kpi_3days_retention=
retention_day_1%2Bretention_day_2%2Bretention_day_3

Ingresos medios por impresión

kpis=installs&calculated_kpi_rev_per_impression=revenue%2Fimpression

Cohort del ROI del día 7

kpis=installs,roi,arpu_ltv,cost,revenue&calculated_kpi_roi_day_7=
(cohort_day_7_total_revenue_per_user-average_ecpi)%2Faverage_ecpi

Filtros (opcional)

Parámetro Descripción Ejemplo Obligatorio?

pid

  • Se utiliza para seleccionar las filas, en las que se muestran las fuentes de medios especificadas.
  • Se admite la selección múltiple separada por comas.

pid=organic,applovin_int

No

c

  • Se utiliza para filtrar por nombre de campaña.
  • Se admite la selección múltiple separada por comas.

c=my_sample_campaign

No

af_prt

  • Se utiliza para filtrar por nombre de agencia.
  • Se admite la selección múltiple separada por comas.

af_prt=moburst

No

af_channel

  • Se utiliza para filtrar por nombre de canal.
  • Se admite la selección múltiple separada por comas.

af_channel=Instagram

No

af_siteid

  • Se utiliza para filtrar por ID de anunciante.
  • Se admite la selección múltiple separada por comas.

af_siteid=12345678

No

geolocalización

  • Se utiliza para filtrar por país.
  • Se admite la selección múltiple separada por comas.

geo=US,DE

No

Localización

La divisa local y la zona horaria específica de la aplicación se establecen en la página de configuración de la aplicación. Los datos de la API maestra pueden extraer los datos utilizando la divisa y la zona horaria predeterminadas del sistema o usando la región y la divisa específicas de la aplicación. 

Se aplica lo siguiente:

  • El uso de la zona horaria/divisa específica de la aplicación solo se admite si todas las aplicaciones tienen la misma zona horaria/divisa. De lo contrario, se utilizan UTC y USD. La zona horaria y la divisa son independientes. Eso significa que, si la divisa de todas las aplicaciones es la misma pero las zonas horarias no lo son, entonces puedes usar la divisa específica de la aplicación, pero no la zona horaria específica de la aplicación. 
  • Si la zona horaria preferida se cambió en el panel de control del período solicitado, el reporte generado contiene valores a partir del cambio de zona horaria más reciente.

Utiliza los siguientes parámetros para seleccionar la configuración específica de la aplicación. Nota: Si no usas los parámetros preferidos, obtienes la configuración predeterminada, que es USD para la divisa y UTC para la zona horaria. 

Parámetro Descripción Ejemplo Obligatorio?

divisa

Los valores monetarios están en la divisa específica de la app

divisa=preferida

No

huso horario

La zona horaria utilizada coincide con la zona horaria específica de la aplicación.

huso horario=preferido

No

Información adicional

Características y limitaciones

Característica Observaciones 
Datos de costos
  • La disponibilidad de diferentes dimensiones de costo, es decir, conjunto de anuncios, anuncio, geolocalización, canal e ID de sitio, dependen de la red de publicidad
  • Para obtener el eCPI: si los datos de costos están disponibles, incluye tanto las instalaciones como el costo en la llamada. 
  • En general, todas las fuentes, incluidos los medios propios, que utilizan enlaces de AppsFlyer y tienen el parámetro de costo en los enlaces, soportan completamente los datos de costos, independientemente de las dimensiones solicitadas. Las redes de autorreporte, con API propia, suelen soportar datos de costos con solo algunas de las dimensiones disponibles. Por ejemplo, Anuncios de Meta no admite la agrupación por geolocalización y canal en la misma llamada. Se admite la agrupación por cualquiera de ellos por separado.
  • Las campañas que tienen datos de costos, pero no datos de instalaciones en el pasado reciente (aprox. 7 días), no están disponibles a través de la API maestra.
Agrupaciones

Las agrupaciones específicas solo están disponibles para los KPI de LTV, KPI de actividad o retención. La API devuelve N/A cuando los datos de un KPI específico no están disponibles. Por ejemplo, al solicitar retention_rate_day_7 agrupado por af_channel, devuelve N/A.

Máximo de filas por reporte 200 000
Nombres de los eventos

Actualmente, la API maestra no admite nombres de eventos que incluyan una barra inclinada / . Para superar esta limitación, evita el uso de / en nombres de eventos. 

Tiempo de procesamiento Seleccionar más de una aplicación aumenta el tiempo de procesamiento y la respuesta puede tardar más tiempo.
Rango de fechas La granularidad del período es diaria. 
Agencias API maestra no disponible
Redes de publicidad API maestra no disponible
Historial de datos
  • Datos de LTV: 5 años
  • Datos de cohortes (cohorte diaria): 2 años
  • Datos de actividad: 3 años
Retargeting No se admite