获取预览结果。

如需使用场景管理功能,不建议使用API进行操作。请使用控制台中“场景管理”功能,使用详情见:通过选投策略配置,快速搭建推荐场景

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /v2/openapi/instances/[instanceId]/scenes/[sceneId]/items HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
instanceId String Path airec-cn-o400whm78004

实例id

sceneId String Path testid

场景id

operationRuleId String Query 1

运营规则id

selectionRuleId String Query 1

选品规则id

page Integer Query 1

指定页码,默认为:1

size Integer Query 10

指定每页展示条数,默认为10,限制:1-50

previewType String Query PREVIEW_ITEM

预览类型:

PREVIEW_ITEM 单独预览选品规则预览结果

PREVIEW_QUERY 预览整体配置结果

queryCount Integer Query 20

查询数量

返回数据

名称 类型 示例值 描述
code String InternalServerError

错误码

message String An internal server error occurred

错误详情

requestId String 8F81A922-6C81-46D6-B78C-CC35E16B1691

请求id

result Struct

返回详情结果

detail Array of Detail

详情

author String zhangsan

作者

brandId String 123

品牌id

categoryPath String 12_34

类目路径

channel String 娱乐

频道

duration String 300

停留时长

expireTime String 1612687809

失效时间

itemId String 123

item_id

itemType String video

item_type

pubTime String 1612687809

发布时间

shopId String 123

店铺id

status String 1

是否可推荐,1为可推荐,0为不可推荐

title String title

标题

total Struct

统计

instanceRecommendItem Long 1000

当前实例可推荐的item数

sceneRecommendItem Long 1000

当前场景下可推荐的item数

sceneWeightItem Long 1000

当前场景加权的item数

totalCount Long 1000

实例中item总数

weightItem Long 1000

实例中加权的item数

示例

请求示例

GET openapi/instances/{instanceId}/scenes/{sceneId}/items?selectionRuleId=xxx&operrationRuleId=xxx

正常返回示例

XML格式

<Result>
    <Total>
        <InstanceRecommendItem>200</InstanceRecommendItem>
        <SceneRecommendItem>50</SceneRecommendItem>
        <WeightItem>10</WeightItem>
        <SceneWeightItem>2217</SceneWeightItem>
        <TotalCount>5000</TotalCount>
    </Total>
    <Detail>
        <ItemId>15755228600501_15755228759463</ItemId>
        <ItemType>item</ItemType>
        <ExpireTime/>
        <CategoryPath>1024_10003</CategoryPath>
        <PubTime>1575523106</PubTime>
        <BrandId>15692083252170</BrandId>
        <Weight>1</Weight>
        <ShopId/>
        <Title>澜笛若慕洁面乳</Title>
        <Status>1</Status>
        <Duration>123123</Duration>
        <Author>123123</Author>
        <Channel>123123</Channel>
    </Detail>
</Result>
<RequestId>6839AE7C-A984-48C1-AC17-331BAC6D97BC</RequestId>

JSON格式

{
	"Result": {
		"Total": {
			"InstanceRecommendItem": "200",
			"SceneRecommendItem": "50",
			"WeightItem": "10",
			"SceneWeightItem": "2217",
			"TotalCount": "5000"
		},
		"Detail": [{
			"ItemId": "15755228600501_15755228759463",
			"ItemType": "item",
			"ExpireTime": null,
			"CategoryPath": "1024_10003",
			"PubTime": "1575523106",
			"BrandId": "15692083252170",
			"Weight": "1",
			"ShopId": null,
			"Title": "澜笛若慕洁面乳",
			"Status": "1",
			"Duration": "123123",
			"Author": "123123",
			"Channel": "123123"
		}]
	},
	"RequestId": "6839AE7C-A984-48C1-AC17-331BAC6D97BC"
}

错误码

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