调用 ExplainProduct
接口更新指定商品卡片的浮窗展示状态。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ExplainProduct | 接口名称。当前 API 的名称为 ExplainProduct 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 | 17791****71580 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
ExplainStatus | Integer | 是 |
| 讲解状态。支持以下取值。
说明 仅在开启直播时移功能时,该参数才生效。有关如何开启直播时移功能,详见直播时移。 |
FloatingStatus | Integer | 是 |
| 是否浮窗展示商品卡片。取值如下:
说明 仅在不开启直播时移功能时,该参数才生效。 |
ProductId | Long | 是 | 49**46 | 商品卡片 ID。您可调用 GetActivityProducts 接口,通过 Products 参数中的 Id 获取 ID。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Status | Boolean |
| 是否更新成功。取值如下:
|
POST https://livesaas.volcengineapi.com/?Action=ExplainProduct&Version=2023-08-01 { "ActivityId": 17791****71580, "ProductId": 49**46, "ExplainStatus": 1, "FloatingStatus": 1 }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ExplainProduct", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Status": true } }