Pulling reports using Pull API

Параметры API (обязательные)

api_token

Это ключ авторизации внешнего пользователя API: "{Account owner API Key should be used}".

from

Начальная дата отчета в формате "yyyy-mm-dd" или "yyyy-mm-dd hh:mm". Например, 2010-01-01 или 2010-01-01%2000%3A15 (параметр времени используется только для отчетов о необработанных данных).

to

Конечная дата отчета. Тот же формат, что и у параметра from.

Параметры фильтрации API (необязательные)

Фильтрация по исходной точке взаимодействия

Если нужно отфильтровать отчеты только по определенной исходной точке взаимодействия, добавьте одновременно параметры категории и исходной точки взаимодействия в URL-адрес запроса:

category

Чтобы получить данные Facebook, добавьте в URL-адрес category=facebook. Чтобы получить данные Twitter, добавьте в URL-адрес category=twitter. Для других исходных точек взаимодействия используйте category=standard.

media_source

Укажите название одной исходной точки взаимодействия (media_source=[НАЗВАНИЕ_ИСТОЧНИКА]) в том виде, в котором она отображается на панели управления 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

Фильтрация по имени события

Чтобы необработанные данные отчетов о внутренних событиях приложения содержали только определенное событие, отфильтруйте их с помощью параметра event_name. Чтобы включить в данные несколько событий, перечислите эти события через запятую.

Пример: event_name=af_purchase,ftd.

Экспорт данных ретаргетинга

Используйте параметр reattr=true, чтобы получить результаты, относящиеся к ретаргетинговым кампаниям.

Дополнительные поля

С помощью Pull API можно добавлять поля, которые в некоторых случаях дополняют картину необработанных данных об установках и внутренних событиях приложений.

Чтобы добавить новые поля, добавьте в ссылку атрибуции параметр "&additional_fields=", а затем перечислите эти поля через запятую. Примеры Pull API приведены ниже.

Результатом будет отчет в формате CSV с дополнительными столбцами, содержащими соответствующую информацию, если она актуальна для поля.

Часовой пояс и валюта

timezone (необязательный параметр)

Необработанные данные Pull API можно получить в ЛЮБОМ действительном часовом поясе.

1. Добавьте &timezone=[значение Joda-Time] в ссылку Pull API, чтобы получить отчет в нужном часовом поясе (см. примечание ниже).
2. Добавьте &timezone=[числовое значение] в ссылку Pull API, чтобы получить отчет в часовом поясе, соответствующем указанному числовому значению. Например, если нужно получить отчет в часовом поясе UTC+10:00, добавьте к ссылке &timezone=%2B10:00
   Использование числового значения для часового пояса возможно только при получении отчетов о необработанных данных. Оно не действует для сводных отчетов, таких как отчеты об эффективности.
3. Если часовой пояс не указать, данные по умолчанию поступают в часовом поясе UTC +0.

currency (необязательный параметр)

Используется для получения данных о доходе и расходах в валюте, которую вы выберете вместо используемой по умолчанию валюты USD. Этот параметр настраивает администратор учетной записи.

Чтобы получить данные в предпочитаемой валюте, добавьте к ссылке запроса &currency=preferred.

Используется для получения данных о доходе и расходах в выбранной вами валюте.

Политика использования и ограничение права использования API

Политика API компании AppsFlyer обеспечивает высокий уровень услуг, предоставляемых пользователям Pull API. Для этого ограничивается общее количество запросов в день и принимаются меры по предотвращению злоупотребления службой.

См. подробные сведения о политике использования API для извлечения агрегированных данных и необработанных данных с помощью Pull API.

Максимальное количество записей в отчете составляет 200 тысяч. Если в полученном отчете 200 тысяч строк, это означает, что часть результатов в него не включена.

Безопасность API

Во всех ссылках Pull API используются HTTPS-соединения с шифрованием данных.

Примеры ссылок Pull API

Точный код API, в том числе токен API, можно получить в AppsFlyer. Выберите в разделе Integration (Интеграция) пункт API Access (Доступ к API).

Версия API (V5)

• Без изменений:

  • Существующий API (v4) до сих пор доступен для использования.

  • Формат файлов и заголовки в новой версии не изменены.

Сводные отчеты (об эффективности) содержат сведения об эффективности рекламных кампаний.  Эти отчеты могут содержать либо данные LTV, либо данные об активности, поэтому необходимо проверять спецификацию отчета.

Параметры API (обязательные)

api_token

Это внешний ключ авторизации API пользователя: "{Account owner API Key should be used}". Токен API видит ТОЛЬКО владелец учетной записи.

Параметры фильтрации API (необязательные)

Фильтрация по исходной точке взаимодействия

Если нужно отфильтровать отчеты только по определенной исходной точке взаимодействия, добавьте одновременно параметры категории и исходной точки взаимодействия в URL-адрес запроса:

category

Чтобы получить данные Facebook, добавьте в URL-адрес category=facebook. Для других исходных точек взаимодействия используйте category=standard.

