Перейти к основному содержимому

API документация

Получение Вашей статистики через API Appodeal​

Вы можете получать статистику, которую видите в Отчетах, программно в формате JSON.

Мы предоставляем те же данные и позволяем сузить вывод так же, как в Отчетах.

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

Ваши параметры доступа​

Используйте ключ API key и ваш идентификатор пользователя в каждом запросе. Они указаны во вкладке API доступы в вашем профиле Appodeal.

Пример​

Статистику за неделю с 13 по 19 мая с детализацией по датам можно получить, используя следующий запрос:

https://api-services.appodeal.com/api/v2/stats_api?api_key=<API key>&user_id=<User ID>&date_from=2019-05-13&date_to=2019-05-19&detalisation%5B%5D=date

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

API принимает следующие параметры для уточнения запроса:

date_from - первая дата (включительно), за которую будет формироваться статистика. Этот параметр является обязательным и требует формата 'YYYY-mm-dd'..

date_to - последняя дата (включительно), за которую будет формироваться статистика. Этот параметр является обязательным и требует формата 'YYYY-mm-dd'. Данный параметр не может быть меньше, чем параметр date_from..

app[] - ключ приложения, для которого нужно выдать статистику или ALL. Если данный параметр отсутствует в запросе, по умолчанию считается статистика для всех ваших приложений и приложений, к которым у вас есть разделенный доступ с другими пользователями. Допустимо использовать один параметр в запросе.

country[] - двузначный код страны по ISO или ALL. Значение по умолчанию ALL - включает статистику для всех стран. Допустимо использование одного параметра в запросе.

