Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

货架报告

Info

Console

方法适用于所有模式.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

promotion — 商品推广
finance-and-accounting — 查看财务信息和报告
all-methods — 全面管理账户

开始在货架上生成摘要报告-带有横幅或视频和一组产品的广告块。阅读更多关于他们的信息在市场对卖家的帮助.

您可以使用请求查找生成状态并获取指向已完成报告的链接。 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: ReportFormatType

报告或文档的格式。

ReportFormatType

报告格式:

FILE -电子表格文件(XLSX).
CSV -ZIP存档与CSV文件的每个报告表。
JSON -ZIP存档与JSON文件的每个报告表。

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

{
    "businessId": 0,
    "dateFrom": "string",
    "dateTo": "string",
    "attributionType": "CLICKS"
}

Name	Description
attributionType*	Type: StatisticsAttributionType Тип атрибуции. Enum: `CLICKS`, `SHOWS`
businessId*	Type: integer<int64> 内阁ID。
dateFrom*	Type: string<date> 期的开始，包括在内。
dateTo*	Type: string<date> 期结束，包括在内。

StatisticsAttributionType

归因类型:

CLICKS -点击。
SHOWS —根据印象。

有关报告中哪些数据取决于和不依赖于归因类型的信息，请阅读在市场对卖家的帮助.

Type	Description
StatisticsAttributionType	Enum: `CLICKS`, `SHOWS`

Responses

200 OK

作为响应，您会收到一个标识符，该标识符允许您查找生成状态并下载完成的报告。

Body

application/json

{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

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: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

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: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

500 Internal Server Error

Yandex中的内部错误。市场。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

这篇文章是否有用？

付款报告

执行报告