--- metadata: - name: generator content: Diplodoc Platform v5.64.0 alternate: - https://boost.yandex.com/doc/en/analytics/content/mobile-api/logs/ref/ecommerce_events.md - https://boost.yandex.com/doc/ru/analytics/content/mobile-api/logs/ref/ecommerce_events.md - https://boost.yandex.com/doc/zh/analytics/content/mobile-api/logs/ref/ecommerce_events.md - href: https://boost.yandex.com/doc/zh/analytics/content/mobile-api/logs/ref/ecommerce_events.md type: text/markdown title: Markdown version - href: https://boost.yandex.com/doc/zh/llms.txt?revision=r21738064 rel: describedby --- > **Documentation Index:** Fetch the complete configuration index at https://boost.yandex.com/doc/zh/llms.txt?revision=r21738064 # 电子商务 返回特定日期范围内的应用内购买数据。 ## 请求格式 {#request-format} ``` GET https://api.boost.yandex.com/logs/v1/export/ecommerce_events.{csv | json} ? application_id= & date_since= & date_until= & fields= & [date_dimension=] & [limit=] & [use_utf8_bom=] & [=] & [skip_unavailable_shards=] ``` #| || `应用ID`* | 按应用在 Analytics module 中的数字 ID 过滤。 || || `date_since`* | 日期范围的开始，格式为 `yyyy-mm-dd hh:mm:ss`。 您还可以定义影响 `date_dimension` 查询参数中数据的日期和时间类型。 || || `date_until`* | 日期范围的结束，格式为 `yyyy-mm-dd hh:mm:ss`。 您还可以定义影响 `date_dimension` 查询参数中数据的日期和时间类型。 || || `字段`* | 用逗号分隔的[字段列表](https://boost.yandex.com/doc/zh/analytics/content/mobile-api/logs/endpoints.md)，用于示例。 一个包含所有可用字段的列表（便于快速复制）： ```objectivec translate=no ecom_type,ecom_screen_name,ecom_screen_search_query,ecom_screen_payload,ecom_screen_category_path_1,ecom_screen_category_path_2,ecom_screen_category_path_3,ecom_screen_category_path_4,ecom_screen_category_path_5,ecom_screen_category_path_6,ecom_screen_category_path_7,ecom_screen_category_path_8,ecom_screen_category_path_9,ecom_screen_category_path_10,ecom_product_name,ecom_product_sku,ecom_product_promocodes,ecom_product_payload,ecom_product_category_path_1,ecom_product_category_path_2,ecom_product_category_path_3,ecom_product_category_path_4,ecom_product_category_path_5,ecom_product_category_path_6,ecom_product_category_path_7,ecom_product_category_path_8,ecom_product_category_path_9,ecom_product_category_path_10,ecom_product_actual_price_fiat_unit_type,ecom_product_actual_price_fiat_value,ecom_product_actual_price_internal_components,ecom_product_original_price_fiat_unit_type,ecom_product_original_price_fiat_value,ecom_product_original_price_internal_components,ecom_cart_item_price_fiat_unit_type,ecom_cart_item_price_fiat_value,ecom_cart_item_quantity,ecom_cart_item_internal_components,ecom_referrer_type,ecom_referrer_id,ecom_order_id,ecom_order_payload,event_datetime,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,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,event_datetime,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`：服务器收到事件信息时。 || || `限制` | 列表中项目数量的限制。 默认取最大值。 不保证请求之间的结果一致（结果排序可能存在差异）。 || || `use_utf8_bom` | 启用字节顺序标记使用的参数。 默认值为 `false`。 || || `` | 按可用字段之一的值过滤。 仅支持相等检查操作。 || || `skip_unavailable_shards` | 用于[提高数据可用性](https://boost.yandex.com/doc/zh/analytics/content/mobile-api/logs/request-procedure.md#availability)。 默认值为 `false`。 || |# ## 响应格式 {#response-format} 如果请求了所有可用的字段： {% list tabs %} - JSON ```json translate=no { "data": [ { "ecom_type": "string", "ecom_screen_name": "string", "ecom_screen_search_query": "string", "ecom_screen_payload": "string", "ecom_screen_category_path_1": "string", "ecom_screen_category_path_2": "string", "ecom_screen_category_path_3": "string", "ecom_screen_category_path_4": "string", "ecom_screen_category_path_5": "string", "ecom_screen_category_path_6": "string", "ecom_screen_category_path_7": "string", "ecom_screen_category_path_8": "string", "ecom_screen_category_path_9": "string", "ecom_screen_category_path_10": "string", "ecom_product_name": "string", "ecom_product_sku": "integer", "ecom_product_promocodes": "string", "ecom_product_payload": "string", "ecom_product_category_path_1": "string", "ecom_product_category_path_2": "string", "ecom_product_category_path_3": "string", "ecom_product_category_path_4": "string", "ecom_product_category_path_5": "string", "ecom_product_category_path_6": "string", "ecom_product_category_path_7": "string", "ecom_product_category_path_8": "string", "ecom_product_category_path_9": "string", "ecom_product_category_path_10": "string", "ecom_product_actual_price_fiat_unit_type": "string", "ecom_product_actual_price_fiat_value": "string", "ecom_product_actual_price_internal_components": "string", "ecom_product_original_price_fiat_unit_type": "string", "ecom_product_original_price_fiat_value": "string", "ecom_product_original_price_internal_components": "string", "ecom_cart_item_price_fiat_unit_type": "string", "ecom_cart_item_price_fiat_value": "string", "ecom_cart_item_quantity": "integer", "ecom_cart_item_internal_components": "string", "ecom_referrer_type": "string", "ecom_referrer_id": "integer", "ecom_order_id": "integer", "ecom_order_payload": "string", "event_datetime": "string", "event_json": "string", "event_name": "string", "event_receive_datetime": "string", "event_receive_timestamp": "integer", "event_timestamp": "integer", "session_id": "integer", "installation_id": "string", "appmetrica_device_id": "integer", "city": "string", "connection_type": "string", "country_iso_code": "string", "device_ipv6": "string", "device_locale": "string", "device_manufacturer": "string", "device_model": "string", "device_type": "string", "google_aid": "string", "ios_ifa": "string", "ios_ifv": "string", "mcc": "integer", "mnc": "integer", "operator_name": "string", "original_device_model": "string", "os_name": "string", "os_version": "string", "profile_id": "string", "windows_aid": "string", "app_build_number": "integer", "app_package_name": "string", "app_version_name": "string", "application_id": "integer" }, ... ] } ``` - CSV ``` application_id,ios_ifa,os_name,... 1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,... 1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,... 1111,,android ... ``` {% endlist %} #| || `ecom_type` | 购买事件类型。 可能的值： - `show_screen` - `show_product_card` - `show_product_details` - `add_cart_item` - `remove_cart_item` - `begin_checkout` - `purchase` || || `ecom_screen_name` | 屏幕名称。 || || `ecom_screen_search_query` | 搜索查询。 || || `ecom_screen_payload` | SDK传递的屏幕参数 格式是一个 JSON 对象，包含字符串键值对，例如： ``` { "configuration": "landscape", "fullscreen": "true" } ``` || || `ecom_screen_category_path_1` | 屏幕类别。 Level 1. || || `ecom_screen_category_path_2` | 屏幕类别。 Level 2. || || `ecom_screen_category_path_3` | 屏幕类别。 Level 3. || || `ecom_screen_category_path_4` | 屏幕类别。 Level 4. || || `ecom_screen_category_path_5` | 屏幕类别。 Level 5. || || `ecom_screen_category_path_6` | 屏幕类别。 Level 6. || || `ecom_screen_category_path_7` | 屏幕类别。 Level 7. || || `ecom_screen_category_path_8` | 屏幕类别。 Level 8. || || `ecom_screen_category_path_9` | 屏幕类别。 Level 9. || || `ecom_screen_category_path_10` | 屏幕类别。 Level 10. || || `ecom_product_name` | 产品名称。 || || `ecom_product_sku` | Product ID. || || `ecom_product_promocodes` | 产品促销码。 格式为 JSON 数组字符串，例如： ``` ["BT79IYX", "UT5412EP"] ``` || || `ecom_product_payload` | 传递给 SDK 的产品参数。 格式为 JSON 对象，包含字符串键值对，例如： ``` { "configuration": "landscape", "fullscreen": "true" } ``` || || `ecom_product_category_path_1` | 产品类别。 Level 1. || || `ecom_product_category_path_2` | 产品类别。 Level 2. || || `ecom_product_category_path_3` | 产品类别。 Level 3. || || `ecom_product_category_path_4` | 产品类别。 Level 4. || || `ecom_product_category_path_5` | 产品类别。 Level 5. || || `ecom_product_category_path_6` | 产品类别。 Level 6. || || `ecom_product_category_path_7` | 产品类别。 Level 7. || || `ecom_product_category_path_8` | 产品类别。 Level 8. || || `ecom_product_category_path_9` | 产品类别。 Level 9. || || `ecom_product_category_path_10` | 产品类别。 Level 10. || || `ecom_product_actual_price_fiat_unit_type` | 实际产品价格的货币。 || || `ecom_product_actual_price_fiat_value` | 实际产品价格。 || || `ecom_product_actual_price_internal_components` | 产品实际价格的组成部分。 格式为 JSON 对象数组，每个对象包含一对键值对，例如： ``` [ { "wood": 25.01 }, { "iron": 10 } ] ``` || || `ecom_product_original_price_fiat_unit_type` | 基础产品价格的货币。 || || `ecom_product_original_price_fiat_value` | 基础产品价格。 || || `ecom_product_original_price_internal_components` | 基础产品价格的组成部分。 格式为 JSON 对象数组，每个对象包含一对键值对，例如： ``` [ { "wood": 25.01 }, { "iron": 10 } ] ``` || || `ecom_cart_item_price_fiat_unit_type` | 购物车中商品的价格货币。 || || `ecom_cart_item_price_fiat_value` | 购物车中商品的价格。 || || `ecom_cart_item_quantity` | 购物车中的商品数量。 || || `ecom_cart_item_internal_components` | 购物车中商品的价格组成。 格式为 JSON 对象数组，每个对象包含一对键值对，例如： ``` [ { "wood": 25.01 }, { "iron": 10 } ] ``` || || `ecom_referrer_type` | 流量来源类型。 || || `ecom_referrer_id` | 流量来源 ID。 || || `ecom_order_id` | 购买 ID。 || || `ecom_order_payload` | 购买参数传递给SDK。 格式是一个 JSON 对象，包含字符串键值对，例如： ``` { "configuration": "landscape", "fullscreen": "true" } ``` || || `event_datetime` | 事件的日期和时间，格式为 `yyyy-mm-dd hh:mm:ss`。 || || `event_name` | 事件名称（按传递给 SDK 的方式）。 || || `event_receive_datetime` | 服务器端收到事件的日期和时间。 由于网络延迟或用户设备在事件发生时未连接，可能与 `event_datetime` 不同。 || || `event_receive_timestamp` | 服务器端收到事件的时间，格式为 [Unix time](https://en.wikipedia.org/wiki/Unix_time)。 由于网络延迟或用户设备在事件发生时未连接，可能与 `event_timestamp` 不同。 || || `event_timestamp` | 事件的时间，格式为 [Unix time](https://en.wikipedia.org/wiki/Unix_time)。 使用 Post API，您只能在事件日期（event_timestamp）与上传日期之间的差异不超过 14 天时上传事件。 API 期望以秒为单位的值。 || || `session_id` | 会话 ID。 `installation_id`、`session_id` 和平台设备 ID（`google_aid` / `ios_ifa`）的值集允许您唯一标识用户的会话。 || || `installation_id` | 安装 ID。 || || `城市` | 城市名称（英文）。 || || `连接类型` | 连接类型。 可能的值：`wifi` \| `cell` \| `unknown`。 || || `country_iso_code` | ISO 国家代码。 || || `device_ipv6` | 事件时的 IP 地址，格式为 [IPv6](https://en.wikipedia.org/wiki/IPv6)。 例如，2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147。 || || `device_locale` | 设备上的语言。 || || `设备制造商` | Analytics 服务检测到的设备制造商（例如，Apple 或 Samsung）。 || || `设备型号` | Analytics 服务检测到的设备型号（例如，Galaxy S6）。 || || `device_type` | Analytics 服务检测到的设备类型。 可能的值：`phone` \| `tablet` \| `unknown`。 || || `google_aid` | 设备的 Google AID，格式为从设备接收的格式。 || || `ios_ifa` | 设备的 IFA，格式为从设备接收的格式。 || || `ios_ifv` | 应用的 IFV，格式为从设备接收的格式。 || || `mcc` | 移动国家代码。 || || `mnc` | 移动网络代码。 || || `operator_name` | 移动运营商名称。 || || `原始设备型号` | 设备的出厂型号（例如，对于 Galaxy S8，可能的值有：SM-G9550、SM-G9558 等）。 || || `os_name` | 用户设备上的操作系统：`ios` \| `android` \| `windows`。 || || `os_version` | 用户设备上的操作系统版本。 || || `profile_id` | 用户个人资料 ID。 || || `windows_aid` | 设备的 Windows AID，格式为从设备接收的格式。 || || `app_build_number` | 应用构建号。 || || `app_package_name` | Android 的包名，或 iOS 的 Bundle ID（例如，ru.yandex.metro）。 || || `app_version_name` | 开发者指定的应用版本格式。 || || `application_id` | 应用在 Analytics module 中的唯一数字标识符。 || |# ## Example {#example} 请求: ```bash translate=no curl -X GET \ 'https://api.boost.yandex.com/logs/v1/export/ecommerce_events.json?application_id=2421017&date_since=2023-01-04+00%3A00%3A00&date_until=2023-01-04+23%3A59%3A59&date_dimension=receive&use_utf8_bom=true&fields=ecom_type,ecom_screen_name,ecom_screen_search_query,ecom_screen_payload,ecom_screen_category_path_1,ecom_screen_category_path_2,ecom_screen_category_path_3,ecom_screen_category_path_4,ecom_screen_category_path_5,ecom_screen_category_path_6,ecom_screen_category_path_7,ecom_screen_category_path_8,ecom_screen_category_path_9,ecom_screen_category_path_10,ecom_product_name,ecom_product_sku,ecom_product_promocodes,ecom_product_payload,ecom_product_category_path_1,ecom_product_category_path_2,ecom_product_category_path_3,ecom_product_category_path_4,ecom_product_category_path_5,ecom_product_category_path_6,ecom_product_category_path_7,ecom_product_category_path_8,ecom_product_category_path_9,ecom_product_category_path_10,ecom_product_actual_price_fiat_unit_type,ecom_product_actual_price_fiat_value,ecom_product_actual_price_internal_components,ecom_product_original_price_fiat_unit_type,ecom_product_original_price_fiat_value,ecom_product_original_price_internal_components,ecom_cart_item_price_fiat_unit_type,ecom_cart_item_price_fiat_value,ecom_cart_item_quantity,ecom_cart_item_internal_components,ecom_referrer_type,ecom_referrer_id,ecom_order_id,ecom_order_payload,event_datetime,event_json,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,session_id,installation_id,appmetrica_device_id,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_name,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name,application_id' \ -H 'Authorization: OAuth oauth_token' ``` 响应： ```json translate=no { "data": [ { "ecom_type": "show_screen", "ecom_screen_name": "", "ecom_screen_search_query": "", "ecom_screen_payload": { "full_screen": "true" }, "ecom_screen_category_path_1": "", "ecom_screen_category_path_2": "", "ecom_screen_category_path_3": "", "ecom_screen_category_path_4": "", "ecom_screen_category_path_5": "", "ecom_screen_category_path_6": "", "ecom_screen_category_path_7": "", "ecom_screen_category_path_8": "", "ecom_screen_category_path_9": "", "ecom_screen_category_path_10": "", "ecom_product_name": "", "ecom_product_sku": "", "ecom_product_promocodes": [], "ecom_product_payload": {}, "ecom_product_category_path_1": "", "ecom_product_category_path_2": "", "ecom_product_category_path_3": "", "ecom_product_category_path_4": "", "ecom_product_category_path_5": "", "ecom_product_category_path_6": "", "ecom_product_category_path_7": "", "ecom_product_category_path_8": "", "ecom_product_category_path_9": "", "ecom_product_category_path_10": "", "ecom_product_actual_price_fiat_unit_type": "", "ecom_product_actual_price_fiat_value": 0, "ecom_product_actual_price_internal_components": [], "ecom_product_original_price_fiat_unit_type": "", "ecom_product_original_price_fiat_value": 0, "ecom_product_original_price_internal_components": [], "ecom_cart_item_price_fiat_unit_type": "", "ecom_cart_item_price_fiat_value": 0, "ecom_cart_item_quantity": 0, "ecom_cart_item_internal_components": [], "ecom_referrer_type": "", "ecom_referrer_id": "", "ecom_order_id": "", "ecom_order_payload": {}, "event_datetime": "2024-07-29 23:37:01", "event_receive_datetime": "2024-07-29 23:37:14", "event_name": "", "event_receive_timestamp": 1722285434, "event_timestamp": 1722285421, "session_id": 10000000807, "installation_id": "6559cf2bb96c44189ef889bc4976b240", "appmetrica_device_id": 383777566819598200, "city": "", "connection_type": "wifi", "country_iso_code": "RU", "device_ipv6": "::ffff:79.173.67.100", "device_locale": "ru_RU", "device_manufacturer": "Realme", "device_model": "realme C21", "device_type": "phone", "google_aid": "", "ios_ifa": "", "ios_ifv": "", "mcc": 250, "mnc": 1, "operator_name": "MTS RUS", "original_device_model": "RMX3201", "os_name": "android", "os_version": 11, "profile_id": 107010519, "windows_aid": "", "app_build_number": 2024060301, "app_package_name": "com.biglion", "app_version_name": "7.4.40", "application_id": 178725 }, ... ] } ``` ### 另请参见 {#see-also} - [如何根据原始数据确定事件的来源？](https://boost.yandex.com/doc/zh/analytics/content/troubleshooting/troubleshooting.md#raw-data) 如果您没有找到所需答案，可以通过反馈表单提交您的问题。 请尽可能详细地描述问题。 如果可能，请附上截图。 联系支持 为文档提出改进建议