Pull API: Extracción de reportes de AppsFlyer mediante API

Los reportes de raw data proporcionan todos los datos para las instalaciones y los eventos in-app.

Parámetros de la API (obligatorios)

api_token

Es la clave de autorización externa de la API del usuario: "{Account owner API Key should be used}"

from

Fecha de inicio del reporte en el formato de "aaaa-mm-dd" o "aaaa-mm-dd hh:mm". Por ejemplo: 2010-01-01 o 2010-01-01%2000%3A15 - (El parámetro de horas es para los reportes de raw data solamente).

to

Fecha de finalización del reporte. El mismo formato que desde

Parámetros de filtrado de la API (opcionales)

Filtro por fuente de medios

El filtro para que solo se muestre una fuente de medios específica puede aplicarse agregando los parámetros de fuente de medios y categoría a la URL solicitada:

categoría

Para obtener los datos de Facebook, defina category=facebook en la URL. Para obtener los datos de Twitter, defina category=twitter en la URL. Para cualquier otra fuente de medios específica, defina category=standard.

media_source

Proporcione el nombre de una sola fuente de medios (media_source=[SOURCE_NAME]), tal como aparece en el panel de control de AppsFlyer.

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

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

Filtro por nombre de evento

Filtre los raw data de reportes de eventos in-app para incluir solo un evento específico mediante el uso del parámetro event_name. Para filtrar varios eventos, use una lista de eventos separados por coma.

Por ejemplo: event_name=af_purchase,ftd

Para exportaciones de retargeting

Use reattr=true para obtener resultados atribuidos a campañas de retargeting.

Campos adicionales

A través de Pull API, puede agregar ciertos campos que podrían completar el panorama de instalaciones de raw data y de eventos in-app en algunos casos.

Para agregar campos nuevos, añade "&additional_fields=" al enlace de seguimiento, seguido de la lista de campos adicionales separados por coma. Consulte los ejemplos de Pull API a continuación.

El resultado es un reporte CSV con columnas adicionales que contienen información, siempre que sea relevante.

Zona horaria y moneda

zona horaria (opcional)

Puede obtener los raw data de Pull API en CUALQUIER zona horaria válida:

1. Agregue &timezone=[Joda-Time] en el enlace de Pull API para recibir el reporte con la zona horaria preferida (consulte la nota a continuación)
2. 2. Agrega &timezone=[Numerical value] en el enlace Pull API para recibir el reporte con la zona horaria numérica especificada. Por ejemplo: para la zona horaria UTC+10:00, agrega el enlace &timezone=%2B10:00.
   El uso de un valor numérico para la zona horaria solo es posible cuando se extraen reportes de datos sin procesar (raw data). No funciona con reportes agregados como los reportes de desempeño.
3. De lo contrario, los datos se reciben con la zona horaria UTC predeterminada.

moneda (opcional)

Se usa para recibir los datos de ingresos y costos en su moneda seleccionada, en lugar de mostrarse en USD, que es la opción predeterminada. Lo define el administrador de la cuenta.

Para recibir datos en su moneda preferida, agregue lo siguiente a su enlace de solicitud: &currency=preferred

Se usa para recibir datos de ingresos y costos en su moneda seleccionada.

Política de API y limitaciones de uso

La Política de API de AppsFlyer garantiza excelente calidad de servicio a los usuarios de Pull API al limitar el número total de solicitudes diarias y al impedir el abuso del servicio.

Consulte los detalles sobre la política de API respecto de los datos agregados a través de Pull API y de los raw data a través de Pull API.

La cantidad máxima de registros por reporte es de 200.000. Si obtiene un reporte con 200.000 filas, habrá algunos resultados que quedarán afuera.

Seguridad de la API

Todos los enlaces de Pull API usan conexiones https seguras encriptadas.

Para conocer más detalles, ingrese aquí.

Ejemplos de enlaces de Pull API

Versión de la API (V5)

• Sin modificar:

  • La API (v4) existente sigue estando disponible para su uso

  • La versión no aplica ningún cambio al formato de archivo ni a encabezados

Los reportes de rendimiento ofrecen detalles sobre la efectividad de las campañas de anuncios.

Parámetros de la API (obligatorios)

api_token

Es la clave de autorización externa de la API del usuario: "{Account owner API Key should be used}". El token de la API se muestra SOLAMENTE al propietario de la cuenta.

Parámetros de filtrado de la API (opcionales)

Filtro por fuente de medios

El filtro para que solo se muestre una fuente de medios específica puede aplicarse agregando los parámetros de fuente de medios y categoría a la URL solicitada:

categoría

Para obtener los datos de Facebook, defina category=facebook en la URL. Para cualquier otra fuente de medios específica, defina category=standard

media_source

