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

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

Примечание. API отчетности версии 1.0 является устаревшим API. Используйте его для отчетов по операциям, имевшим место до 5 июля 2017 г. Для операций, выполнявшихся 5 июля 2017 г. и позже, используйте API отчетности 2.0, документация по которому представлена здесь.

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

Хост Заголовки запросов API
https://ssl.vungle.com Content-Type: application/json Безопасность регулируется посредством передачи ключа API в качестве параметра запроса. Ваш ключ API автоматически создается на панели управления Vungle.  
Если его у вас еще нет, см. статью How can I request a Reporting API Key? (Запрос ключа API отчетности)

Рекламодатели

Ресурс Параметры Описание
GET /api/campaigns key=[API Key] active=[true/false] Возвращает список принадлежащих вам кампаний. Если указаны активные, кампании будут фильтроваться, чтобы показать только активные или неактивные кампании.

Пример ответа:

{   
    "rate" : 0.01,
    "rateType" : "complete",
    "campaignId" : "51896da23436ae313c3939b9",
    "type" : "external",
    "name" : "Feed the Rat",
    "spent" : 2131
}

Ресурс Параметры Описание
GET /api/campaigns/[Campaign ID] key=[API Key] date=[YYYY-MM-DD] Возвращает статистику для указанной кампании на указанную дату.

Пример ответа:

{
    "clicks" : 1129,
    "completedViews" : 23080,
    "date" : "2012-08-19",
    "campaignId" : "51896da23436ae313c3939b9",
    "installs" : 590,
    "impressions" : 26722,
    "name" : "Feed the Rat",
    "views" : 26546,
    "dailySpend": 566
}
Ресурс Параметры Описание
GET /api/campaigns/[Campaign ID]/installs key=[API Key] start=[YYYY-MM-DD] end=[YYYY-MM-DD] Возвращает список установок, отнесенных к указанной кампании в течение указанного диапазона дат.

Пример ответа:

{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
},
{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
}

Показатели геоуровня

Ресурс Параметры Описание
GET /api/campaigns/[Campaign ID]/geo/[Country_Code] key=[API Key] date=[YYYY-MM-DD] OR start=[YYYY-MM-DD] end=[YYYY-MM-DD]

Возвращает географическую информацию для кампании в конкретных странах. Страна определяется с помощью буквенного кода Country_Code, например US. Вы можете либо ввести диапазон дат с помощью параметров 'start' и 'end' или конкретного значения 'date', но не использовать для этого оба способа.

Пример ответа:

{
"date": "2015-07-08",
"country": "US",
"views": 34029,
"completes": 32094,
"clicks": 1822,
"installs": 609,
"spend": 582,
"eRPM": 8.9
}
Ресурс Параметры Описание
GET /api/campaigns/[Campaign ID]/geo/all key=[API Key] date=[YYYY-MM-DD] OR start=[YYYY-MM-DD] end=[YYYY-MM-DD]

Возвращает географическую информацию для кампании по всем странам. Вы можете либо ввести диапазон дат с помощью параметров 'start' и 'end' или конкретного значения 'date', но не использовать для этого оба способа.

Пример ответа:

[
{
"date": "2015-07-08",
"country": "US",
"views": 34029,
"completes": 32094,
"clicks": 1822,
"installs": 609,
"spend": 582,
"eRPM": 8.9
},
{
"date": "2015-07-08",
"country": "CA",
"views": 34235,
"completes": 3190,
"clicks": 1509,
"installs": 523,
"spend": 498,
"eRPM": 7.6
}
]

Имейте в виду, что при отсутствии данных, доступных для вашего запроса, будет возвращен пустой ответ 200. Это означает, что запрос выполнен, но данных, доступных для возврата, нет.

Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 2 из 3
Еще есть вопросы? Отправить запрос

Комментарии