Ad Revenue

Возвращает данные о доходах за показ рекламы (Ad Revenue) за определенный интервал дат.

Формат запроса

GET https://api.appmetrica.yandex.ru/logs/v1/export/ad_revenue_events.{csv | json}
  ? application_id=<int>
  & date_since=<string>
  & date_until=<string>
  & fields=<string>
  & [date_dimension=<string>]
  & [limit=<string>]
  & [use_utf8_bom=<bool>]
  & [<any field name>=<string>]

application_id*

Фильтрация выборки по числовому идентификатору приложения в AppMetrica.

date_since*

Начало интервала дат в формате yyyy-mm-dd hh:mm:ss. Также с помощью query-параметра date_dimension можно определить, относительно какого события считать дату.

date_until*

Конец интервала дат в формате yyyy-mm-dd hh:mm:ss. Также с помощью query-параметра date_dimension можно определить, относительно какого события считать дату.

fields*

Разделенный запятой список полей для выборки.

Список, который содержит все доступные поля (для быстрого копирования):

ad_revenue_datetime,ad_revenue_timestamp,ad_revenue_receive_datetime,ad_revenue_receive_timestamp,ad_revenue,ad_revenue_currency,ad_revenue_type,ad_revenue_data_source,ad_revenue_network,ad_revenue_placement_id,ad_revenue_placement_name,ad_revenue_unit_id,ad_revenue_unit_name,ad_revenue_precision,ad_revenue_payload,session_id,installation_id,android_id,appmetrica_device_id,appmetrica_sdk_version,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name

date_dimension

Параметр определяет, относительно какого события считается дата:

  • default — относительно момента, когда событие произошло на устройстве пользователя;
  • receive — относительно момента, когда информация о событии была получена сервером.

limit

Ограничение на число элементов в списке. По умолчанию принимает максимальное значение. Совпадение результатов идентичных запросов не гарантируется (возможно отличие в сортировке результатов).

use_utf8_bom

Параметр, который включает использование метки порядка байтов. Значение по умолчанию: false.

<any field name>

Фильтрация выборки по значению любого из доступных полей. Поддерживается только операция проверки равенства.

Формат ответа

В случае, если запрашиваются все доступные поля:

{
  "data": [
    {
      "ad_revenue_type": "string",
      "ad_revenue": "string",
      "ad_revenue_currency": "string",
      "ad_revenue_data_source": "string",
      "ad_revenue_network": "string",
      "ad_revenue_placement_id": "string",
      "ad_revenue_placement_name": "string",
      "ad_revenue_unit_id": "string",
      "ad_revenue_unit_name": "string",
      "ad_revenue_precision": "string",
      "ad_revenue_payload": "string",
      "ad_revenue_datetime": "string",
      "ad_revenue_receive_datetime": "string",
      "ad_revenue_receive_timestamp": "integer",
      "ad_revenue_timestamp": "integer",
      "session_id": "integer",
      "installation_id": "string",
      "android_id": "string",
      "appmetrica_device_id": "integer",
      "appmetrica_sdk_version": "integer",
      "city": "string",
      "connection_type": "string",
      "country_iso_code": "string",
      "device_ipv6": "string",
      "device_locale": "string",
      "device_manufacturer": "string",
      "device_model": "string",
      "google_aid": "string",
      "ios_ifa": "string",
      "ios_ifv": "string",
      "mcc": "integer",
      "mnc": "integer",
      "operator_name": "string",
      "original_device_model": "string",
      "os_version": "string",
      "profile_id": "string",
      "windows_aid": "string",
      "app_build_number": "integer",
      "app_package_name": "string",
      "app_version_name": "string"
    },
    ...
  ]
}
application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...

ad_revenue_datetime

Дата и время события в формате yyyy-mm-dd hh:mm:ss.

ad_revenue_timestamp

Время события в формате UNIX-time.

Post API позволяет загрузить только те события, у которых разница между датой совершения события (event_timestamp) и датой загрузки не больше 7 дней. Ожидается значение в секундах.

ad_revenue_receive_datetime

Дата и время получения сервером события. Может отличаться от ad_revenue_datetime из-за задержек в сети или отсутствия подключения у пользователя на момент события.

ad_revenue_receive_timestamp

Время получения сервером события в формате UNIX-time. Может отличаться от ad_revenue_timestamp из-за задержек в сети или отсутствия подключения у пользователя на момент события.

ad_revenue

Сумма денег Ad Revenue.

ad_revenue_currency

Валюта Ad Revenue.

ad_revenue_type

Тип Ad Revenue. Возможные значения:

  • native
  • banner
  • rewarded
  • interstitial
  • mrec
  • other

ad_revenue_data_source

Признак автособранного Ad Revenue. Возможные значения:

  • autocollected
  • manual

ad_revenue_network

Рекламная сеть.

