文档中心

更新商品卡片配置

最近更新时间：2023.11.08 09:30:21

首次发布时间：2023.09.22 10:49:48

更新直播间商品卡片菜单的配置信息。

通过本接口的 Product 参数，您可以新增、更新和删除卡片。

新增卡片：在请求参数中不传 Id 参数或传入 Id 参数且取值为 0 ，即可新增卡片。
更新卡片：在请求参数中传入待更新卡片的 ID 作为 Id 参数值并按需更新卡片的配置信息，即可更新该卡片。为保证卡片配置信息的参数值不被清空或替换为默认值，即便参数在该接口中为非必选，只要您有自定义的需求，就必须传入对应的参数值。
说明
仅可以更新当前菜单中已有的卡片。
删除卡片：在请求参数中不传已有卡片的 ID，即可删除该卡片。

说明

为避免当前菜单中已有卡片被误删或卡片的配置信息被清空或替换为默认值，您必须将不需要删除和更新的卡片 ID 及其配置信息作为请求参数传入该接口。您可以调用 GetActivityProducts 接口，通过返回参数 Product 获取当前菜单中的所有卡片信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateActivityProduct&Version=2023-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateActivityProduct`	接口名称。当前 API 的名称为 `UpdateActivityProduct`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1776085489138`	直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
ProductConfig	Object of ProductConfig	否		商品卡片菜单的配置信息列表。说明最多支持配置 5 个商品卡片菜单。
VerticalIconUrl	String	否	`https//p.byted.org/6ed59yyum2-z75.png`	竖屏直播中商品卡片菜单图标的 URL，需要包含协议头。支持上传大小不超过 2 MB 的 PNG 格式的图片。建议尺寸 100*100px。

ProductConfig

参数	类型	是否必选	示例值	描述
Id	Long	否	`780`	商品卡片菜单 ID。您可以通过调用 GetActivityProducts 接口查询 ID。说明不传该参数或取值为 `0` 时，表示新增商品卡片菜单。
EnableFloating	Boolean	否	`true`	是否开启浮层展示。支持以下取值，默认取值为 `false`。 `true`：是 `false`：否
EnableUA	Boolean	否	`false`	是否开启直达链接。支持以下取值，默认取值为 `false`。 `true`：开启 `false`：关闭说明仅当商品卡片菜单是启用状态时，该配置才生效。
UAInfo	Object of UAInfo	否		直达链接的配置信息列表。说明当 `EnableUA` 取值为 `true` 时，该参数必填。
EnableMiniApp	Boolean	否	`false`	是否开启微信小程序跳转功能。支持以下取值，默认取值为 `false`。 `true`：开启 `false`：关闭说明仅当商品卡片菜单是启用状态时，该配置才生效。
MiniAppId	String	否	`dsdwsd`	跳转的微信小程序的原始 ID。说明当 `EnableMiniApp` 取值为 `true` 时，该参数必填。
ProductsPosition	Integer	否	`0`	商品卡片在 PC 端观看页的展示位置。支持以下取值，默认取值为 `0`。 `0`：右上角 `1`：左上角 `2`：左下角 `3`：右下角
DefaultRedirectImage	String	否	`https://example/MenuBar`	商品卡片默认跳转图的 URL。默认为系统配置的跳转图，支持上传 JPG、GIF、PNG 和 BMP 格式的图片。
DisplayEnable	Integer	否	`1`	是否在观看页显示商品卡片菜单。支持以下取值，默认取值为 `1`。 `1`：显示 `2`：不显示说明仅当商品卡片菜单是启用状态时，该配置才生效。
MenuName	String	是	`商品卡片`	商品卡片菜单的名称。最多支持输入 20 个字符。
Product	Object of Product	是		卡片的配置信息列表。

UAInfo

参数	类型	是否必选	示例值	描述
UAInfos	Array of UAInfos	是		直达链接的配置信息列表。说明最多支持配置 5 个直达链接。

Product

参数	类型	是否必选	示例值	描述
Products	Array of Products	是		卡片的配置信息列表。

UAInfos

