报告的结构及内容如有更改,恕不另行通知
例如,可以添加新列或更改工作表的名称。
印象提升报告
方法适用于所有模式.
目前不适用于卖家Market Yandex Go.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
开始生成关于指定期间内展示次数提升的摘要报告。 什么是印象的提升?
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.
报告列说明:
表单Отчёт по кампаниям(文件business_shows_boost_consolidated_campaigns)
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DATE |
date |
Дата |
string |
|
SALE_CAMPAIGN_ID |
saleCampaignId |
ID кампании |
integer |
|
SALE_CAMPAIGN_NAME |
saleCampaignName |
Название кампании |
string |
|
SHOWS |
shows |
Показы, шт. |
integer |
|
COVERAGE |
coverage |
Охват, чел. |
integer |
|
CLICKS |
clicks |
Клики, шт. |
integer |
|
CTR |
ctr |
CTR, % |
number |
|
SHOWS_FREQUENCY |
showsFrequency |
Частота показа |
number |
|
CART_ADDITION |
cartAddition |
Добавления в корзину, шт. |
integer |
|
ORDERED_COUNT |
orderedCount |
Заказанные товары, шт. |
integer |
|
CONVERSION |
conversion |
Конверсия в заказы, % |
number |
|
ORDERED_AMOUNT |
orderedAmount |
Стоимость заказанных товаров, ₽ |
number |
|
CPO |
cpo |
СРО, ₽ |
number |
|
COST |
cost |
Расчётные расходы, ₽ |
number |
|
COST_SHARE |
costShare |
Доля расчетных расходов от выручки с бустом продаж с оплатой за показы |
number |
|
CPM |
cpm |
CPM, ₽ |
number |
|
REAL_COST |
realCost |
Фактические расходы, ₽ |
number |
|
DEDUCTED_BONUSES |
deductedBonuses |
Списано бонусов |
number |
表单Отчёт по товарам(文件business_shows_boost_consolidated_offers)
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
OFFER_ID |
offerId |
Ваш SKU |
string |
|
OFFER_NAME |
offerName |
Название товара |
string |
|
SHOWS |
shows |
Показы товаров с бустом продаж с оплатой за показы |
integer |
|
CLICKS |
clicks |
Клики по товарам с бустом продаж с оплатой за показы |
integer |
|
CART_ADDITION |
cartAddition |
Добавления в корзину с бустом продаж с оплатой за показы |
integer |
|
ORDERED_COUNT |
orderedCount |
Заказанные товары с бустом продаж с оплатой за показы |
integer |
|
CPM |
cpm |
CPM |
number |
|
COST |
cost |
Расчётные расходы на буст продаж с оплатой за показы, ₽ |
number |
|
ORDERED_AMOUNT |
orderedAmount |
Выручка с бустом продаж с оплатой за показы |
number |
|
SALES_CAMPAIGN_IDS |
salesCampaignIds |
ID кампаний |
string |
|
SALES_CAMPAIGN_NAMES |
salesCampaignNames |
Названия кампаний |
string |
| ⚙️ 限制: 每小时100个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/shows-boost/generate
Query parameters
|
Name |
Description |
|
format |
Type: string 报告或文档的格式。 报告格式:
Default: Enum: |
Body
application/json
{
"businessId": 1,
"dateFrom": "2025-08-22",
"dateTo": "2025-09-22",
"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",
"result": {
"reportId": "example",
"estimatedGenerationTime": 0
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
result
Type: object
estimatedGenerationTime
Type: integer
预计生成时间以毫秒为单位。
reportId
Type: string
跟踪生成状态和接收完成的报告或文档所需的ID。
Example:
example跟踪生成状态和接收完成的报告或文档所需的ID。
Example
{ "reportId": "example", "estimatedGenerationTime": 0 }Example
{ "result": { "reportId": "example", "estimatedGenerationTime": 0 } }
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.