报告的结构及内容如有更改,恕不另行通知。
例如,可以添加新列或更改工作表的名称。
货架报告
方法适用于所有模式.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
开始在货架上生成摘要报告 — 广告块与横幅或视频和一组产品. 阅读更多关于他们的信息 在市场对卖家的帮助.
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.
报告列说明:
表单Общий отчет(文件shelfs_statistics_summary)
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DATE |
date |
Дата |
string |
|
INCUT_ID |
incutId |
ID кампании |
integer |
|
TITLE |
title |
Название кампании |
string |
|
IMPRESSIONS |
impressions |
Показы, шт. |
integer |
|
COVERAGE |
coverage |
Охват, чел. |
integer |
|
CLICKS |
clicks |
Клики, шт. |
integer |
|
CTR |
ctr |
CTR, % |
number |
|
AVERAGE_IMPRESSION_FREQUENCY |
averageImpressionFrequency |
Частота показа |
number |
|
TO_CART |
toCart |
Добавления в корзину, шт. |
integer |
|
ORDERED |
ordered |
Заказанные товары, шт. |
integer |
|
CONVERSION |
conversion |
Конверсия в заказы, % |
number |
|
ORDERED_AMOUNT |
orderedAmount |
Стоимость заказанных товаров, ₽ |
number |
|
CPO |
cpo |
СРО, ₽ |
number |
|
COST |
cost |
Расчётные расходы, ₽ |
number |
|
CPM |
cpm |
CPM, ₽ |
number |
|
DRR |
drr |
Доля расчётных расходов от выручки с полкой |
number |
|
REAL_COST |
realCost |
Фактические расходы (с НДС), ₽ |
number |
|
DEDUCTED_BONUSES |
deductedBonuses |
Списано бонусов |
number |
表单Таргетинг по категориям(文件shelfs_statistics_by_category)
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DATE |
date |
Дата |
string |
|
INCUT_ID |
incutId |
ID кампании |
integer |
|
TITLE |
title |
Название кампании |
string |
|
SHOW_CATEGORY_NAME |
showCategoryName |
Категория показа полки |
string |
|
IMPRESSIONS |
impressions |
Показы, шт. |
integer |
|
COVERAGE |
coverage |
Охват, чел. |
integer |
|
CLICKS |
clicks |
Клики, шт. |
integer |
|
CTR |
ctr |
CTR, % |
number |
|
AVERAGE_IMPRESSION_FREQUENCY |
averageImpressionFrequency |
Частота показа |
number |
|
TO_CART |
toCart |
Добавления в корзину, шт. |
integer |
|
ORDERED |
ordered |
Заказанные товары, шт. |
integer |
|
CONVERSION |
conversion |
Конверсия в заказы, % |
number |
|
ORDERED_AMOUNT |
orderedAmount |
Стоимость заказанных товаров, ₽ |
number |
|
CPO |
cpo |
СРО, ₽ |
number |
|
COST |
cost |
Расчётные расходы, ₽ |
number |
|
CPM |
cpm |
CPM, ₽ |
number |
|
DRR |
drr |
Доля расчётных расходов от выручки с полкой |
number |
| ⚙️ 限制: 每小时100个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/shelf-statistics/generate
Query parameters
|
Name |
Description |
|
format |
Type: string 报告或文档的格式。 报告格式:
Default: Enum: |
Body
application/json
{
"businessId": 1,
"dateFrom": "2025-01-01",
"dateTo": "2025-01-01",
"attributionType": "CLICKS"
}
|
Name |
Description |
|
attributionType |
Type: string 归因类型:
有关报告中哪些数据取决于和不依赖于归因类型的信息,请阅读 在市场对卖家的帮助. Enum: |
|
businessId |
Type: integer 内阁ID。 要找到答案,请使用请求 GET v2/campaigns. Min value: |
|
dateFrom |
Type: string<date> 期的开始,包括在内。 Example: |
|
dateTo |
Type: string<date> 期结束,包括在内。 Example: |
Responses
200 OK
作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Yandex的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK"
}
Type: object
pathParams: []
searchParams:
- description: 报告或文档的格式。
name: format
in: query
required: false
schema:
description: |
报告格式:
* `FILE` — 电子表格文件(XLSX).
* `CSV` — 每个报告表都有一个包含CSV文件的ZIP存档。
* `JSON` — 每个报告表都有一个带有JSON文件的ZIP压缩包.
type: string
enum:
- FILE
- CSV
- JSON
default: FILE
headers: []
body: |-
{
"businessId": 1,
"dateFrom": "2025-01-01",
"dateTo": "2025-01-01",
"attributionType": "CLICKS"
}
schema:
description: |
生成报告所需的数据。
type: object
required:
- businessId
- attributionType
- dateFrom
- dateTo
properties:
businessId:
description: "内阁ID。 要找到答案,请使用请求 [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [什么是市场上的橱柜和商店?](https://yandex.ru/support/marketplace/account/introduction.html)\n"
type: integer
format: int64
minimum: 1
dateFrom:
description: 期的开始,包括在内。
format: date
type: string
dateTo:
description: 期结束,包括在内。
format: date
type: string
attributionType:
type: string
description: >
归因类型:
* `CLICKS` — 通过点击。
* `SHOWS` — 通过印象。
<br><br>
有关报告中哪些数据取决于和不依赖于归因类型的信息,请阅读
[在市场对卖家的帮助](https://yandex.ru/support2/marketplace/ru/marketing/shelf#stats).
enum:
- CLICKS
- SHOWS
bodyType: application/json
method: post
security:
- type: apiKey
name: 'Api-Key'
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/reports/shelf-statistics/generate
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.