参数	类型	是否必选	示例值	描述
UAName	String	是	`微信`	环境名称，与 `UAAddress` 一一对应。说明环境名称不可重复。
UAAddress	String	是	`MicroMessenger`	环境 UA，与 `UAName` 一一对应。

Products

参数	类型	是否必选	示例值	描述
Id	Long	否	`105472`	卡片 ID。您可以通过调用 GetActivityProducts 接口查询 ID。说明不传该参数或取值为 `0` 时，表示新增卡片。
Title	String	是	`卡片标题`	卡片标题。
Highlight	String	否	`卡片高亮文案`	卡片的高亮文案。
IntroduceImage	String	否	`https://example.com`	卡片介绍图的 URL。支持上传 jpg、gif、png、bmp 格式的图片。
RedirectImage	String	否	`https://example.com`	卡片跳转图的 URL。支持上传 jpg、gif、png、bmp 格式的图片。
RedirectUrl	String	否	`https://example.com`	卡片的跳转链接。
Index	Integer	否	`0`	卡片的序号。取值范围：[0,499]。说明卡片序号必须从 `0` 开始，并且必须依次递增。
EnableStatus	Integer	否	`1`	是否上架卡片。支持以下取值，默认取值为 `0`。 `0`：否 `1`：是说明仅当商品卡片菜单是启用状态时，该配置才生效。
Remark	String	否	`备注信息`	卡片的备注信息。
Strikethrough	String	否	`划线文字`	卡片上的灰色划线文字。
MiniAppDirectUrl	String	否	`https://example.com`	微信小程序的跳转链接。
DirectUrls	Array of String	否	`["https://example.com","https://example2.com" ]`	卡片的直达链接列表。说明请按照所配的环境名称和环境 UA （即参数 `UAInfo`）的顺序，配置对应的直达链接。最多支持配置 5 个直达链接。

返回参数

参数	类型	示例值	描述
ProductConfig	Object of ProductConfigResponse		商品卡片菜单的配置信息列表。
VerticalIconUrl	String	`https://p.byted.org/6ed59yyum2-z75.png`	竖屏直播中商品卡片菜单图标的 URL。

ProductConfigResponse

参数	类型	示例值	描述
Id	Long	`780`	商品卡片菜单 ID。
EnableFloating	Boolean	`true`	是否开启浮层展示。支持以下取值： `true`：是 `false`：否
EnableUA	Boolean	`true`	是否开启直达链接功能。支持以下取值： `true`：是 `false`：否
EnableMiniApp	Boolean	`true`	是否开启微信小程序跳转功能。支持以下取值： `true`：是 `false`：否
MiniAppId	String	`dsdwsd`	跳转的微信小程序的原始 ID。说明当 `EnableMiniApp` 取值为 `true` 时，返回原始 ID，否则为空。
ProductsPosition	Integer	`0`	商品卡片在 PC 端观看页的展示位置。支持以下取值： `0`：右上角 `1`：左上角 `2`：左下角 `3`：右下角
DefaultRedirectImage	String	`https://example/MenuBar`	商品卡片默认跳转图的 URL。默认为系统配置的跳转图，支持上传 JPG、GIF、PNG 和 BMP 格式的图片。
DisplayEnable	Integer	`1`	是否在观看页显示商品卡片菜单。支持以下取值： `1`：是 `2`：否
UAInfo	Object of UAInfoResponse		直达链接的配置信息列表。说明当 `EnableUA` 取值为 `true` 时，返回该配置信息，否则为空。
MenuName	String	`商品卡片`	商品卡片菜单的名称。
Product	Object of ProductResponse		卡片的配置信息。

UAInfoResponse

参数	类型	示例值	描述
UAInfos	Array of UAInfosResponse		直达链接的配置信息列表。

ProductResponse

参数	类型	示例值	描述
Products	Array of ProductsResponse		卡片的配置信息列表。

UAInfosResponse

参数	类型	示例值	描述
UAName	String	`微信`	环境名称。
UAAddress	String	`MicroMessenger`	环境 UA。

ProductsResponse

