Aggregate data via Pull API in real-time

At a glance: Use URIs to get aggregate reports in CSV files.

PullAPIAggregateDate_us-en.jpg

 Are you looking for Pull API raw data?

Pull API raw data

Pull API aggregate data characteristics

  • Los reportes regresan como archivos CSV.
  • Las tasas de actualización de datos son las mismas que las del reporte equivalente en la página Datos exportados.
  • Las opciones de filtro son las mismas que en la página de Datos exportados: fuente de medios, rango de fechas, nombre del evento in-app. 
  • Las capacidades adicionales en la Pull API son las siguientes:
    • Posibilidad de filtrar por tipo de toque atribuido.
    • La zona horaria se puede seleccionar. 
  • La Pull API es adecuada para que la utilicen los miembros del equipo y desarrolladores de Business Intelligence.

Example URI template TemplateURL_us-en.jpg

Categoría Agregado (rendimiento) UA y retargeting* Protect360**
Partners (fuente de medios)

Partners por fecha

Diario

Geolocalización

Geolocalización por fecha

* Para los reportes de retargeting, agrega &reattr=true al URI. 

** Característica Premium. 

Aggregate reports, LTV based

 Lectura relacionada:

Terminología

Término Descripción
API pull

Solución para descargar reportes CSV utilizando URI.

Llamada de la API o llamada 

Enviar el URI a AppsFlyer pegándolo en la barra de dirección del navegador o usando scripts.

URI
  • Identificador de recursos uniforme, a veces similar a una dirección web (URL) que contiene la especificación del reporte.
  • Las plantillas de URI están disponibles en la página de la API en el Panel de control.

Guía para miembros del equipo.

Acerca de las plantillas de URI

  • Las plantillas de URI disponibles en el panel de control se rellenan con el ID de la aplicación y el tipo de reporte.
  • Tienen marcadores de posición para el token de la API y desde/hasta las fechas que necesitas editar.
  • La parte del URI a la derecha del signo de interrogación (?) contiene parámetros. Cada parámetro comienza con el signo &. Los parámetros se utilizan para establecer filtros, especificar campos adicionales a incluir, divisa y zona horaria. Por ejemplo, en reportes agregados para limitar (filtrar) una fuente de medios específica, usa el parámetro media_source: &media_source=facebook
  • Para obtener una mejor comprensión de la Pull API, completa el siguiente tutorial.

Obtener tu primer tutorial de reportes de la Pull API

Antes de comenzar:
  •  Ask the admin to provide you with the Pull API token available in the dashboard.

Descargar un reporte desde el panel de control: 

  1. Ve a Integración > Acceso a la API.
    Se abre la página de acceso a la API. PullAPIPartnersReport_us-en.jpg
  2. Selecciona un tipo de reporte. Por ejemplo, Reportes de rendimientoReporte diario de partners. 
    Aparece la plantilla de URI. 
  3. Copia el URI haciendo clic en él.
  4. Abre una pestaña nueva en tu navegador y pega el URI.
  5. Editar el URI:
    1. Replace the token placeholder with the Pull API token provided by the admin.
      Example: Replace the token placeholder so that &api_token=12345678-1234-1234-1234-123456789012 Note! There are no spaces or other punctuation. 
    2. Reemplaza los marcadores de posición from/to por fechas.
      Ejemplo: &from=2020-01-20&to=2020-01-31 Nota No hay espacios No elimines el signo &. 
  6. Haz clic en <Enter> para enviar la llamada de la API. 
    Se descarga el reporte.

Aggregate data Pull API parameters

Parámetros y URI del reporte agregado

Parámetros obligatorios de URI agregado 
Parámetro Descripción
api_token Token de autorización de API.En las llamadas de ejemplo, esto se muestra como: <API TOKEN HERE>. 
desde
  • El rango de fechas consiste en los parámetros fromto. El rango es el rango de valor de vida útil (LTV), que es la fecha de instalación.
  • Formato: yyyy-mm-dd, 
  • Ejemplo: 2010-01-01 o 2010-01-01
hasta Fecha de finalización. Igual que para from
Filtrado opcional de datos agregados y parámetros de visualización, sin incluir los reportes de Protect360
Parámetro Descripción
media_source

Usar para limitar (filtrar) a una fuente de medios específica.

  • Example:media_source=facebook
 attributed_touch_type

Configura este parámetro tal como se muestra en el ejemplo para obtener KPI de atribución por impresiones (VTA). 

Example: attribution_touch_type=impression

moneda

