商店质量指数
方法适用于所有模式.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回存储质量索引及其组件的值。
阅读更多关于质量指数的信息。 在市场对卖家的帮助.
| ⚙️ 限制: 每小时10,000次请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/ratings/quality
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> 内阁ID。 要找到答案,请使用请求 GET v2/campaigns. Min value: |
Body
application/json
{
"dateFrom": "string",
"dateTo": "string",
"campaignIds": [
0
]
}
|
Name |
Description |
|
campaignIds* |
Type: integer[] 广告系列Id列表。 您可以使用查询找到它们。 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 请勿使用商店Id,这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。
Min items: Max items: Unique items |
|
dateFrom |
Type: string<date> 期的开始。 日期格式: 它不能早于当前日期的30天。 |
|
dateTo |
Type: string<date> 期结束。 日期格式: 它不能晚于当前日期。 |
Responses
200 OK
店质量指数及其分量的值。
Body
application/json
{
"status": "OK",
"result": {
"campaignRatings": [
{
"campaignId": 0,
"ratings": [
{
"rating": 0,
"calculationDate": "string",
"components": [
{
"value": 0,
"componentType": "DBS_CANCELLATION_RATE"
}
]
}
]
}
]
}
}
|
Name |
Description |
||
|
status* |
Type: string 响应的类型。 可能的值:
Enum: |
||
|
result |
Type: object
店的质量指标的信息。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.