Загрузка событий Ecommerce
Передает данные о Ecommerce-событиях.
Пример использования: вы можете передавать все Ecommerce-события через Post API, чтобы в одном месте собирать данные о покупках пользователей не только в приложении, но и, например, в оффлайн магазине или на веб сайте.
Свойства событий можно передавать в параметрах запроса или в теле. При передаче данных в теле, к URL запроса необходимо добавить .csv. Подробнее в разделе Пример запроса.
Для привязки события к пользователю, необходимо использовать одно из следующих полей при запросе:
profile_idappmetrica_device_id
Внимание. Post API содержит ограничения на загрузку данных. Подробнее в разделе Ограничения.
Формат запроса
POST https://api.appmetrica.yandex.ru/logs/v1/import/ecommerce
? post_api_key=<string>
& application_id=<int>
& profile_id=<string>
& appmetrica_device_id=<int>
& event_timestamp=<int>
& ecom_event_type=<string>
& order_id=<string>
& product_name=<string>
& cart_item_quantity=<int>
& [cart_item_price_currency=<string>]
& [cart_item_price_value=<int>]
& [cart_item_price_internal_currency=<array>]
& [cart_item_price_internal_value=<array>]
& [actual_price_currency=<string>]
& [actual_price_value=<int>]
& [actual_price_internal_currency=<array>]
& [actual_price_internal_value=<array>]
& [payload=<string>]
& [product_category_path_1=<string>]
& [product_category_path_2=<string>]
& [product_category_path_3=<string>]
& [product_category_path_4=<string>]
& [product_category_path_5=<string>]
& [product_category_path_6=<string>]
& [product_category_path_7=<string>]
& [product_category_path_8=<string>]
& [product_category_path_9=<string>]
& [product_category_path_10=<string>]
& original_price_currency=<string>
& original_price_value=<int>
& [original_price_internal_currency=<array>]
& [original_price_internal_value=<array>]
& [product_payload=<string>]
& [product_promo_codes=<array>]
& [product_sku=<string>]
& [screen_category_path_1=<string>]
& [screen_category_path_2=<string>]
& [screen_category_path_3=<string>]
& [screen_category_path_4=<string>]
& [screen_category_path_5=<string>]
& [screen_category_path_6=<string>]
& [screen_category_path_7=<string>]
& [screen_category_path_8=<string>]
& [screen_category_path_9=<string>]
& [screen_category_path_10=<string>]
& [screen_name=<string>]
& [screen_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 * | Числовой идентификатор приложения. |
profile_id * | Идентификатор профиля пользователя.. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром appmetrica_device_id. Сервер принимает только один из параметров. |
appmetrica_device_id * | Хеш от уникального идентификатора устройства, который устанавливает AppMetrica. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром profile_id. Сервер принимает только один из параметров. |
event_timestamp * | Время события в формате UNIX-time. Post API позволяет загрузить только те события, у которых разница между датой совершения события ( |
ecom_event_type * | Тип ecommerce события. Возможные значения: SHOW_SCREEN, SHOW_PRODUCT_CARD, SHOW_PRODUCT_DETAILS, ADD_TO_CART, REMOVE_FROM_CART, BEGIN_CHECKOUT, PURCHASE. |
order_id * | Уникальный идентификатор заказа. |
product_name * | Название продукта. |
cart_item_quantity * | Количество единиц товара в корзине. |
cart_item_price_currency | Валюта цены товара в корзине. Если не указано, используется значение actual_price_currency. Список доступных валют. |
cart_item_price_value | Цена товара в корзине. Это итоговая цена с учётом всех акций, промокодов, бонусных баллов и прочих скидок, которые применил пользователь. Если не указано, используется значение actual_price_value. |
cart_item_price_internal_currency | Тип внутренней валюты для товара в корзине. Если не указано, используется значение actual_price_internal_currency. |
cart_item_price_internal_value | Цена товара в корзине во внутренней валюте. Это итоговая цена с учётом всех акций, промокодов, бонусных баллов и прочих скидок, которые применил пользователь. Если не указано, используется значение actual_price_internal_value. |
actual_price_currency | Валюта актуальной цены товара. Если не указано, используется значение original_price_currency. Список доступных валют. |
actual_price_value | Актуальная цена товара. Это текущая цена на товар с учётом скидок. Если не указано, используется значение original_price_value. |
actual_price_internal_currency | Внутренняя валюта актуальной цены товара. Если не указано, используется значение original_price_internal_currency. |
actual_price_internal_value | Актуальная цена товара во внутренней валюте. Это текущая цена на товар с учётом скидок. Если не указано, используется значение original_price_internal_value. |
payload | Произвольный payload: дополнительная информация о заказе, представленная в виде пар key-value. Максимальный размер составляет 30 КБ. Если значение превышает этот предел, оно будет усечено AppMetrica. |
product_category_path_1 | Категория товара 1 уровня. |
product_category_path_2 | Категория товара 2 уровня. |
product_category_path_3 | Категория товара 3 уровня. |
product_category_path_4 | Категория товара 4 уровня. |
product_category_path_5 | Категория товара 5 уровня. |
product_category_path_6 | Категория товара 6 уровня. |
product_category_path_7 | Категория товара 7 уровня. |
product_category_path_8 | Категория товара 8 уровня. |
product_category_path_9 | Категория товара 9 уровня. |
product_category_path_10 | Категория товара 10 уровня. |
original_price_currency * | Валюта стартовой цены товара. Список доступных валют. |
original_price_value * | Стартовая цена товара без учёта скидок. |
original_price_internal_currency | Внутренняя валюта стартовой цены товара. |
original_price_internal_value | Стартовая цена товара во внтутренеей валюте. |
product_payload | Произвольный payload: дополнительная информация о отдельном товаре, представленная в виде пар key-value. Максимальный размер составляет 30 КБ. Если значение превышает этот предел, оно будет усечено AppMetrica. |
product_promo_codes | Массив применённых промокодов. |
product_sku | Индентификатор товара. |
screen_category_path_1 | Страница категории товаров 1 уровня. |
screen_category_path_2 | Страница категории товаров 2 уровня. |
screen_category_path_3 | Страница категории товаров 3 уровня. |
screen_category_path_4 | Страница категории товаров 4 уровня. |
screen_category_path_5 | Страница категории товаров 5 уровня. |
screen_category_path_6 | Страница категории товаров 6 уровня. |
screen_category_path_7 | Страница категории товаров 7 уровня. |
screen_category_path_8 | Страница категории товаров 8 уровня. |
screen_category_path_9 | Страница категории товаров 9 уровня. |
screen_category_path_10 | Страница категории товаров 10 уровня. |
screen_name | Название просмотренной страницы или экрана. |
screen_payload | Произвольный payload: дополнительная информация о странице, например, отдельной категории, представленная в виде пар key-value. Максимальный размер составляет 30 КБ. Если значение превышает этот предел, оно будет усечено AppMetrica. |
session_type | Тип сессии. Возможные значения:
Значение по умолчанию: |
ios_ifa | IFA устройства. |
ios_ifv | IFV устройства. |
google_aid | Google AID устройства. |
windows_aid | Windows AID устройства. |
os_name | Имя операционной системы на устройстве пользователя. Возможные значения: ios | android | windows. |
os_version | Версия операционной системы на устройстве пользователя. |
device_manufacturer | Производитель устройства. Например, Apple, Samsung. |
device_model | Модель устройства. Например, Galaxy S6, iPhone X. |
device_type | Тип устройства, определяется сервисом AppMetrica. Возможные значения: phone | tablet | phablet | tv | desktop | unknown. |
device_locale | Язык интерфейса устройства. Например, en_US |
app_version_name | Версия приложения в виде, как указана разработчиком. |
app_package_name | Имя пакета для Android или Bundle ID для iOS. Например, ru.yandex.sample.metrica. |
connection_type | Тип подключения устройства. Возможные значения: wifi | cell | unknown. |
operator_name | Имя оператора сотовой связи. Например, MegaFon. |
mcc | Мобильный код страны. Например, 250 |
mnc | Код мобильной сети. Например, 2 |
device_ipv6 | IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147 |
post_api_key * | Токен для загрузки данных. Его можно получить в разделе Настройки вашего приложения. |
application_id * | Числовой идентификатор приложения. |
profile_id * | Идентификатор профиля пользователя.. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром appmetrica_device_id. Сервер принимает только один из параметров. |
appmetrica_device_id * | Хеш от уникального идентификатора устройства, который устанавливает AppMetrica. Post API позволяет загружать данные только для идентификаторов, которые предварительно были отправлены через SDK. Внимание. Не передавайте значение вместе с параметром profile_id. Сервер принимает только один из параметров. |
event_timestamp * | Время события в формате UNIX-time. Post API позволяет загрузить только те события, у которых разница между датой совершения события ( |
ecom_event_type * | Тип ecommerce события. Возможные значения: SHOW_SCREEN, SHOW_PRODUCT_CARD, SHOW_PRODUCT_DETAILS, ADD_TO_CART, REMOVE_FROM_CART, BEGIN_CHECKOUT, PURCHASE. |
order_id * | Уникальный идентификатор заказа. |
product_name * | Название продукта. |
cart_item_quantity * | Количество единиц товара в корзине. |
cart_item_price_currency | Валюта цены товара в корзине. Если не указано, используется значение actual_price_currency. Список доступных валют. |
cart_item_price_value | Цена товара в корзине. Это итоговая цена с учётом всех акций, промокодов, бонусных баллов и прочих скидок, которые применил пользователь. Если не указано, используется значение actual_price_value. |
cart_item_price_internal_currency | Тип внутренней валюты для товара в корзине. Если не указано, используется значение actual_price_internal_currency. |
cart_item_price_internal_value | Цена товара в корзине во внутренней валюте. Это итоговая цена с учётом всех акций, промокодов, бонусных баллов и прочих скидок, которые применил пользователь. Если не указано, используется значение actual_price_internal_value. |
actual_price_currency | Валюта актуальной цены товара. Если не указано, используется значение original_price_currency. Список доступных валют. |
actual_price_value | Актуальная цена товара. Это текущая цена на товар с учётом скидок. Если не указано, используется значение original_price_value. |
actual_price_internal_currency | Внутренняя валюта актуальной цены товара. Если не указано, используется значение original_price_internal_currency. |
actual_price_internal_value | Актуальная цена товара во внутренней валюте. Это текущая цена на товар с учётом скидок. Если не указано, используется значение original_price_internal_value. |
payload | Произвольный payload: дополнительная информация о заказе, представленная в виде пар key-value. Максимальный размер составляет 30 КБ. Если значение превышает этот предел, оно будет усечено AppMetrica. |
product_category_path_1 | Категория товара 1 уровня. |
product_category_path_2 | Категория товара 2 уровня. |
product_category_path_3 | Категория товара 3 уровня. |
product_category_path_4 | Категория товара 4 уровня. |
product_category_path_5 | Категория товара 5 уровня. |
product_category_path_6 | Категория товара 6 уровня. |
product_category_path_7 | Категория товара 7 уровня. |
product_category_path_8 | Категория товара 8 уровня. |
product_category_path_9 | Категория товара 9 уровня. |
product_category_path_10 | Категория товара 10 уровня. |
original_price_currency * | Валюта стартовой цены товара. Список доступных валют. |
original_price_value * | Стартовая цена товара без учёта скидок. |
original_price_internal_currency | Внутренняя валюта стартовой цены товара. |
original_price_internal_value | Стартовая цена товара во внтутренеей валюте. |
product_payload | Произвольный payload: дополнительная информация о отдельном товаре, представленная в виде пар key-value. Максимальный размер составляет 30 КБ. Если значение превышает этот предел, оно будет усечено AppMetrica. |
product_promo_codes | Массив применённых промокодов. |
product_sku | Индентификатор товара. |
screen_category_path_1 | Страница категории товаров 1 уровня. |
screen_category_path_2 | Страница категории товаров 2 уровня. |
screen_category_path_3 | Страница категории товаров 3 уровня. |
screen_category_path_4 | Страница категории товаров 4 уровня. |
screen_category_path_5 | Страница категории товаров 5 уровня. |
screen_category_path_6 | Страница категории товаров 6 уровня. |
screen_category_path_7 | Страница категории товаров 7 уровня. |
screen_category_path_8 | Страница категории товаров 8 уровня. |
screen_category_path_9 | Страница категории товаров 9 уровня. |
screen_category_path_10 | Страница категории товаров 10 уровня. |
screen_name | Название просмотренной страницы или экрана. |
screen_payload | Произвольный payload: дополнительная информация о странице, например, отдельной категории, представленная в виде пар key-value. Максимальный размер составляет 30 КБ. Если значение превышает этот предел, оно будет усечено AppMetrica. |
session_type | Тип сессии. Возможные значения:
Значение по умолчанию: |
ios_ifa | IFA устройства. |
ios_ifv | IFV устройства. |
google_aid | Google AID устройства. |
windows_aid | Windows AID устройства. |
os_name | Имя операционной системы на устройстве пользователя. Возможные значения: ios | android | windows. |
os_version | Версия операционной системы на устройстве пользователя. |
device_manufacturer | Производитель устройства. Например, Apple, Samsung. |
device_model | Модель устройства. Например, Galaxy S6, iPhone X. |
device_type | Тип устройства, определяется сервисом AppMetrica. Возможные значения: phone | tablet | phablet | tv | desktop | unknown. |
device_locale | Язык интерфейса устройства. Например, en_US |
app_version_name | Версия приложения в виде, как указана разработчиком. |
app_package_name | Имя пакета для Android или Bundle ID для iOS. Например, ru.yandex.sample.metrica. |
connection_type | Тип подключения устройства. Возможные значения: wifi | cell | unknown. |
operator_name | Имя оператора сотовой связи. Например, MegaFon. |
mcc | Мобильный код страны. Например, 250 |
mnc | Код мобильной сети. Например, 2 |
device_ipv6 | IP-адрес в момент совершения события в формате IPv6. Например, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147 |
* Обязательный параметр
Коды ответа
| Код | Описание |
|---|---|
| 200 | Данные успешно загружены. |
| 403 | Запрос не содержит заголовка авторизации, либо указан неверный токен. |
| 400 | Запрос не содержит одного или нескольких обязательных параметров. |
| Код | Описание |
|---|---|
| 200 | Данные успешно загружены. |
| 403 | Запрос не содержит заголовка авторизации, либо указан неверный токен. |
| 400 | Запрос не содержит одного или нескольких обязательных параметров. |
Пример запроса
POST /logs/v1/import/ecommerce.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 HTTP/1.1
Host: api.appmetrica.yandex.com
Content-Length: 540i
Connection: close
application_id,profile_id,appmetrica_device_id,event_timestamp,ecom_event_type,order_id,product_name,cart_item_quantity,cart_item_price_currency,cart_item_price_value,cart_item_price_internal_currency
cart_item_price_internal_value,actual_price_currency,actual_price_value,actual_price_internal_currency,actual_price_internal_value,payload,product_category_path_1,product_category_path_2,product_category_path_3,product_category_path_4,product_category_path_5,product_category_path_6,product_category_path_7,product_category_path_8,product_category_path_9,product_category_path_10,original_price_currency,original_price_value,original_price_internal_currency,original_price_internal_value,product_payload,product_promo_codes,product_sku,screen_category_path_1,screen_category_path_2,screen_category_path_3,screen_category_path_4,screen_category_path_5,screen_category_path_6,screen_category_path_7,screen_category_path_8,screen_category_path_9,screen_category_path_10,screen_name,screen_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,1234567890abcdef,1757762239877245682,1689943892,ADD_TO_CART,a1b2c3d4,some_product,1,usd,0.5,some_currency,1.43,usd,0.7,some_currency,2,"{""key"":""value_1""}",product_path_1,product_path_2,product_path_3,product_path_4,product_path_5,product_path_6,product_path_7,product_path_8,product_path_9,product_path_10,usd,1.05,some_currency,3,"{""key"":""value_1""}","[promo_code_1,promo_code_2]",012345abc,screen_path_1,screen_path_2,screen_path_3,screen_path_4,screen_path_5,screen_path_6,screen_path_7,screen_path_8,screen_path_9,screen_path_10,some_screen,"{""key"":""value_1""}",foreground,123456abcde,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:53d8POST /logs/v1/import/ecommerce.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012&application_id=1234567890&profile_id=1234567890abcdef&appmetrica_device_id=1757762239877245682&event_timestamp=1689943892&ecom_event_type=ADD_TO_CART&order_id=a1b2c3d4&product_name=some_product&cart_item_quantity=1&cart_item_price_currency=usd&cart_item_price_value=0.5&cart_item_price_internal_currency=some_currency&cart_item_price_internal_value=1.43&actual_price_currency=usd&actual_price_value=0.7&actual_price_internal_currency=some_currency&actual_price_internal_value=2&payload="{""key"":""value_1""}"&product_category_path_1=product_path_1&product_category_path_2=product_path_2&product_category_path_3=product_path_3&product_category_path_4=product_path_4&product_category_path_5=product_path_5&product_category_path_6=product_path_6&product_category_path_7=product_path_7&product_category_path_8=product_path_8&product_category_path_9=product_path_9&product_category_path_10=product_path_10&original_price_currency=usd&original_price_value=1.05&original_price_internal_currency=some_currency&original_price_internal_value=3&product_payload="{""key"":""value_1""}"&product_promo_codes="[promo_code_1,promo_code_2]"&product_sku=012345abc&screen_category_path_1=screen_path_1&screen_category_path_2=screen_path_2&screen_category_path_3=screen_path_3&screen_category_path_4=screen_path_4&screen_category_path_5=screen_path_5&screen_category_path_6=screen_path_6&screen_category_path_7=screen_path_7&screen_category_path_8=screen_path_8&screen_category_path_9=screen_path_9&screen_category_path_10=screen_path_10&screen_name=some_screen&screen_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.com
Content-Length: 0
Connection: close