All Products
Search
Document Center

:ListSceneItems

Last Updated:Mar 01, 2024

Queries preview results.

Operation description

We recommend that you do not call an API operation to manage scenes. We recommend that you go to the Scenario Building page in the Artificial Intelligence Recommendation (AIRec) console to manage scenes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

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

airec-cn-o400whm78004
sceneIdstringYes
testid
operationRuleIdstringNo
1
selectionRuleIdstringNo

The instance ID.

1
pageintegerNo

The scene ID.

1
sizeintegerNo

The ID of the operation rule.

10
previewTypestringNo

The ID of the item selection rule.

PREVIEW_ITEM
queryCountintegerNo

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

20

Response parameters

ParameterTypeDescriptionExample
object
resultobject

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

totalobject

The preview type. Valid values:

PREVIEW_ITEM: previews only the results that are returned based on item selection rules.

PREVIEW_QUERY: previews the results that are returned based on all configurations.

totalCountlong

The number of queries.

1000
sceneWeightItemlong

The returned results.

1000
sceneRecommendItemlong

The statistical results.

1000
weightItemlong

The total number of items in the instance.

1000
instanceRecommendItemlong

The number of weighted items in the scene.

1000
detailobject []

The number of items that can be recommended in the scene.

titlestring

The number of weighted items in the instance.

title
categoryPathstring

The number of items that can be recommended in the instance.

12_34
itemIdstring

The information about the preview results.

123
itemTypestring

The title of the item.

video
statusstring

The category path of the item.

1
brandIdstring

The item ID.

123
shopIdstring

The type of the item.

123
pubTimestring

Indicates whether the item can be recommended. Valid values: 1: The item can be recommended. 0: The item cannot be recommended.

1612687809
channelstring

The brand ID.

The store ID.
durationstring

The time when the item was published.

300
authorstring

The channel of the item.

zhangsan
expireTimestring

Entertainment

1612687809
codestring

The time spent on the page.

InternalServerError
requestIdstring

The author of the item.

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

The time when the item expires.

An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": {
    "total": {
      "totalCount": 1000,
      "sceneWeightItem": 1000,
      "sceneRecommendItem": 1000,
      "weightItem": 1000,
      "instanceRecommendItem": 1000
    },
    "detail": [
      {
        "title": "title",
        "categoryPath": "12_34",
        "itemId": "123",
        "itemType": "video",
        "status": "1",
        "brandId": "123",
        "shopId": "123",
        "pubTime": "1612687809",
        "channel": "The store ID.\n",
        "duration": "300",
        "author": "zhangsan",
        "expireTime": "1612687809"
      }
    ]
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history