Divisa de ingresos y costos

Aggregate Pull API reports always use the app-specific currency. 

reattr

Obtén datos de atribución de retargeting.

  • [Predeterminado] Si es falso, las campañas de datos de adquisición de usuarios (UA) vuelven.
  • Si es verdadero, devuelve los datos de atribución de retargeting.
  • Ejemplo:reattr=true
Zona horaria

[Predeterminado] Los datos se devuelven utilizando UTC.

  • Las plantillas de URI se rellenan con el parámetro de zona horaria establecido en la zona horaria específica de la aplicación. 
  • [Predeterminado] Si el parámetro no se envía, los datos regresan usando UTC.
  • Si envías timezone=[Joda-Time], los datos se devuelven utilizando la zona horaria específica de la aplicación.

Notas sobre la selección de zonas horarias

  • El formato de zona horaria Joda-Time tiene en cuenta el horario de verano.
  • El valor de Joda-Time debe ser idéntico al valor definido en la página de configuración de la aplicación. Por ejemplo, si la zona horaria seleccionada en la configuración es París, el valor de la zona horaria de la URL de la Pull API debe ser timezone=Europe%2fParis.
  • La extracción de datos en la zona horaria seleccionada solo está disponible a partir de la fecha en la que se configuró la zona horaria. Cualquier dato anterior a la fecha del cambio usa UTC como la zona horaria. 

Reporte filtrado de Google Ads

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&media_source=googleadwords_int

Reporte filtrado de Facebook

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&&media_source=facebook
Parámetros opcionales para reportes de Protect360
Parámetro Descripción
 pid

Para filtrar el reporte por una fuente de medios específica, usa el parámetro pid. Por ejemplo, para obtener los datos de abc_net, pid=abc_net.

Zona horaria

Selecciona la zona horaria utilizada para devolver datos.

Si timezone no se envía, los datos se devuelven utilizando UTC.

Plantillas que incluyen el parámetro timezone

Ejemplo: timezone=preferred: se utiliza para obtener datos utilizando la zona horaria específica de la aplicación .

KPIs

Los parámetros de Protect360 son los mismos en Pull API y Master API. 

KPI de atribución por impresiones (VTA)

  • Para obtener los KPI de VTA, agrega el parámetro attribution_touch_type=impression  al URI del reporte agregado de la Pull API, tal como se detalla en el ejemplo.
  • You can use the parameter with any of the aggregate reports available. Just copy the URI from the user interface, and append the &attributed_touch_type=impression
  • También puedes agregar el parámetro &media_source  para limitar el reporte a una fuente de medios específica, tal como se muestra en el ejemplo a continuación.
  • Algunos KPI de VTA, como los clics, las impresiones y las API de costos, no tienen valores asociados y, en cambio, muestran el valor N/A. 
Ejemplo URI de ejemplo
Solo VTA  https://hq.appsflyer.com/export/{app_id}/partners_report/v5?api_token={API token}&from=yyyy-mm-dd&to=yyyy-mm-dd&attribution_touch_type=impression

VTA y fuente de medios

https://hq.appsflyer.com/export/{app_id}/partners_report/v5?api_token={API token}&from=yyyy-mm-dd&to=yyyy-mm-dd&aattribution_touch_type=impression&media_source=example_ad_network

Pull API para desarrolladores

Principios de implementación

Requisito previo:

Familiarízate con la guía de Pull API para los miembros del equipo.

Considera:

  • Para cada tipo de reporte disponible, hay una plantilla de URI en el panel de control.
  • Modifica la plantilla para obtener los datos que necesitas. Por ejemplo, al establecer rangos de fechas y filtrar por parámetros.
  • Los parámetros para reportes de raw data y de datos agregados difieren y se detallan en las secciones del reporte.
Conceptos básicos de la Pull API
Ruta

https://hq.appsflyer.com/export/app_id/report_type/v5

Parámetros de ruta

app_id

  • Identificador de la aplicación como se encuentra en AppsFlyer.
  • Inserta el ID de la aplicación tal como se encuentra en AppsFlyer.
  • Prefijar aplicaciones iOS con id

report_type 

  • Define el tipo de reporte. La lista de reportes y los URI asociados se encuentran en el panel de control. Ve a Integración > Acceso a la API. 
Método HTTP

GET

Parámetros obligatorios de la consulta
Parámetro Descripción
URI de ejemplo

GET 'https://hq.appsflyer.com/export/app_id/installs_report/v5? from=2020-01-01?&to=2020-01-10&api_token=api_token&currency=preferred