Proporcione el nombre de una sola fuente de medios (media_source=[SOURCE_NAME]), tal como aparece en el panel de control de AppsFlyer.

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

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

Zona horaria y moneda

zona horaria (opcional)

Puede obtener los datos agregados a través de Pull API en UTC o en la zona horaria preferida para la aplicación, la cual se define en la página de configuración de la aplicación:

1. Agregue &timezone=[selected Joda-Time] en el enlace de Pull API para recibir el reporte con la zona horaria preferida para la aplicación (consulte la nota a continuación)

2. De lo contrario, los datos se reciben con la zona horaria de UTC predeterminada.

moneda (opcional)

Se usa para recibir los datos de ingresos y costos en su moneda seleccionada, en lugar de mostrarse en USD, que es la opción predeterminada. Lo define el administrador de la cuenta.

currency=preferred

Se usa para recibir datos de ingresos y costos en su moneda seleccionada.

Política de API

La Política de API de AppsFlyer garantiza excelente calidad de servicio a los usuarios de Pull API al limitar el número total de solicitudes diarias y al impedir el abuso del servicio.

La cantidad máxima de registros por reporte es de 200.000. Si obtiene un reporte con 200.000 filas, habrá algunos resultados que quedarán afuera.

Seguridad de la API

Todos los enlaces de Pull API usan conexiones https seguras encriptadas.

Para conocer más detalles, ingrese aquí.

Ejemplos de enlaces de Pull API

Versión de la API (V5)

• Cambios:

  • Los reportes de rendimiento en la versión (v5) que contienen varios partners agrupan datos de Facebook por campaña únicamente. Los reportes de rendimiento que contienen datos de Facebook únicamente (mediante la especificación de &category=facebook) agrupan datos por campaña y grupo de anuncios.

  • La página de exportación de datos para reportes agregados emplea la versión v5 de la API.

• Sin modificar:

  • La API (v4) existente sigue estando disponible para su uso

  • La versión no aplica ningún cambio al formato de archivo ni a encabezados

Datos P360 agregados tal como aparecen en la tabla de detección avanzada en el panel de control.

Parámetros de la API (obligatorios)

api_token

Es la clave de autorización externa de la API del usuario: "{Account owner API Key should be used}"

from

Fecha de inicio del reporte en el formato de "aaaa-mm-dd" o "aaaa-mm-dd hh:mm". Por ejemplo: 2010-01-01 o 2010-01-01%2000%3A15 - (El parámetro de horas es para los reportes de raw data solamente).

to

Fecha de finalización del reporte. El mismo formato que para desde

KPI - Obligatorios

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

Para obtener la lista de KPI disponibles y sus descripciones, ingresa aquí.

Parámetros de filtrado de la API (opcionales)

Filtro por fuente de medios

Para filtrar los reportes de modo tal que solo se muestre una fuente de medios específica, se debe agregar:
pid=media source name.

Zona horaria y moneda

zona horaria (opcional)

Puede obtener los datos agregados P360 a través de Pull API con la zona horaria UTC o la zona horaria preferida de la aplicación, que se define en la página de Configuración de la aplicación:

1. Agregue &timezone=preferred en el enlace de Pull API para recibir el reporte en la zona horaria preferida para la aplicación.

2. De lo contrario, los datos se reciben con la zona horaria de UTC predeterminada.

moneda (opcional)

Se usa para recibir los datos de ingresos y costos en su moneda seleccionada, en lugar de mostrarse en USD, que es la opción predeterminada. Lo define el administrador de la cuenta.

currency=preferred

Se usa para recibir datos de ingresos y costos en su moneda seleccionada.

Seguridad de la API

Todos los enlaces de Pull API usan conexiones https seguras encriptadas.

Para conocer más detalles, ingrese aquí.

Ejemplos de enlaces de Pull API

Versión de la API (V5)

• Cambios:

  • Los reportes de rendimiento en la versión (v5) que contienen varios partners agrupan datos de Facebook por campaña únicamente. Los reportes de rendimiento que contienen datos de Facebook únicamente (mediante la especificación de &category=facebook) agrupan datos por campaña y grupo de anuncios.

  • La página de exportación de datos para reportes agregados emplea la versión v5 de la API.

• Sin modificar:

  • La API (v4) existente sigue estando disponible para su uso

  • La versión no aplica ningún cambio al formato de archivo ni a encabezados

Scripts para recuperar datos de Pull API

A menudo, es más conveniente configurar scripts automáticos para recuperar datos de manera periódica.

A continuación, puede encontrar scripts para recuperar datos de Pull API. Los scripts de muestra extraen datos del reporte de instalación. Edite los scripts en base al reporte y a los datos que desea recuperar.

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);
    }
  }
}

request = require('request');
const fs = require('fs');

