API отчетности версии 2.0 для рекламодателей

Содержание

Общие сведения

API отчетности предлагает рекламодателям программный способ доступа к данным, находящимся на панели управления. Ключ API отчетности одинаков для всех ваших приложений. У каждого приложения есть уникальный идентификатор API отчетности, который можно найти на соответствующей странице приложения.

Хост

Хост: https://report.api.vungle.com/ext/adv/reports/spend

Аутентификация

Безопасность регулируется в заголовке запроса. Найдите свой ключ API на странице отчетов панели управления Vungle. Если у вас еще нет ключа API, запросите его по электронной почте: tech-support@vungle.com.

Заголовки запросов

Ключ Значение Описание
Authorization: Bearer [API Key] Ключ API
Vungle-Version: 1 Версия API
Accept: text/csv или application/json Принятый формат данных для результатов. По умолчанию: text/csv.

 

Результаты

  • Формат. Мы поддерживаем выходные данные в форматах JSON и CSV (указывается в заголовке запроса).
  • Диапазон данных. Доступны хронологические данные за шесть месяцев. Если вам нужны более старые данные, обратитесь к своему менеджеру по работе с клиентами по электронной почте: tech-support@vungle.com.
  • Если данных нет. Имейте в виду, что если данные для вашего запроса не найдены, Vungle возвращает пустой ответ 200. Это означает, что запрос выполнен, но данных для возврата нет.

Ресурс: GET /reports/spend

Параметры фильтрации

Параметры фильтрации позволяют ограничить результаты подмножеством данных об издержках. Большинство фильтров необязательны, при их применении Vungle возвращает все результаты для такого фильтра.

Имя параметра Формат Действие Если недоступен Пример
start Дата ISO8601 Ограничивает набор результатов данными об издержках, полученными не ранее указанной даты Запрос отклоняется start=2017-01-01
end Дата ISO8601 Ограничивает набор результатов данными об издержках, полученными не позднее указанной даты Запрос отклоняется end=2017-01-02 
country  Список кодов стран по ISO 3166-1 Alpha-2 (с разделителями-запятыми) Возвращает только данные об издержках, соответствующие указанным странам Возвращает все страны

country=US

country=US,CA

country=US,CA,AU
applicationId  Список идентификаторов приложений Vungle для возврата (с разделителями-запятыми) Возвращает данные об издержках только для указанных приложений Возвращает все приложения

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
campaignId  Список идентификаторов кампаний Vungle (с разделителями-запятыми) Возвращает данные об издержках только для указанных кампаний Возвращает все кампании

campaignId=586e201e242e3fd308000220

campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0

creativeId  Список идентификаторов рекламных элементов Vungle (с разделителями-запятыми) Возвращает данные об издержках только для указанных рекламных элементов Возвращает все рекламные элементы

creativeId=586e201e242e3fd308000220

creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0

siteID Список идентификаторов объектов приложений публикаторов (с разделителями-запятыми) Возвращает данные об издержках только для указанных приложений Возвращает всех публикаторов

siteId=586e201e242e3fd308000220

siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0

Параметр dimensions

Измерения помогут вам сделать отчеты более или менее детальными. Измерения отправляются в виде списка с разделителями-запятыми в параметре dimensions. Если вы не запрашиваете измерение явным образом, Vungle не разбивает по нему отчет.

Использование параметра dimensions

Имя параметра Формат Пример
dimensions Список из особых строк, указанных в таблице ниже (с разделителями-запятыми)

dimensions=platform

dimensions=campaign,creative,date

 

Доступные измерения

Название 
измерения
Результат Пример результата
platform Строка с группировкой по платформам
platform
iOS
campaign Группировка по идентификаторам и названиям кампаний
campaign id campaign name
58086457cdf5f9eb6d000060 Toy Blast iOS CA iPhone
date  Группировка по датам 
date
2017-01-01
country Группировка по странам 
country
US
creative Группировка по идентификаторам и названиям рекламных элементов
creative id creative name
58086457cdf5f9eb6d000060 Toy Blast Landscape IEC
site Группировка по идентификаторам и именам объектов приложений публикатора
site id site name
58086457cdf5f9eb6d000060 Sonic Dash iOS

 

Если для измерений, требующих поиска по имени (например, по имени сайта), Vungle не удается найти данные, мы возвращаем строку Unknown (Неизвестно) вместо имени.

Параметр aggregates

Параметр aggregates определяет, какие данные о функционировании вас интересуют. Сводные показатели отправляются в виде списка с разделителями-запятыми в параметре aggregates. Если сводного показателя нет в списке, Vungle считает, что вам эти данные не нужны.

Использование параметра aggregates

Имя параметра Формат Пример
aggregates Список из особых строк, указанных в таблице ниже (с разделителями-запятыми)

aggregates=views

aggregates=views,installs,ecpm

 

Доступные сводные показатели

Название 
измерения
Результат
views целое число
completes целое число
clicks  целое число 
installs  целое число
spend  целое число
ecpm (издержки * 1000 / просмотры) в виде числа с плавающей точкой

 

Примеры запросов и ответов

Пример 1: издержки в формате JSON

Запрос

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?apiKey=987654321&dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

Ответ


[
    {
        "platform" : "iOS",
        "date": "2016-09-29",
        "country": "US",
        "views": 1234,
        "spend": 123.0       
    },
    {
        "platform" : "Android",
        "date": "2016-09-29",
        "country": "CA",
        "view": 35,
        "spend": 2.0
    },
    ...
]

Пример 2: издержки в формате CSV

Запрос

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

Ответ

Platform,date,country,views,spend
ios,2017-03-01,US,1234,123.0
ios,2017-03-01,CA,35,2.0

Example 3: ID/Name Expansion

Запрос

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=campaign&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

Ответ


[
    {
        "campaign id" : "12345678",
        "campaign name": "test campaign 1",
        "views": 1234,
        "spend": 123.0       
    }
]
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 0
Еще есть вопросы? Отправить запрос

Комментарии