Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
竞争地位报告
方法适用于所有模式.
如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一
开始生成指定期间的"竞争位置"报告。 这是什么报告
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.
报表中的-1值
如果在列中的CSV文件 POSITION 它是-1，当天没有指定类别的物品的订单。
报告列说明：
表单Конкурентная позиция（文件competitors_position）
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
DAY |
day |
День |
string |
|
SELLERS_COUNT |
sellersCount |
Продавцов в категории |
integer |
|
POSITION |
position |
Ваша позиция |
integer |
|
TOTAL_GMV |
totalGmv |
Общий оборот в категории, ₽ |
number |
|
GMV |
gmv |
Ваш оборот в категории, ₽ |
number |
|
AVG_TOTAL_GMV |
avgTotalGmv |
Средний оборот в категории, ₽ |
number |
|
SHARE |
share |
Ваша доля, % |
number |
|
AVG_GMV_OF_TOP_FIVE_PERCENT_SELLERS |
avgGmvOfTopFivePercentSellers |
Средний оборот 5% лидеров, ₽ |
number |
|
NEAREST_COMPETITOR_GMV |
nearestCompetitorGmv |
Оборот ближайшего конкурента, ₽ |
number |
| **⚙️ 限制：**每小时10个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/competitors-position/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType 报告或文档的格式。 |
ReportFormatType
报告格式:
FILE-电子表格文件(XLSX).CSV-ZIP存档与CSV文件的每个报告表。JSON-ZIP存档与JSON文件的每个报告表。
|
Type |
Description |
|
Default: Enum: |
Body
application/json
{
"businessId": 0,
"categoryId": 0,
"dateFrom": "string",
"dateTo": "string"
}
|
Name |
Description |
|
businessId* |
Type: integer<int64> 内阁ID。 |
|
categoryId* |
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
Yandex的内部错误。 市场。 有关错误的更多信息
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.