ad_revenue_placement_id

ID расположения рекламы.

ad_revenue_placement_name

Название расположения рекламы.

ad_revenue_unit_id

ID рекламной единицы.

ad_revenue_unit_name

Название рекламной единицы.

ad_revenue_precision

Точность суммы Ad Revenue, как передано в SDK. Например, "publisher_defined" или "estimated".

ad_revenue_payload

Дополнительные данные, сериализованные в JSON.

session_id

Идентификатор сессии. Набор из значений installation_id, session_id и платформенного идентификатора устройства (google_aid / ios_ifa) позволяет однозначно идентифицировать сессию пользователя.

installation_id

Идентификатор установки.

android_id

Идентификатор Android.

appmetrica_device_id

Уникальный идентификатор устройства, который устанавливает AppMetrica. В Android от AppSetId, в IOS от IFV.

appmetrica_sdk_version

Версия AppMetrica SDK.

city

Название города на английском языке, где был произведен клик.

connection_type

Тип подключения устройства. Возможные значения: wifi | cell | unknown.

country_iso_code

ISO-код страны.

device_ipv6

IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147.

device_locale

Язык интерфейса устройства.

device_manufacturer

Производитель устройства, определяется сервисом AppMetrica (например, Apple или Samsung).

device_model

Модель устройства, определяется сервисом AppMetrica (например, Galaxy S6).

google_aid

Google AID устройства в формате, в котором получен от устройства.

ios_ifa

IFA устройства в формате, в котором получен от устройства.

ios_ifv

IFV для приложения в формате, в котором получен от устройства.

mcc

Мобильный код страны.

mnc

Код мобильной сети.

operator_name

Имя оператора сотовой связи.

original_device_model

Заводская модель устройства (например, для Galaxy S8 возможны следующие значения: SM-G9550, SM-G9558 и т. д.).

os_version

Версия операционной системы на устройстве пользователя.

profile_id

Идентификатор пользовательского профиля.

windows_aid

Windows AID устройства в формате, в котором получен от устройства.

app_build_number

Номер сборки приложения.

app_package_name

Имя пакета для Android или Bundle ID для iOS (например, ru.yandex.metro).

app_version_name

Версия приложения в виде, как указана разработчиком.

Пример

Запрос:

curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/ad_revenue_events.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=ad_revenue_datetime,ad_revenue_timestamp,ad_revenue_receive_datetime,ad_revenue_receive_timestamp,ad_revenue,ad_revenue_currency,ad_revenue_type,ad_revenue_data_source,ad_revenue_network,ad_revenue_placement_id,ad_revenue_placement_name,ad_revenue_unit_id,ad_revenue_unit_name,ad_revenue_precision,ad_revenue_payload,session_id,installation_id,android_id,appmetrica_device_id,appmetrica_sdk_version,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name' \
  -H 'Authorization: OAuth oauth_token'

Ответ:

{
  "data": [
    {
      "ad_revenue_type": "banner",
      "ad_revenue": "299",
      "ad_revenue_currency": "RUB",
      "ad_revenue_data_source": "manual",
      "ad_revenue_network": "network__example",
      "ad_revenue_placement_id": "ad_revenue_placement_id__example",
      "ad_revenue_placement_name": "ad_revenue_placement_name__example",
      "ad_revenue_unit_id": "ad_revenue_unit_id__example",
      "ad_revenue_unit_name": "ad_revenue_unit_name__example",
      "ad_revenue_precision": "estimated",
      "ad_revenue_payload": "{\"example_key1\":\"example_value1\", \"example_key2\":\"example_value2\"}",
      "ad_revenue_datetime": "yyyy-mm-dd hh:mm:ss",
      "ad_revenue_receive_datetime": "yyyy-mm-dd hh:mm:ss",
      "ad_revenue_receive_timestamp": "1556258667",
      "ad_revenue_timestamp": "1556258660",
      "session_id": "10000000049",
      "installation_id": "installation_id__example",
      "android_id": "android_id__example",
      "appmetrica_device_id": "123456789012345678",
      "appmetrica_sdk_version": "3001000",
      "city": "Moscow",
      "connection_type": "wifi",
      "country_iso_code": "RU",
      "device_ipv6": "::ffff:5.255.232.147",
      "device_locale": "ru_RU",
      "device_manufacturer": "Apple",
      "device_model": "iPhone X",
      "google_aid": "google_aid__example",
      "ios_ifa": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "ios_ifv": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "mcc": "250",
      "mnc": "1",
      "operator_name": "MTS RUS",
      "original_device_model": "iPhone10,3",
      "os_version": "12.2",
      "profile_id": "test",
      "windows_aid": "windows_aid__example",
      "app_build_number": "1",
      "app_package_name": "ru.yandex.metro",
      "app_version_name": "1.0"
    }
  ]
}

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

Написать в службу поддержки