文档

ListItems - 获取列表项

查询实例物品池。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/openapi/instances/{instanceId}/items/actions/list

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

airec-test
strategyUsedboolean

默认 false,传入 true 则使用置顶/定坑侧逻辑,但是必须在 body 中传入 sceneId

false
withInvalidDetailboolean

置顶/定坑侧控制返回值中是否包含 InvalidDetail�, 用于 itemId:itemType 查询类型使用

false
pageinteger

页数,默认 1

1
sizeinteger

每页数量,默认 10

10

返回参数

名称类型描述示例值
object
resultobject

结果

totalobject

统计

sceneWeightItemlong

场景加权物品数量

10
totalCountlong

全部数量

5000
queryCountlong

列出数量

3000
sceneRecommendItemlong

场景可推荐物品数量

200
weightItemlong

加权物品

10
instanceRecommendItemlong

实例可推荐物品数量

200
detailobject []

详细信息

titlestring

标题

test
categoryPathstring

类目路径

1_2
itemIdstring

itemId,同数据规范同字段

123
itemTypestring

itemType,同数据规范同字段

item
statusstring

是否可推荐

1
brandIdstring

品牌 ID

1
shopIdstring

店铺 ID

1
pubTimestring

发布时间

1647998107012
channelstring

频道

news
durationstring

持续时间

30
authorstring

作者

abc
expireTimestring

过期时间

1647998107012
requestIdstring

当前请求的 RequestID

6839AE7C-A984-48C1-AC17-331BAC6D97BC

示例

正常返回示例

JSON格式

{
  "result": {
    "total": {
      "sceneWeightItem": 10,
      "totalCount": 5000,
      "queryCount": 3000,
      "sceneRecommendItem": 200,
      "weightItem": 10,
      "instanceRecommendItem": 200
    },
    "detail": [
      {
        "title": "test",
        "categoryPath": "1_2",
        "itemId": "123",
        "itemType": "item",
        "status": "1",
        "brandId": "1",
        "shopId": "1",
        "pubTime": "1647998107012",
        "channel": "news",
        "duration": "30",
        "author": "abc",
        "expireTime": "1647998107012"
      }
    ]
  },
  "requestId": "6839AE7C-A984-48C1-AC17-331BAC6D97BC"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-20OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:strategyUsed
    新增入参:withInvalidDetail
  • 本页导读 (0)
文档反馈