media_source

Укажите название одной исходной точки взаимодействия (media_source=[НАЗВАНИЕ_ИСТОЧНИКА]) в том виде, в котором она отображается на панели управления 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

Часовой пояс и валюта

timezone (необязательный параметр)

Агрегированные данные можно получить с помощью Pull API в часовом поясе UTC или предпочитаемом часовом поясе приложения, который можно задать на странице App Settings ("Настройки приложения").

1. Добавьте &timezone=[значение Joda-Time] в ссылку Pull API, чтобы получить отчет в предпочитаемом часовом поясе приложения (см. примечание ниже).

2. Если часовой пояс не указать, данные по умолчанию поступают в часовом поясе UTC.

currency (необязательный параметр)

Используется для получения данных о доходе и расходах в валюте, которую вы выберете вместо используемой по умолчанию валюты USD. Этот параметр настраивает администратор учетной записи.

currency=preferred

Используется для получения данных о доходе и расходах в выбранной вами валюте.

Политика использования API

Политика API компании AppsFlyer обеспечивает высокий уровень услуг, предоставляемых пользователям Pull API. Для этого ограничивается общее количество запросов в день и принимаются меры по предотвращению злоупотребления службой.

Максимальное количество записей в отчете составляет 200 тысяч. Если в полученном отчете 200 тысяч строк, это означает, что часть результатов в него не включена.

Безопасность API

Во всех ссылках Pull API используются зашифрованные HTTPS-соединения.

Подробные инструкции см. здесь.

Примеры ссылок Pull API

Версия API (V5)

• Изменения:

  • В версии (v5) данные Facebook в отчетах об эффективности, содержащих нескольких партнеров, группируются только по кампаниям. В отчетах об эффективности, содержащих только данные Facebook (чтобы получить их, укажите &category=facebook), данные группируются по кампаниям и группам рекламных объявлений.

  • На странице экспорта данных для сводных отчетов используется API v5.

• Без изменений:

  • Существующий API (v4) до сих пор доступен для использования.

  • Формат файлов и заголовки в новой версии не изменены.

Вид сводных данных P360 в таблице расширенного выявления на панели управления.

Параметры API (обязательные)

api_token

Это ключ авторизации внешнего пользователя API: "{Account owner API Key should be used}".

from

Начальная дата отчета в формате "yyyy-mm-dd" или "yyyy-mm-dd hh:mm". Например, 2010-01-01 или 2010-01-01%2000%3A15 (параметр времени используется только для отчетов о необработанных данных).

to

Конечная дата отчета. Тот же формат, что и у параметра from.

KPI (обязательные)

Параметры Protect360 в Pull API и Master API одинаковы. 

Список доступных KPI и их описаниясм. здесь.

Параметры фильтрации API (необязательные)

Фильтрация по исходной точке взаимодействия

Чтобы отфильтровать отчеты только по определенной исходной точке взаимодействия, добавьте такой параметр:
pid=название исходной точки взаимодействия.

Часовой пояс и валюта

timezone (необязательный параметр)

Агрегированные данные P360 можно получить с помощью Pull API в часовом поясе UTC или предпочитаемом часовом поясе приложения, который можно задать на странице App Settings (Настройки приложения).

1. Добавьте &timezone=preferred в ссылку Pull API, чтобы получить отчет в предпочитаемом часовом поясе приложения.

2. Если часовой пояс не указать, данные по умолчанию поступают в часовом поясе UTC.

currency (необязательный параметр)

Используется для получения данных о доходе и расходах в валюте, которую вы выберете вместо используемой по умолчанию валюты USD. Этот параметр настраивает администратор учетной записи.

currency=preferred

Используется для получения данных о доходе и расходах в выбранной вами валюте.

Безопасность API

Во всех ссылках Pull API используются HTTPS-соединения с шифрованием данных.

Примеры ссылок Pull API

Примечание. Чтобы увидеть в Appsflyer все доступные ссылки Pull API In, выберите в разделе Integration (Интеграция) пункт API access (Доступ к API).

Версия API (V5)

• Изменения:

  • В версии (v5) данные Facebook в отчетах об эффективности, содержащих нескольких партнеров, группируются только по кампаниям. В отчетах об эффективности, содержащих только данные Facebook (чтобы получить их, укажите &category=facebook), данные группируются по кампаниям и группам рекламных объявлений.

  • На странице экспорта данных для сводных отчетов используется API v5.

• Без изменений:

  • Существующий API (v4) до сих пор доступен для использования.

  • Формат файлов и заголовки в новой версии не изменены.

Сценарии для получения данных из Pull API

Во многих случаях для регулярного получения данных удобно использовать автоматизированные сценарии.

Ниже приведены сценарии для получения данных из Pull API. В примерах сценариев продемонстрировано извлечение данных из отчета об установках. Измените сценарии в соответствии с отчетом и данными, которые вам нужно получить.

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

Ошибки API и устранение неисправностей

В этом разделе обсуждаются распространенные ошибки API и способы их устранения.