报告的结构及内容如有更改，恕不另行通知。
例如，可以添加新列或更改工作表的名称。
复盖推广报告
方法适用于所有模式.
目前不适用于卖家Market Yandex Go.
如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一
开始生成有关复盖推广的摘要报告。 这是什么报告: 横幅广告, 对于推送通知.
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.
报告列说明：
表单Общий отчет（文件banners_statistics_report_consolidated）
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DATE |
date |
Дата |
string |
|
CAMPAIGN_TYPE |
campaignType |
Тип кампании |
string |
|
CAMPAIGN_ID |
campaignId |
ID кампании |
integer |
|
CAMPAIGN_NAME |
campaignName |
Название кампании |
string |
|
SHOWS |
shows |
Показы, шт. |
integer |
|
COVERAGE |
coverage |
Охват, чел. |
integer |
|
CLICKS |
clicks |
Клики, шт. |
integer |
|
CTR |
ctr |
CTR, % |
number |
|
SHOWS_FREQUENCY |
showsFrequency |
Частота показа |
number |
|
WATCHED_VIDEO_25 |
watchedVideo25 |
Просмотры 25% |
number |
|
WATCHED_VIDEO_50 |
watchedVideo50 |
Просмотры 50% |
number |
|
WATCHED_VIDEO_75 |
watchedVideo75 |
Просмотры 75% |
number |
|
WATCHED_VIDEO_100 |
watchedVideo100 |
Просмотры 100% |
number |
|
VTR_25 |
vtr25 |
VTR 25% |
number |
|
VTR_50 |
vtr50 |
VTR 50% |
number |
|
VTR_75 |
vtr75 |
VTR 75% |
number |
|
VTR_100 |
vtr100 |
VTR 100% |
number |
|
TURN_ON_VOLUME |
turnOnVolume |
Включения звука |
integer |
|
TURN_OFF_VOLUME |
turnOffVolume |
Выключения звука |
integer |
|
CART_ADDICTION |
cartAddiction |
Добавления в корзину, шт. |
integer |
|
ORDERED_COUNT |
orderedCount |
Заказанные товары, шт. |
integer |
|
CONVERSION |
conversion |
Конверсия в заказы, % |
number |
|
ORDERED_AMOUNT |
orderedAmount |
Стоимость заказанных товаров, ₽ |
number |
|
CPO |
cpo |
СРО, ₽ |
number |
|
COST |
cost |
Расчётные расходы, ₽ |
number |
|
CPM |
cpm |
CPM, ₽ |
number |
|
CPV |
cpv |
CPV, ₽ |
number |
|
REAL_COST |
realCost |
Фактические расходы (с НДС), ₽ |
number |
|
DEDUCTED_BONUSES |
deductedBonuses |
Списано бонусов |
number |
|
DRR |
drr |
Доля расчётных расходов от выручки с баннером, % |
number |
表单Таргетинг по площадкам（文件banners_statistics_report_by_service_type）
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DATE |
date |
Дата |
string |
|
CAMPAIGN_TYPE |
campaignType |
Тип кампании |
string |
|
CAMPAIGN_ID |
campaignId |
ID кампании |
integer |
|
CAMPAIGN_NAME |
campaignName |
Название кампании |
string |
|
SERVICE_TYPE |
serviceType |
Площадка |
string |
|
SHOWS |
shows |
Показы, шт. |
integer |
|
COVERAGE |
coverage |
Охват, чел. |
integer |
|
CLICKS |
clicks |
Клики, шт. |
integer |
|
CTR |
ctr |
CTR, % |
number |
|
SHOWS_FREQUENCY |
showsFrequency |
Частота показа |
number |
|
WATCHED_VIDEO_25 |
watchedVideo25 |
Просмотры 25% |
number |
|
WATCHED_VIDEO_50 |
watchedVideo50 |
Просмотры 50% |
number |
|
WATCHED_VIDEO_75 |
watchedVideo75 |
Просмотры 75% |
number |
|
WATCHED_VIDEO_100 |
watchedVideo100 |
Просмотры 100% |
number |
|
VTR_25 |
vtr25 |
VTR 25% |
number |
|
VTR_50 |
vtr50 |
VTR 50% |
number |
|
VTR_75 |
vtr75 |
VTR 75% |
number |
|
VTR_100 |
vtr100 |
VTR 100% |
number |
|
TURN_ON_VOLUME |
turnOnVolume |
Включения звука |
integer |
|
TURN_OFF_VOLUME |
turnOffVolume |
Выключения звука |
integer |
|
CART_ADDICTION |
cartAddiction |
Добавления в корзину, шт. |
integer |
|
ORDERED_COUNT |
orderedCount |
Заказанные товары, шт. |
integer |
|
CONVERSION |
conversion |
Конверсия в заказы, % |
number |
|
ORDERED_AMOUNT |
orderedAmount |
Стоимость заказанных товаров, ₽ |
number |
|
CPO |
cpo |
СРО, ₽ |
number |
|
COST |
cost |
Расчётные расходы, ₽ |
number |
|
CPM |
cpm |
CPM, ₽ |
number |
|
CPV |
cpv |
CPV, ₽ |
number |
|
DRR |
drr |
Доля расчётных расходов от выручки с баннером, % |
number |
表单Таргетинг по срезам（文件banners_statistics_report_by_slices）
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DATE |
date |
Дата |
string |
|
CAMPAIGN_TYPE |
campaignType |
Тип кампании |
string |
|
CAMPAIGN_ID |
campaignId |
ID кампании |
integer |
|
CAMPAIGN_NAME |
campaignName |
Название кампании |
string |
|
SERVICE_TYPE |
serviceType |
Площадка |
string |
|
CREATIVE_FORMAT |
creativeFormat |
Формат |
string |
|
CREATIVE_HASH |
creativeHash |
Id варианта |
string |
|
CREATIVE_URL |
creativeUrl |
Ссылка на креатив |
string |
|
COPYRIGHT |
copyright |
Копирайт |
string |
|
SHOWS |
shows |
Показы, шт. |
integer |
|
COVERAGE |
coverage |
Охват, чел. |
integer |
|
CLICKS |
clicks |
Клики, шт. |
integer |
|
CTR |
ctr |
CTR, % |
number |
|
SHOWS_FREQUENCY |
showsFrequency |
Частота показа |
number |
|
WATCHED_VIDEO_25 |
watchedVideo25 |
Просмотры 25% |
number |
|
WATCHED_VIDEO_50 |
watchedVideo50 |
Просмотры 50% |
number |
|
WATCHED_VIDEO_75 |
watchedVideo75 |
Просмотры 75% |
number |
|
WATCHED_VIDEO_100 |
watchedVideo100 |
Просмотры 100% |
number |
|
VTR_25 |
vtr25 |
VTR 25% |
number |
|
VTR_50 |
vtr50 |
VTR 50% |
number |
|
VTR_75 |
vtr75 |
VTR 75% |
number |
|
VTR_100 |
vtr100 |
VTR 100% |
number |
|
TURN_ON_VOLUME |
turnOnVolume |
Включения звука |
integer |
|
TURN_OFF_VOLUME |
turnOffVolume |
Выключения звука |
integer |
|
CART_ADDICTION |
cartAddiction |
Добавления в корзину, шт. |
integer |
|
ORDERED_COUNT |
orderedCount |
Заказанные товары, шт. |
integer |
|
CONVERSION |
conversion |
Конверсия в заказы, % |
number |
|
ORDERED_AMOUNT |
orderedAmount |
Стоимость заказанных товаров, ₽ |
number |
|
CPO |
cpo |
СРО, ₽ |
number |
|
COST |
cost |
Расчётные расходы, ₽ |
number |
|
CPM |
cpm |
CPM, ₽ |
number |
|
CPV |
cpv |
CPV, ₽ |
number |
|
DRR |
drr |
Доля расчётных расходов от выручки с баннером, % |
number |
表单Атрибуция по товарам（文件banners_statistics_report_by_sku）
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DATE |
date |
Дата |
string |
|
INCUT_TYPE |
incutType |
Тип кампании |
string |
|
INCUT_ID |
incutId |
ID кампании |
integer |
|
TITLE |
title |
Название кампании |
string |
|
SKU |
sku |
SKU товара |
string |
|
SKU_NAME |
skuName |
Наименование товара |
string |
|
TO_CART |
toCart |
Добавления в корзину, шт. |
integer |
|
ORDERED |
ordered |
Заказанные товары, шт. |
integer |
|
ORDERED_AMOUNT |
orderedAmount |
Стоимость заказанных товаров, ₽ |
number |
| ⚙️ 限制: 每小时100个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/banners-statistics/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType 报告或文档的格式。 |
ReportFormatType
报告格式:
FILE— 电子表格文件（XLSX).CSV— 每个报告表都有一个包含CSV文件的ZIP存档。JSON— 每个报告表都有一个带有JSON文件的ZIP压缩包.
|
Type |
Description |
|
Default: Enum: |
Body
application/json
{
"businessId": 0,
"dateFrom": "string",
"dateTo": "string"
}
|
Name |
Description |
|
businessId* |
Type: integer<int64> 内阁ID。 |
|
dateFrom* |
Type: string<date> 期的开始，包括在内。 |
|
dateTo* |
Type: string<date> 期结束，包括在内。 |
Responses
200 OK
作为响应，您会收到一个标识符，该标识符允许您查找生成状态并下载完成的报告。
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: GenerateReportDTO 跟踪生成状态和接收完成的报告或文档所需的ID。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
GenerateReportDTO
跟踪生成状态和接收完成的报告或文档所需的ID。
|
Name |
Description |
|
estimatedGenerationTime* |
Type: integer<int64> 以毫秒为单位的预期生成时间。 |
|
reportId* |
Type: string 跟踪生成状态和接收完成的报告或文档所需的ID。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiErrorDTO
一般错误格式。
|
Name |
Description |
|
code* |
Type: string 的错误代码。 |
|
message |
Type: string 错误的描述。 |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.