network[] - Сеть, для которой нужно вывести статистику. Возможные значения (допустимо использование нескольких значений в одном запросе):

  • ALL - Все данные сетей будут включены в статистику. Это значение по умолчанию, если параметр отсутствует.
  • adcolony - включать в отчет только данные по AdColony (Ad Network).
  • admob - включать в отчет только данные по Admob (Ad Network).
  • directoffer - включать в отчет только данные по Ad Server Campaigns.
  • amazon - включать в отчет только данные по Amazon Ads (Ad Network).
  • applovin - включать в отчет только данные по Applovin (Ad Network).
  • avocarrot - включать в отчет только данные по Avocarrot (Ad Exchange).
  • backfill - включать в отчет только данные по Backfill.
  • chartboost - включать в отчет только данные по Chartboost (Ad Network).
  • facebook - включать в отчет только данные по Facebook (Ad Network).
  • flurry - включать в отчет только данные по Flurry (Ad Network).
  • google_dfp - включать в отчет только данные по Google DFP (Ad Network).
  • inmobi - включать в отчет только данные по InMobi (Ad Network).
  • inneractive - включать в отчет только данные по Inneractive (Ad Exchange).
  • iron_source - включать в отчет только данные по IronSource (Ad Network).
  • mintegral - включать в отчет только данные по Mintegral (Ad Network).
  • mopub - включать в отчет только данные по MoPub (Ad Exchange).
  • my_target - включать в отчет только данные по MyTarget (Ad Network).
  • ogury - включать в отчет только данные по Ogury (Ad Network).
  • openx - включать в отчет только данные по OpenX (Ad Exchange).
  • pubnative - включать в отчет только данные по PubNative (Ad Network).
  • appodeal - включать в отчет только данные по Service Messages.
  • smaato - включать в отчет только данные по Smaato (Ad Exchange).
  • smaato_sdk - включать в отчет только данные по Smaato SDK (Ad Exchange).
  • startapp - включать в отчет только данные по StartApp (Ad Network).
  • tapjoy - включать в отчет только данные по Tapjoy (Ad Network).
  • testads - включать в отчет только данные поTest Ads.
  • unity - включать в отчет только данные по Unity Ads (Ad Network).
  • vungle - включать в отчет только данные по Vungle (Ad Network).
  • yandex - включать в отчет только данные поYandex (Ad Network).
  • AllInOneMedia - включать в отчет только данные по All in One Media (Ad Network).
  • rocket10 - включать в отчет только данные по Rocket 10 (Ad Network).
  • tremor - включать в отчет только данные по Tremor (Ad Network).
  • vdopia - включать в отчет только данные по Vdopia (Ad Network).
  • vhub - включать в отчет только данные по Vihub (Ad Network).
  • exchange_sdk_adtelligent - включать в отчет только данные по Adtelligent (DSP).
  • exchange_sdk_altamob - включать в отчет только данные по Altamob (DSP).
  • exchange_sdk_amadoad - включать в отчет только данные по Amadoad (DSP).
  • exchange_sdk_app_growth - включать в отчет только данные по AppGrowth (DSP).
  • exchange_sdk_applift - включать в отчет только данные по Applift (DSP).
  • exchange_sdk_appnext - включать в отчет только данные по Appnext (DSP).
  • exchange_sdk_appreciate - включать в отчет только данные по Appreciate (DSP).
  • exchange_sdk_avazu - включать в отчет только данные по Avazu (DSP).
  • exchange_sdk_axonix - включать в отчет только данные по Axonix (DSP).
  • exchange_sdk_beeline_programmatic - включать в отчет только данные по Beeline Programmatic (DSP).
  • exchange_sdk_bidease - включать в отчет только данные по BIDEASE (DSP).
  • exchange_sdk_bucksense - включать в отчет только данные по Bucksense (DSP).
  • exchange_sdk_criteo - включать в отчет только данные по Criteo (DSP).
  • exchange_sdk_edge226 - включать в отчет только данные по Edge226 (DSP).
  • exchange_sdk_engage_first_impression - включать в отчет только данные по Engage (DSP).
  • exchange_sdk_epom - включать в отчет только данные по Epom (DSP).
  • exchange_sdk_fractional_media - включать в отчет только данные по Fractional Media (DSP).
  • exchange_sdk_getintent - включать в отчет только данные по Getintent (DSP).
  • exchange_sdk_getloyal_dsp - включать в отчет только данные по Getloyal DSP (DSP).
  • exchange_sdk_hybrid_dsp - включать в отчет только данные по Hybrid DSP (DSP).
  • exchange_sdk_hyper_adx - включать в отчет только данные по HyperAdx (DSP).
  • exchange_sdk_index_exchange - включать в отчет только данные по Index Exchange (DSP).
  • exchange_sdk_jampp - включать в отчет только данные по Jampp (DSP).
  • exchange_sdk_kayzen - включать в отчет только данные по Kayzen.
  • exchange_sdk_lead_bolt - включать в отчет только данные по LeadBolt (DSP).
  • exchange_sdk_liftoff - включать в отчет только данные по Liftoff (DSP).
  • exchange_sdk_liquid_m - включать в отчет только данные по LiquidM (DSP).
  • exchange_sdk_manage_com - включать в отчет только данные по Manage.com (DSP).
  • exchange_sdk_mobvista - включать в отчет только данные по Mintegral (DSP).
  • exchange_sdk_oxonux_digital_media_pvt_ltd - включать в отчет только данные по Oxonux Digital Media Pvt Ltd (DSP).
  • exchange_sdk_persona_ly - включать в отчет только данные по Persona.ly (DSP).
  • exchange_sdk_pubnative - включать в отчет только данные по Pubnative (DSP).
  • exchange_sdk_rubicon - включать в отчет только данные по Rubicon (DSP).
  • exchange_sdk_solo_math - включать в отчет только данные по SoloMath (DSP).
  • exchange_sdk_test_agency - включать в отчет только данные по TestAgency (DSP).
  • exchange_sdk_woobi - включать в отчет только данные по Woobi (DSP).
  • exchange_sdk_x_ad - включать в отчет только данные по xAd (DSP).
  • exchange_sdk_yeahmobi - включать в отчет только данные по Yeahmobi (DSP).
  • exchange_sdk_zorka_mobi_1 - включать в отчет только данные по Zorka Mobi (DSP).