参数	类型	示例值	描述
Title	String	`卡片标题`	卡片标题。
Highlight	String	`卡片高亮文案`	卡片的高亮文案。
IntroduceImage	String	`https://example.com`	卡片介绍图的 URL。支持上传 jpg、gif、png、bmp 格式的图片。
RedirectImage	String	`https://example.com`	卡片跳转图的 URL。支持上传 jpg、gif、png、bmp 格式的图片。
RedirectUrl	String	`https://example.com`	卡片的跳转链接。
Index	Integer	`0`	卡片的序号。取值范围：[0,499]。
Id	Long	`105472`	卡片 ID。
EnableStatus	Integer	`1`	是否上架卡片。支持以下取值： `0`：否 `1`：是
Remark	String	`备注信息`	卡片的备注信息。
Strikethrough	String	`划线文字`	卡片上的灰色划线文字。
MiniAppDirectUrl	String	`https://example.com`	微信小程序的跳转链接。
DirectUrls	Array of String	`["https://example.com","https://example2.com" ]`	卡片的直达链接列表。
PageAdvertisementType	Integer	`4`	已废弃
ExplainStatus	Integer	`0`	商品讲解状态。支持以下取值： `0`：未讲解 `1`：讲解中 `2`：讲解结束
ExplainTime	Long	`0`	最近一次修改商品讲解状态的时间。Unix 时间戳，单位为秒。取值为 `0` 表示未修改过商品讲解状态。
FloatingStatus	Integer	`1`	是否浮窗展示商品卡片。支持以下取值： `1`：开启浮窗 `其他值`：关闭浮窗

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityProduct&Version=2023-08-01
{
  "ActivityId": 1776085489138,
  "VerticalIconUrl": "https//p.byted.org/6ed59yyum2-z75.png",
  "ProductConfig": {
    "MenuName": "商品卡片",
    "Product": {
      "Products": [
        {
          "Title": "卡片标题",
          "Index": 0,
          "RedirectUrl": "https://example.com",
          "Remark": "备注信息",
          "Strikethrough": "划线文字",
          "Id": 105472,
          "EnableStatus": 1,
          "MiniAppDirectUrl": "https://example.com",
          "Highlight": "卡片高亮文案",
          "IntroduceImage": "https://example.com",
          "RedirectImage": "https://example.com",
          "DirectUrls": [
            "https://example.com",
            "https://example2.com"
          ]
        }
      ]
    },
    "Id": 780,
    "EnableFloating": true,
    "ProductsPosition": 0,
    "EnableUA": true,
    "EnableMiniApp": true,
    "DisplayEnable": 1,
    "MiniAppId": "dsdwsd",
    "DefaultRedirectImage": "https://example/MenuBar",
    "UAInfo": {
      "UAInfos": [
        {
          "UAName": "微信",
          "UAAddress": "MicroMessenger"
        }
      ]
    }
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "UpdateActivityProduct",
    "Version": "2023-08-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "ProductConfig": {
      "MenuName": "商品卡片",
      "Product": {
        "Products": [
          {
            "DirectUrls": [
              "https://example.com",
              "https://example2.com"
            ],
            "ExplainTime": 0,
            "RedirectImage": "https://example.com",
            "Highlight": "卡片高亮文案",
            "Id": 105472,
            "ExplainStatus": 0,
            "FloatingStatus": 1,
            "PageAdvertisementType": 4,
            "RedirectUrl": "https://example.com",
            "Strikethrough": "划线文字",
            "Remark": "备注信息",
            "Index": 0,
            "IntroduceImage": "https://example.com",
            "Title": "卡片标题",
            "EnableStatus": 1,
            "MiniAppDirectUrl": "https://example.com"
          }
        ]
      },
      "DefaultRedirectImage": "https://example/MenuBar",
      "EnableMiniApp": true,
      "UAInfo": {
        "UAInfos": [
          {
            "UAName": "微信",
            "UAAddress": "MicroMessenger"
          }
        ]
      },
      "EnableFloating": true,
      "EnableUA": true,
      "DisplayEnable": 1,
      "Id": 780,
      "MiniAppId": "dsdwsd",
      "ProductsPosition": 0
    },
    "VerticalIconUrl": "https://p.byted.org/6ed59yyum2-z75.png"
  }
}

错误码

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

企业直播