All Products
Search
Document Center

ListSceneItems

Last Updated: Mar 29, 2021

If you need to use the scene management feature, you can log on to the AIRec console to use this feature. For more information, see Create a recommendation scene by configuring item selection rules. We recommend that you do not call API operations to use the scene management feature.

Description

Queries preview results.

Method

GET

URI

openapi/instances/{instanceId}/scenes/{sceneId}/items

Request parameters

Parameter

Type

Required

Description

instanceId

String

Yes

The ID of the instance.

sceneId

String

Yes

The ID of the scene.

previewType

String

Yes

The preview type. Valid values: PREVIEW_ITEM and PREVIEW_QUERY. If you set this parameter to PREVIEW_ITEM, you can preview only the results that are returned based on item selection rules. If you set this parameter to PREVIEW_QUERY, you can preview all configuration results.

queryCount

Integer

No

The number of queries.

selectionRuleId

String

No

The ID of the item selection rule.

operationRuleId

String

No

The ID of the operations rule.

page

Integer

No

The number of the page to return. Default value: 1.

size

Integer

No

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

Response parameters

Parameter

Type

Description

RequestId

String

The ID of the request.

Result

Map

The result that is returned.

Examples

Sample requests

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

Sample responses

{
    "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", // (Exclusive for e-commerce)
           "Weight": "1",
           "ShopId": null,  // (Exclusive for e-commerce)
           "Title": "Andorheal cleanser",
           "Status": "1",
           "Duration": "123123" ,// (Exclusive for content and news)
           "Author": "123123", // (Exclusive for content and news)
           "Channel": "123123", // (Exclusive for content and news)
          }
    ]

    },
    "RequestId":"6839AE7C-A984-48C1-AC17-331BAC6D97BC"
}