报告的结构及内容如有更改，恕不另行通知。

例如，可以添加新列或更改工作表的名称。

销售促进报告

Info

Console

方法适用于所有模式.

目前不适用于卖家Market Yandex Go.

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

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

开始生成关于指定期间的销售增长的摘要报告。什么是销售提升？

该报告包含通过API和仪表板创建的所有活动的信息。

您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.

报告列说明：

表单Сводный отчет（文件business_boost_consolidated）

CSV中的列名	JSON中的列名	XLSX中的列名	值类型
SHOP_SKU	shopSku	Ваш SKU	string
OFFER_NAME	offerName	Название товара	string
SHOWS_WITH_FEE	showsWithFee	Показы товара с бустом, шт.	integer
SHOWS	shows	Все показы товара, шт.	integer
CLICKS_VENDOR_WITH_FEE	clicksVendorWithFee	Клики по товару с бустом, шт.	integer
CLICKS_VENDOR	clicksVendor	Все клики по товару, шт.	integer
CLICKS_CPA_WITH_FEE	clicksCpaWithFee	Добавления в корзину товаров с бустом, шт.	integer
CLICKS_CPA	clicksCpa	Все добавления товаров в корзину, шт.	integer
ORDER_ITEMS_WITH_FEE	orderItemsWithFee	Заказанные товары с бустом, шт.	integer
ORDER_ITEMS	orderItems	Все заказанные товары, шт.	integer
ORDER_ITEMS_DELIVERED_WITH_FEE	orderItemsDeliveredWithFee	Доставленные товары с бустом, шт.	integer
ORDER_ITEMS_DELIVERED	orderItemsDelivered	Всего доставлено товаров, шт.	integer
DEDUCTED_BONUSES	deductedBonuses	Списано бонусов	number
COST_REVENUE_RATIO	costRevenueRatio	Доля расходов на буст от выручки с бустом, %	number
REVENUE_SHARE	revenueShare	Доля выручки с бустом от всей выручки, %	number
SALES_CAMPAIGN_IDS	salesCampaignIds	ID кампаний	string
SALES_CAMPAIGN_NAMES	salesCampaignNames	Названия кампаний	string
BILLED_AMOUNT	billedAmount	Расходы на буст,.*	number
AVERAGE_BOOST_COST	averageBoostCost	Средняя стоимость буста,.*	number
ORDERS_GVM_DELIVERED_WITH_FEE	ordersGvmDeliveredWithFee	Выручка с бустом,.*	number
ORDERS_GVM_DELIVERED	ordersGvmDelivered	Вся выручка,.*	number

⚙️ 限制: 每小时100个请求

Request

POST

https://api.partner.market.yandex.ru/v2/reports/boost-consolidated/generate

Query parameters

Name

Description

format

Type: ReportFormatType

报告或文档的格式。

ReportFormatType

报告格式:

FILE — 电子表格文件（XLSX).
CSV — 每个报告表都有一个包含CSV文件的ZIP存档。
JSON — 每个报告表都有一个带有JSON文件的ZIP压缩包.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

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

响应的类型。可能的值:

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

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

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

这篇文章是否有用？

印象提升报告

销售地理报告