上传电商事件

传输关于电商事件的数据。

使用示例：您可以通过 Post API 传输所有电商事件，将用户购买数据（包括在应用、实体店或网站上完成的购买）统一收集在一个地方。

事件属性可以通过参数或请求体传递。 当您在正文中传递数据时，应将.csv添加到请求的URL中。 要了解更多信息，请查看示例请求。

要将事件绑定到用户，您需要在API请求中使用以下字段之一：

  • profile_id
  • appmetrica 设备 ID

注意

Post API 有数据加载限制。 要了解更多信息，请查看限制。

请求格式

提交 https://api.boost.yandex.com/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>]
  & [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_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>]

  & [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 密钥*

用于数据上传的令牌。 您可以在应用的 设置 部分获取它。

应用ID*

应用在 Analytics module 中的唯一数字标识符。

profile_id*

用户个人资料 ID。 Post API 仅允许您上传先前通过 SDK 发送的标识符的数据。

注意

不要传递 appmetrica_device_id 参数的值。 服务器只接受这些参数中的一个。

appmetrica 设备 ID*

Analytics module 设置的设备唯一标识符的哈希。 Post API 仅允许您上传先前通过 SDK 发送的标识符的数据。

注意

不要传递 profile_id 参数。 服务器只接受这些参数中的一个。

事件时间戳*

事件的时间，格式为 Unix time。

使用 Post API，您只能在事件日期（event_timestamp）与上传日期之间的差异不超过 14 天时上传事件。 API 期望以秒为单位的值。

电子商务事件类型*

电子商务事件类型。 可能的值：SHOW_SCREEN、SHOW_PRODUCT_CARD、SHOW_PRODUCT_DETAILS、ADD_TO_CART、REMOVE_FROM_CART、BEGIN_CHECKOUT、PURCHASE。

order_id*

订单 ID。

产品名称*

产品名称。

购物车商品数量*

购物车中的商品数量。

购物车商品价格货币

购物车中产品的价格货币。 如果未指定，将使用actual_price_currency值。 可用的货币列表.

购物车商品价格值

购物车中商品的价格。 这是最终价格，已包含用户应用的所有促销活动、促锐码、积分和其他折扣。 如果未指定，则使用actual_price_value值。

购物车商品价格（内部货币）

购物车中产品的内部货币类型。 如果未指定，将使用actual_price_internal_currency 的值。

购物车项目价格内部值

购物车中产品的价格，以内部货币表示。 这是最终价格，包括用户应用的所有促销活动、促锐码、积分和其他折扣。 如果未指定，将使用actual_price_internal_value 的值。

实际价格货币

实际产品价格的货币。 如果未指定，将使用original_price_currency值。 可用的货币列表.

实际价格值

实际产品价格。 这是当前产品价格，包括折扣。 如果未指定，则使用original_price_value值。

实际价格（内部货币）

产品实际价格的内部货币。 如果未指定，将使用original_price_internal_currency 的值。

实际价格内部值

产品的实际价格，以内部货币表示。 这是当前产品价格，包括折扣。 如果未指定，则使用original_price_internal_value值。

产品类别路径_1

第1级产品类别。

产品分类路径2

第2级产品类别。

产品类别路径3

Level 3 产品类别。

产品类别路径_4

Level 4 产品类别。

产品类别路径_5

Level 5 产品类别。

产品_类别_路径_6

Level 6 产品类别。

产品类别路径_7

Level 7 产品类别。

产品_类别_路径_8

Level 8 产品类别。

产品类别路径_9

Level 9 产品类别。

产品类别路径_10

Level 10 产品类别。

原始价格货币*

初始产品价格的货币。 可用货币列表.

原始价格值*

产品原价（未折扣）。

原始价格（内部货币）

初始产品价格的内部货币。

原始价格内部值

产品的初始价格（内部货币）。

产品促销码

已应用的促销码数组。

product_sku

Product ID.

屏幕类别路径_1

第 1 级产品类别页面。

屏幕_类别_路径_2

第2级产品类别页面。

屏幕类别路径_3

第3级产品类别页面。

屏幕分类路径_4

第4级产品类别页面。

屏幕分类路径5

Level 5 产品类别页面。

屏幕_类别_路径_6

Level 6 产品类别页面。

屏幕类别路径_7

Level 7 产品类别页面。

屏幕_类别_路径_8

Level 8 产品类别页面。

屏幕_类别_路径_9

Level 9 产品类别页面。

屏幕_类别_路径_10

Level 10 产品类别页面。

screen_name

查看的页面或屏幕的名称。

session_type

会话类型。 可能的值：

  • 前景 — 在 事件 报告中Analytics module 增加了 用户 指标。
  • 背景 — 在 事件 报告中 Analytics module 增加了 设备 指标。 这样的事件不会被包含在按用户分组的报告中，也不会出现在个人卡片中。

Default value is 背景.

ios_ifa

设备的 IFA，格式为从设备接收的格式。

ios_ifv

应用的 IFV，格式为从设备接收的格式。

google_aid

设备的 Google AID，格式为从设备接收的格式。

windows_aid

设备的 Windows AID，格式为从设备接收的格式。

os_name

用户设备上的操作系统：ios | android | windows。

os_version

用户设备上的操作系统版本。

设备制造商

Analytics 服务检测到的设备制造商（例如，Apple 或 Samsung）。

设备模型

Analytics 服务检测到的设备型号（例如，Galaxy S6）。

device_type

Analytics 服务检测到的设备类型。 可能的值：phone | tablet | unknown。

device_locale

设备上的语言。

app_version_name

开发者指定的应用版本格式。

app_package_name

Android 的包名，或 iOS 的 Bundle ID（例如，ru.yandex.metro）。

连接类型

连接类型。 可能的值：wifi | cell | unknown。

operator_name

移动运营商名称。

mcc

移动国家代码。

mnc

移动网络代码。

device_ipv6

事件时的 IP 地址，格式为 IPv6。 例如，2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147。

Response codes

Code 描述
200 数据已成功上传。
403 请求缺少授权头，或者指定了无效的令牌。
400 请求缺少一个或多个必需参数。

示例请求

POST /logs/v1/import/ecommerce.csv?post_api_key=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012 HTTP/1.1
Host: api.boost.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,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_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,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,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:53d8

POST /logs/v1/import/ecommerce?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&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_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&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.boost.yandex.com
Content-Length: 0
Connection: close

其他 Post API 方法

如果您没有找到所需答案，可以通过反馈表单提交您的问题。 请尽可能详细地描述问题。 如果可能，请附上截图。

联系支持 建议改进文档
上一篇
上传广告收入事件
下一篇
个人资料属性