const appID = '<APP_ID>';
const reportType = '<REPORT_TYPE>';
const apiToken = '<API_TOKEN>';
const from = '<FROM_DATA>';
const to = '<T0_DATE>';
const requestUrl = `https://hq.appsflyer.com/export/${appID}/${reportType}/v5?api_token=${apiToken}&from=${from}&to=${to}`;

request(requestUrl, (error, response, body) => {
  if (error) {
    console.log('There was a problem retrieving data:', error);
  }
  else if (response.statusCode != 200) {
    if (response.statusCode === 404) {
      console.log('There is a problem with the request URL. Make sure that it is correct');
    } else {
      console.log('There was a problem retrieving data:', response.body);
    }
  } else {
    fs.writeFile(`${appID}-${reportType}-${from}-to-${to}.csv`, response.body, (err) => {
      if (err) {
        console.log('There was a problem writing to file: ', err);
      } else {
        console.log('File was saved');
      }
    });
  }
  
});

import requests

app_id = '<APP_ID>'
report_type = '<REPORT_TYPE>'

params = {
  'api_token': '<API_TOKEN>',
  'from': 'FROM_DATE',
  'to': 'TO_DATE'
}

request_url = 'https://hq.appsflyer.com/export/{}/{}/v5'.format(app_id, report_type)

res = requests.request('GET', request_url, params=params)

if res.status_code != 200:
  if res.status_code == 404:
    print('There is a problem with the request URL. Make sure that it is correct')
  else:
    print('There was a problem retrieving data: ', res.text)
else:
  f = open('{}-{}-{}-to-{}.csv'.format(app_id, report_type, params['from'], params['to']), 'w', newline='', encoding="utf-8")
  f.write(res.text)
  f.close()

using System;
using RestSharp;
using System.Text;
using System.Net;
using System.IO;
namespace Pull_API
{
  class PullAPi
  {
    static void Main(string[] args)
    {
      var appID = "<APP_ID>";
      var reportType = "<REPORT_TYPE>";
      var apiToken = "<API_TOKEN>";
      var from = "<FROM_DATE>";
      var to = "<TO_DATE>";

      var requestUrl = "https://hq.appsflyer.com/export/" + appID + "/" + reportType + "/v5?api_token=" + apiToken + "&from=" + from + "&to=" + to;
      
      var client = new RestClient(requestUrl);
      var request = new RestRequest(Method.GET);
      request.AddHeader("Accept", "text/csv; charset=UTF-8");

      IRestResponse response = client.Execute(request);
      HttpStatusCode statusCode = response.StatusCode;
      int numericStatusCode = (int)statusCode;

      if(numericStatusCode != 200){

        if(numericStatusCode == 404){
          Console.WriteLine("There is a problem with the request URL. Make sure that it is correct.");
        } else {
          Console.WriteLine("There was a problem retrieving data: " + response.Content); 
        }
      } else {
        System.IO.File.WriteAllText(@"" + appID + "-" + reportType + "-" + from + "-to-" + to + ".csv", response.Content);
        Console.WriteLine("Data retrieved succesfully"); 
      }
    }
  }
}

<?

$appID = '<APP_ID>';
$reportType = '<REPORT_TYPE>';
$apiToken = '<API_TOKEN>';
$from = '<FROM_DATE>';
$to = '<TO_DATE>';
$query = http_build_query([
'api_token' => $apiToken,
'from' => $from,
'to' => $to
]);
$requestUrl = 'https://hq.appsflyer.com/export/' . $appID . '/' . $reportType . '/v5?'.$query;
$report = $appID . '-' . $report . '-' . $from . '-to-' . $to; 

$curl = curl_init($requestUrl);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_ENCODING, "");
curl_setopt($curl, CURLOPT_NOSIGNAL, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_MAXREDIRS, 10);
curl_setopt($curl, CURLOPT_FAILONERROR, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 100);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
 "cache-control: no-cache",
 "Accept: text/csv; charset=UTF-8"
));


$response = curl_exec($curl);
$info = curl_getinfo($curl);
$err = curl_error($curl);
curl_close($curl);

var_dump($response);
if ($err) {
 echo $info['http_code']; 
 echo "cURL Error #: " . $err . '. ';
 if ($info['http_code'] == 404) {
  echo 'There is a problem with the request URL. Make sure that it is correct';
 } 
 if ($info['http_code'] == 401) {
  echo 'There was a problem retrieving data: authentication failed.';
 }
 
 echo PHP_EOL;

} else {
 $fp = fopen($report, 'w+');
 fwrite($fp, $response);
 fclose($fp);
 echo $response;
}
?>

Errores y solución de problemas de la API

En esta sección, se analizan los errores comunes de la API y la manera de lidiar con ellos.