商店质量指数
方法适用于所有模式.
如果您使用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。 要找到答案,请使用请求 :no-translate[GET v2/campaigns]. Min value: |
Body
application/json
{
"dateFrom": "string",
"dateTo": "string",
"campaignIds": [
0
]
}
Name |
Description |
campaignIds* |
Type: integer<int64>[] 广告系列Id列表。 您可以使用查询找到它们 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
请勿使用商店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: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
result |
Type: CampaignsQualityRatingDTO 店的质量指标的信息。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK
-没有错误。ERROR
-处理请求时发生错误。
Type |
Description |
Enum: |
CampaignsQualityRatingDTO
店的质量指标的信息。
Name |
Description |
campaignRatings* |
Type: CampaignQualityRatingDTO[] 有关其质量指数信息的商店列表。 |
CampaignQualityRatingDTO
店的质量指数的信息。
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店的ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 |
ratings* |
Type: QualityRatingDTO[] 质量指标值的列表。 |
QualityRatingDTO
质量指标的信息。
Name |
Description |
calculationDate* |
Type: string<date> 计算日期。 日期格式: |
components* |
Type: QualityRatingComponentDTO[] 质量指标的组成部分。 |
rating* |
Type: integer<int64> 质量指标的值。 Min value: Max value: |
QualityRatingComponentDTO
质量指标的一个组成部分。
Name |
Description |
componentType* |
Type: QualityRatingComponentType Тип составляющей. Enum: |
value* |
Type: number<double> 成分的百分比的值。 Min value: Max value: |
QualityRatingComponentType
质量指标的组成部分。
对于模型 DBS:
DBS_CANCELLATION_RATE
-取消项目的比例。DBS_LATE_DELIVERY_RATE
-预定日期后交付的订单的百分比。
模型 FBS 还有快车:
FBS_CANCELLATION_RATE
-取消项目的比例。FBS_LATE_SHIP_RATE
-按时发货的订单比例。
对于模型 FBY:
FBY_LATE_DELIVERY_RATE
-迟到仓库的货物百分比。FBY_CANCELLATION_RATE
-取消或未交付项目的百分比。FBY_DELIVERY_DIFF_RATE
-未随交货到达或未被接受的货物的比例。FBY_LATE_EDITING_RATE
-后期从应用程序中删除的产品的百分比。
Type |
Description |
Enum: |
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: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
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.