You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/菜单栏控制/Version：2020-06-01/更新商品卡片配置
更新商品卡片配置
最近更新时间：2024.09.13 17:07:37首次发布时间：2022.03.29 22:10:12
我的收藏

更新菜单栏下商品卡片的配置信息。

说明

请求说明

  • 接口名称：UpdateActivityProductAPI
  • 请求方式：POST
  • 接口地址：http://livesaas.volcengineapi.com/?Action=UpdateActivityProductAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数

类型

是否必选

描述

Action

String

是

接口名称

Version

String

是

接口版本。直播当前 API 的版本为 2020-06-01

Body

参数

类型

是否必选

描述

ActivityId

Int64

是

直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

Products

Array of Products

是

直播间商品卡片菜单的配置详情

Products

参数

类型

是否必选

描述

-

JSON Map

是

商品卡片菜单的序号和卡片的配置。格式为 "Key":"Value"，其中，

  • "Key" 为商品卡片菜单的序号，可通过 GetActivityMenuAPI 接口获取。例如，商品卡片菜单的序号 Location 为 2，则 "Key" 为 2；
  • "Value" 为商品卡片的配置，配置信息参见 ProductConfig。

ProductConfig

参数

类型

是否必选

描述

EnableFloating

Bool

是

是否开启浮层。支持以下两种取值。

  • true：开启浮层
  • false：关闭浮层

EnableUA

Bool

否

是否开启直达链接功能。该功能仅移动端支持。支持以下两种取值，默认取值为 false。

  • true：开启直达链接
  • false：关闭直达链接

UAAddress

String

否

开启直达链接后匹配的特点环境的 UA。EnableUA 取值为 true 时，本参数必填。

EnableMiniApp

Bool

否

是否开启微信小程序跳转功能。该功能仅移动端支持。支持以下两种取值，默认取值为 false。

  • true：开启跳转
  • false：关闭跳转

MiniAppId

String

否

跳转的微信小程序的原始 ID。EnableMiniApp 取值为 true 时，本参数必填。

ProductsPosition

Int

否

商品卡片在 PC 端观看页的展示位置。支持以下四种取值。

  • 0：右上角
  • 1：左上角
  • 2：左下角
  • 3：右下角

DefaultRedirectImage

String

否

商品卡片默认跳转图的 URL。默认为系统配置的跳转图，支持上传 JPG、GIF、PNG 和 BMP 格式的图片。

DisplayEnable

Int

否

是否显示商品卡片菜单。默认取值为 1。

  • 1：显示
  • 2：不显示

Product

Array of Product

是

商品卡片详情

Product

参数

类型

是否必选

描述

Title

String

是

商品卡片名称

Highlight

String

是

商品卡片高亮文案

IntroduceImage

String

是

商品卡片介绍图的 URL，支持上传 jpg、gif、png、bmp 格式的图片。

RedirectImage

String

是

商品卡片跳转图的 URL，支持上传 jpg、gif、png、bmp 格式的图片。

RedirectUrl

String

是

商品卡片跳转地址的 URL。

Index

Int

是

商品卡片的位置。
取值范围：[0,199]

Id

Int

是

商品卡片 ID

EnableStatus

Int

是

商品卡片是否上架。支持以下两种取值。

  • 0：不上架
  • 1：上架

DirectUrl

String

否

直达链接

Remark

String

否

商品的备注信息

Strikethrough

String

否

商品卡片上的灰色划线文字

MiniAppDirectUrl

String

否

微信小程序的跳转链接

返回参数

参数

类型

描述

Status

Bool

更新菜单操作状态。支持以下两种取值。

  • true：操作成功
  • false：操作失败

示例

请求示例

POST http://livesaas.volcengineapi.com/?Action=UpdateActivityProductAPI&Version=2020-06-01
{
     "ActivityId":732412312,
     "Products":{
         1:{
             "EnableFloating":false,
             "EnableUA":true,
             "UAAddress":"micromessenger",
             "EnableMiniApp":true,
             "MiniAppId":"AppId",
             "ProductsPosition":0, 
             "DefaultRedirectImage":"https://example.com",
             "DisplayEnable": 1,
             "Product":[
                {
                     "Title":"1.2", 
                     "Highlight":"1.2", 
                     "IntroduceImage":"图片地址", 
                     "RedirectImage":"图片地址", 
                     "RedirectUrl":"重定向地址", 
                     "Index":0, 
                     "Id":16014, 
                     "EnableStatus":1,
                     "DirectUrl":"https://xxx",
                     "Remark":"商品备注信息",
                     "Strikethrough":"划线文字",
                     "MiniAppDirectUrl":"https://xxx.com"
                }
            ]
        }
    }
}

正常返回示例

{
      "ResponseMetadata":{
            "RequestId":"201806041104200100100232280022D30",
            "Action":"UpdateActivityProductAPI",
            "Version":"2020-06-01",
            "Service":"livesaas",
            "Region":"cn-north-1",
            "SystemTime":1656067132
      },
      "Result":{
            "Status":true
      }
}

异常返回示例

{
      "ResponseMetadata":{
            "RequestId":"201806041104200100100232280022D30",
            "Action":"UpdateActivityProductAPI",
            "Version":"2020-06-01",
            "Service":"livesaas",
            "Region":"cn-north-1",
            "SystemTime":1656067132,
            "Error":{
                  "Code":"200000",
                  "Message:参数异常"
            }
      }
}

错误码

访问公共错误码获取详细信息。