Загрузка событий Ad Revenue

Формат запроса
Коды ответа
Пример запроса
Другие методы Post API

Передает данные о выручке от показов рекламы.

Пример использования: вы можете передавать через Post API рекламный доход от просмотров рекламы с привязкой к к каждому пользователю приложения.

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

Свойства событий можно передавать в параметрах запроса или в теле. При передаче данных в теле, к URL запроса необходимо добавить .csv. Подробнее в разделе Пример запроса.

Для привязки события к пользователю, необходимо использовать одно из следующих полей при запросе:

profile_id
appmetrica_device_id

Внимание

Post API содержит ограничения на загрузку данных. Подробнее в разделе Ограничения.

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

POST https://api.appmetrica.yandex.ru/logs/v1/import/adrevenue
  ? post_api_key=<string>
  & application_id=<int>
  & profile_id=<string>
  & appmetrica_device_id=<int>
  & event_timestamp=<int>
  & revenue=<decimal>
  & currency=<enum>
  & ad_type=<enum>
  & [ad_network=<string>]
  & [ad_unit_id=<int>]
  & [ad_unit_name=<string>]
  & [ad_placement_id=<int>]
  & [ad_placement_name=<string>]
  & [precision=<enum>]
  & [payload=<string>]
  & [session_type=<string>]
  & [ios_ifa=<string>]
  & [ios_ifv=<string>]
  & [google_aid=<string>]
  & [windows_aid=<string>]
  & [os_name=<string>]
  & [os_version=<string>]
  & [device_manufacturer=<string>]
  & [device_model=<string>]
  & [device_type=<string>]
  & [device_locale=<string>]
  & [app_version_name=<string>]
  & [app_package_name=<string>]
  & [connection_type=<string>]
  & [operator_name=<string>]
  & [mcc=<int>]
  & [mnc=<int>]
  & [device_ipv6=<string>]

`post_api_key`*	Токен для загрузки данных. Его можно получить в разделе Настройки вашего приложения.
`application_id`*	Уникальный числовой идентификатор приложения в AppMetrica.
`profile_id`*	Идентификатор профиля пользователя. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание Не передавайте значение вместе с параметром `appmetrica_device_id`. Сервер принимает только один из параметров.
`appmetrica_device_id`*	Хеш от уникального идентификатора устройства, который устанавливает AppMetrica. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание Не передавайте значение вместе с параметром `profile_id`. Сервер принимает только один из параметров.
`event_timestamp`*	Время события в формате UNIX-time. Post API позволяет загрузить только те события, у которых разница между датой совершения события (`event_timestamp`) и датой загрузки не больше 7 дней.
`revenue`*	Выручка от одного показа рекламы. Сумма дохода в формате decimal(10,8) — десятичная дробь с 10 знаками до точки и 8 знаками после точки.
`currency`*	Валюта покупки. Список доступных валют.
`ad_type`*	Тип рекламного объявления. Доступные значения: `native, banner, rewarded, interstitial, mrec, other`.
`ad_network`	Название рекламной сети.
`ad_unit_id`	Unit ID от рекламной сети.
`ad_unit_name`	Unit name от рекламной сети.
`ad_placement_id`	Placement ID от рекламной сети.
`ad_placement_name`	Placement name от рекламной сети.
`precision`	Точность передачи данных. Например, `publisher_defined, estimated`.
`payload`	Произвольный payload: дополнительная информация, представленная в виде пар key-value. Максимальный размер составляет 30 КБ. Если значение превышает этот предел, оно будет усечено AppMetrica.
`session_type`	Тип сессии. Возможные значения: `foreground` — в отчете События будет увеличиваться метрика Пользователи. `background` — в отчете События будет увеличиваться метрика Устройства. Такие события не будут попадать в отчет с группировкой по пользователям и в карточку профиля. Значение по умолчанию: `background`.
`ios_ifa`	IFA устройства в формате, в котором получен от устройства.
`ios_ifv`	IFV для приложения в формате, в котором получен от устройства.
`google_aid`	Google AID устройства в формате, в котором получен от устройства.
`windows_aid`	Windows AID устройства в формате, в котором получен от устройства.
`os_name`	Операционная система на устройстве пользователя: `ios` \| `android` \| `windows`.
`os_version`	Версия операционной системы на устройстве пользователя.
`device_manufacturer`	Производитель устройства, определяется сервисом AppMetrica (например, Apple или Samsung).
`device_model`	Модель устройства, определяется сервисом AppMetrica (например, Galaxy S6).
`device_type`	Тип устройства, определяется сервисом AppMetrica. Возможные значения: `phone` \| `tablet` \| `unknown`.
`device_locale`	Язык интерфейса устройства.
`app_version_name`	Версия приложения в виде, как указана разработчиком.
`app_package_name`	Имя пакета для Android или Bundle ID для iOS (например, ru.yandex.metro).
`connection_type`	Тип подключения устройства. Возможные значения: `wifi` \| `cell` \| `unknown`.
`operator_name`	Имя оператора сотовой связи.
`mcc`	Мобильный код страны.
`mnc`	Код мобильной сети.
`device_ipv6`	IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147.

Коды ответа

Код	Описание
200	Данные успешно загружены.
403	Запрос не содержит заголовка авторизации, либо указан неверный токен.
400	Запрос не содержит одного или нескольких обязательных параметров.

Пример запроса

Передача данных в теле запроса

Передача данных в параметрах запроса

POST /logs/v1/import/adrevenue.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 HTTP/1.1
Host: api.appmetrica.yandex.ru
Content-Length: 540i
Connection: close

application_id,profile_id,appmetrica_device_id,event_timestamp,revenue,currency,ad_type,ad_network,ad_unit_id,ad_unit_name,ad_placement_id,ad_placement_name,precision,payload,session_type,ios_ifa,ios_ifv,google_aid,windows_aid,os_name,os_version,device_manufacturer,device_model,device_type,device_locale,app_version_name,app_package_name,connection_type,operator_name,mcc,mnc,device_ipv6
1234567890,1234567890abcdef,1757762239877245682,1689943892,0.0001,usd,banner,some_network_name,0987654321,some_unit_name,12345000,some_placement_name,estimated,"{""key"":""value_1""}",foreground,123456abcde,54321edcba,098765abcde,567890abcde,ios,16.6,Apple,iPhone14Pro,phone,en_US,some_version_name,some_package_name,wifi,MegaFon,250,2,2a02:6b8::40c:6676:baff:fea6:53d8

POST /logs/v1/import/adrevenue.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012&application_id=1234567890&profile_id=1234567890abcdef&appmetrica_device_id=1757762239877245682&event_timestamp=1689943892&revenue=0.0001&currency=usd&ad_type=banner&ad_network=some_network_name&ad_unit_id=0987654321&ad_unit_name=some_unit_name&ad_placement_id=12345000&ad_placement_name=some_placement_name&precision=estimated&payload="{""key"":""value_1""}"&session_type=foreground&ios_ifa=123456abcde&ios_ifv=54321edcba&google_aid=098765abcde&windows_aid=567890abcde&os_name=ios&os_version=16.6&device_manufacturer=Apple&device_model=iPhone14Pro&device_type=phone&device_locale=en_US&app_version_name=some_version_name&app_package_name=some_package_name&connection_type=wifi&operator_name=MegaFon&mcc=250&mnc=2&device_ipv6=2a02:6b8::40c:6676:baff:fea6:53d8 HTTP/1.1
Host: api.appmetrica.yandex.ru
Content-Length: 0
Connection: close

Другие методы Post API

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

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