detalisation[] - детализирует статистику по заданным параметрам. Возможные значения (допустимо использование нескольких значений в одном запросе):

  • date - разбить статистику по датам.
  • app - разбить статистику по приложениям. В отчете будут указаны имя приложения и его ключ.
  • country - разбить статистику по странам. В отчете будет присутствовать код страны.
  • network - Разбить статистику по сетям. В отчете будет присутствовать название сети (такое же, как в параметре network).
  • banner_type - разбить статистику по типам рекламы (полноэкранная, видео, баннеры, нативная, mrec, видео с наградой за просмотр).
  • segment - разбить статистику по сегментам.
  • placement - разбить статистику по плейсментам.
  • include_shared_apps - если передано ненулевое значение, отчет также будет включать в себя информацию о приложениях, к которым у вас есть разделенный доступ. (см. подробнее).
  • skip_direct - не включать в отчет статистику по кампаниям Рекламного сервера. 1 пропускать эти кампании, 0 - не пропускать.

Больше примеров​

Статистика за последнюю неделю, с детализацией по датам и приложениям:

https://api-services.appodeal.com/api/v2/stats_api?api_key=<API key>&user_id=<User ID>&date_from=2019-02-07&date_to=2019-02-14&detalisation[]=date&detalisation[]=app

Статистика за вчера, с детализацией по приложениям и рекламным сетям:

https://api-services.appodeal.com/api/v2/stats_api?api_key=<API key>&user_id=<User ID>&date_from=2019-02-13&date_to=2019-02-13&detalisation[]=app&network[]=appodeal&network[]=admob

Ответ​

Подготовка статистических данных может занять некоторое время, поэтому мы используем так называемый "отложенный" ответ.

Это значит, что в ответ на запрос система выдаст task_id, который можно использовать для определения готовности данных.

Для проверки статуса запроса нужно сделать следующий get-запрос: 

https://api-services.appodeal.com/api/v2/check_status?api_key=<API key>&user_id=<User ID>&task_id=<task_id>

As soon as the information is prepared, you may take it using this call: 

https://api-services.appodeal.com/api/v2/output_result?api_key=<API key>&user_id=<User ID>&task_id=<task_id>

Исходя из полученного запроса, сервер вернет json-файл, содержащий данные статистики. Также в ответе содержится код - нулевой для успешного запроса и ненулевой для ошибочного, который поясняется соответствующим текстовым сообщением. Статистические данные содержатся в параметре data. Это массив с итоговыми данными. Данные содержатся в параметрах requests, fills, impressions, fillrate, clicks, ctr, revenue, ecpm, но также могут содержать app_key, app_name, country_code, network, date в зависимости от параметров запроса.

Иногда отчет может иметь большой размер, в этом случае вы получите ошибку: "The file is large. Please use the option `disposition=attachment` in the query to download the file."

{"code":0,"message":"success","url": "< link_for_download >"}

API для работы с приложениями​

У вас также есть возможность управления Вашими приложениями посредством API. Вы можете найти, отредактировать или создать новое приложение через API.

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

Этот API работает только через POST запросы.

POST запросы нужно слать на https://api-services.appodeal.com/api/v2/apps. Включите в запрос все необходимые параметры.

Создание приложения​

Чтобы создать новое приложение, нужно передать следующие параметры:

platform - 1 - Google, 2 - Amazon, 4 - iOS.

bundle_id - bundle_id (package name) вашего приложения.

name - название вашего приложения. По умолчанию будет использован bundle_id.

is_game - 1 - если ваше приложение игра, и любое другое значение, если нет. По умолчанию 0.

orientation - одно из следующих значений: 'both', 'landscape', 'portrait'.

is_for_kids - 1 - если приложение предназначена для детей, 0 (или не передавайте) - если нет.

coppa - 1 - если приложение соответствует требованиям COPPA, 0 (или не передавайте) - если нет.

filter_mature_content - 1 - фильтрация рекламы с контентом для взрослых, 0 (или не передавайте) - если нет.

Обратите внимание:

Не передавайте параметр app_key. В этом случае API активизирует поиск приложения вместо его создания.

Редактирование приложения​

Можно отредактировать только название приложения и ориентацию. Передайте app_key и один или оба параметра name и/или orientation, чтобы отредактировать их значения.