api_token

api_token: token de la Pull API para la autenticación

Otros parámetros

Los parámetros difieren en función de: 

 Ejemplo

El ejemplo de llamada de URI incluye parámetros adicionales: 

https://hq.appsflyer.com/export/example.app.com/installs_report/v5?
        api_token={Account owner API key should be used}&from=yyyy-mm-dd
&to=yyyy-mm-dd&additional_fields=keyword_id,store_reinstall,
deeplink_url,oaid,install_app_store,contributor1_match_type,
contributor2_match_type,contributor3_match_type,match_type

Scripts de ejemplo

Integra Pull API en scripts para recuperar datos.

  • Según sea necesario, edita los scripts en términos de tipo de reporte, rango de fechas y filtros. 
  • Estos ejemplos usan el reporte install.
JavaNode JSPythonC#PHP
import okhttp3.*;

import java.io.BufferedWriter;
import java.io.FileWriter;

import java.util.concurrent.TimeUnit;

public class PullApi {
  public static void main(String[] args){

    String appID = "<APP_ID>";
    String reportType = "<REPORT_TYPE>";
    String apiToken = "<API_TOKEN>";
    String from = "<FROM_DATE>";
    String to = "<TO_DATE>";
    String requestUrl = "https://hq.appsflyer.com/export/" + appID + "/" + reportType + "/v5?api_token=" + apiToken + "&from=" + from + "&to=" + to;

    OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(30, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)

        .build();

    Request request = new Request.Builder()
        .url(requestUrl)
        .addHeader("Accept", "text/csv")
        .build();

    try {
      Response response = client.newCall(request).execute();

      if(response.code() != 200) {
        if(response.code() == 404) {
          System.out.println("There is a problem with the request URL. Please make sure it is correct");
        }
        else {
          assert response.body() != null;
          System.out.println("There was a problem retrieving the data: " + response.body().string());
        }
      } else {
        assert response.body() != null;
        String data = response.body().string();
        BufferedWriter writer;

        writer = new BufferedWriter(new FileWriter(appID + "-" + reportType + "-" + from + "-to-" + to + ".csv"));
        writer.write("");
        writer.write(data);
        writer.close();
      }
      System.exit(0);
    } catch (Exception e) {
      e.printStackTrace();
      System.exit(1);
    }
  }
}

Información adicional

Diferencias entre Pull API V4 y V5. 

Raw data: API V4 todavía está disponible para su uso. No se realizan cambios en los formatos de archivo y encabezados.

Datos agregados (V5):

En V5.0, se proporcionan los siguientes campos adicionales cuando media_source=facebook:

  • ID de campaña
  • Nombre del conjunto de anuncios
  • ID de conjunto de anuncios
  • Nombre del anuncio (conjunto de anuncios)
  • ID del anuncio (conjunto de anuncios)

Rasgos y limitaciones

Característica
Característica Estado Comentarios 
Acceso a la red de publicidad   
Acceso de agencias  
Transparencia de Agencias  
Divisa específica de la aplicación  
Zona horaria específica de la aplicación  
Actualización de los datos tiempo real  
Historial de datos  
Datos no orgánicos  
datos orgánicos  
Limitación de velocidad

Limitaciones de la API para datos agregados y raw data

Limitaciones de tamaño
  • Las llamadas de la API devuelven un máximo de 200 000 filas.
  • Si un reporte tiene exactamente 200 000 filas, entonces asume que faltan filas.
  • Realiza múltiples llamadas a la API, utilizando los parámetros from/to que incluyan la hora del día.  
Acceso de miembros del equipo

Solo el administrador puede obtener el token de la Pull API.

Códigos de error y solución de problemas de la API

Códigos de error y soluciones
Estado Código Symtom/message SOLUCIÓN
OK 200 Archivo CSV vacío

addtional_fields aparece más de una vez en el URI

OK

200

Archivo CSV vacío

Ensure that both from and to dates have the format yyyy-mm-dd

Bad request

400

Raw Reports historical lookback is limited to 90 days.

Usa to y from para limitar el rango de fechas a 3 meses o menos.

Bad request

400

Your API calls limit has been reached for report type

-
No autorizado

401

El token suministrado de la API no es válido. 

Ask the admin for the current token
No autorizado

401

La cuenta puede ser suspendida.

Log in to the dashboard and check the account status. 

Not found

404

 

The token doesn't match the app. Ask the admin to give you the current token. 

¿Fue útil este artículo?

Artículos en esta sección