新增或更新商品卡片菜单配置信息--企业直播-火山引擎

文档中心

立即注册

导航

新增或更新商品卡片菜单配置信息

最近更新时间：2025.01.03 10:57:39首次发布时间：2023.09.22 10:49:48

调用 UpdateActivityProduct 接口，新增商品卡片菜单，或更新已有商品卡片菜单的菜单名称、商品卡片等信息。

说明

启用商品卡片菜单后，配置信息才会在观看页生效。您可通过调用 ModifyActivityMenus 接口，启用商品卡片菜单。

使用说明

接口行为

通过本接口的 ProductConfig 参数，您可以新增和更新商品卡片菜单。
- 新增商品卡片菜单：在请求参数中不传 Id（商品卡片菜单 ID）或传入 Id 且参数取值为 0 ，即可新增商品卡片菜单。
- 更新商品卡片菜单信息：在请求参数中传入待更新信息的商品卡片菜单的 ID 作为 Id 参数值，即可更新该菜单。您可通过调用 GetActivityProducts 接口获取 ID。
通过本接口的 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	是	`1776****89138`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
ProductConfig	Object of ProductConfig	否	`-`	商品卡片菜单的配置信息。说明最多支持配置 5 个商品卡片菜单。
VerticalIconUrl	String	否	`https://p.example.org/***.png`	移动端观看页的购物车图标 URL，需包含协议头。不传该参数，则为默认图标。支持上传大小不超过 2 MB 的 PNG 格式的图片。建议尺寸为 100*100 px。

ProductConfig

参数	类型	是否必选	示例值	描述
Id	Long	否	`780`	商品卡片菜单的 ID。新增商品卡片菜单：不传该参数或传入该参数且取值为 `0`。更新商品卡片菜单信息：传入待更新信息的商品卡片菜单 ID。您可通过调用 GetActivityProducts 接口获取 ID。
MenuName	String	否	`商品卡片`	商品卡片菜单的名称。长度为 1 到 20 个字符。说明新增商品卡片菜单时，该参数必传。
EnableUA	Boolean	否	`false`	是否开启直达链接功能。该功能仅移动端支持。默认值为 `false`。取值如下： `true`：开启 `false`：关闭
UAInfo	Object of UAInfo	否	`-`	直达链接的配置信息。说明当 `EnableUA` 取值为 `true` 时，该参数必选。
EnableMiniApp	Boolean	否	`false`	是否开启微信小程序跳转功能。该功能仅移动端支持。默认值为 `false`。取值如下： `true`：开启 `false`：关闭
MiniAppId	String	否	`dsdwsd`	跳转的微信小程序的原始 ID。有关如何获取微信小程序的原始 ID，详见商品卡片常见问题。说明当 `EnableMiniApp` 取值为 `true` 时，该参数必选。
DisplayEnable	Integer	否	`1`	商品卡片在观看页的入口。默认值为 `1`。取值如下： `1`：观看页支持展示商品卡片菜单和浮窗商品卡片。移动端观看页可同步展示购物车图标说明移动端竖屏直播间仅支持展示购物车图标和浮窗商品卡片。如需在移动端横屏直播间展示购物车图标，请确保已启用聊天互动菜单。您可调用 ModifyActivityMenus 接口，启用聊天互动菜单。 `2`：观看页仅支持展示浮窗商品卡片
ProductsPosition	Integer	否	`0`	浮窗商品卡片在 PC 端观看页的展示位置。默认值为 `0`。取值如下： `0`：播放器右上角 `1`：播放器左上角 `2`：播放器左下角 `3`：播放器右下角
EnableFloating	Boolean	否	`true`	是否开启浮层展示。默认值为 `false`。取值如下： `true`：开启。观众在移动端点击商品卡片后，在当前观看页以浮层形式展示商品详情页。观众可以在观看直播的同时查看商品详情页，实现边看边买 `false`：关闭。观众点击商品卡片后，页面自动跳转至新的浏览器标签页展示商品详情页。观众无法同时观看直播与商品详情页
DefaultRedirectImage	String	否	`https://p.example.org/***.png`	商品卡片默认跳转图的 URL，需包含协议头。不传该参数，则为系统默认的跳转图。支持上传 JPG、GIF、PNG 和 BMP 格式的图片。上传的默认跳转图作用于当前商品卡片菜单中所有已添加和待添加的商品卡片。
Product	Object of Product	是	`-`	商品卡片的配置信息。

UAInfo

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

Product

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

UAInfos

参数	类型	是否必选	示例值	描述
UAName	String	是	`微信`	环境名称，与 `UAAddress` 一一对应。长度为 1 到 10 个字符。说明环境名称不可重复。
UAAddress	String	是	`MicroMessenger`	环境 UA，与 `UAName` 一一对应。长度为 1 到 500 个字符。

Products

参数	类型	是否必选	示例值	描述
Id	Long	否	`105472`	商品卡片的 ID。您可通过调用 GetActivityProducts 接口获取 ID。新增卡片：不传该参数或传入该参数且取值为 `0`。更新卡片：传入待更新的卡片 ID。删除卡片：不传已有卡片的 ID。说明为避免当前商品卡片菜单中已有卡片被误删或卡片的配置信息被清空或替换为默认值，您必须将不需要删除和更新的卡片 ID 及其配置信息作为请求参数传入该接口。您可调用 GetActivityProducts 接口，通过返回参数 `Product` 获取当前菜单中的所有卡片信息。
Index	Integer	否	`0`	商品卡片的序号。该参数取值为从 `0` 开始的连续且不重复的整数，如 `0`、`1`、`2`。取值范围为 [0,499]。
IntroduceImage	String	否	`https://p.example.org/***.png`	商品图的 URL，需包含协议头。支持上传 JPG、GIF、PNG、BMP 格式的图片。
PromotionTagType	Integer	否	`1`	活动标签类型。默认值为 `0`。取值如下： `0`：无 `1`：自定义 `2`：超值购 `3`：惊喜特惠 `4`：低价秒杀
PromotionTagUrl	String	否	`https://p.example.org/***.png`	活动标签的 URL，需包含协议头。说明当 `PromotionTagType` 取值为 `1` 时，该参数必选。
Title	String	是	`玫瑰慕斯蛋糕（小）`	商品名称。长度为 1 到 40 个字符。
Remark	String	否	`超级好吃的玫瑰慕斯蛋糕`	商品介绍。长度为 1 到 15 个字符。
Highlight	String	否	`¥15`	商品的售卖价，即当前价格。长度为 1 到 20 个字符。
Strikethrough	String	否	`¥30`	商品的参考价，即原价。长度为 1 到 8 个字符。
SellingPointTag	String	否	`买二赠一；满50减20`	卖点标签。最多支持 3 个卖点，卖点间以分号（；）相隔。每个卖点建议不要超过 6 个字符。
RedirectImage	String	否	`https://p.example.org/***.png`	跳转图的 URL，需包含协议头。不传该参数，则为系统默认的跳转图。支持上传 JPG、GIF、PNG、BMP 格式的图片。
DirectUrls	Array of String	否	`["https://example.com","https://example2.com" ]`	直达链接，需包含协议头。当观众在环境 UA 匹配成功的移动端平台上点击商品卡片时，即可跳转至该链接。说明请按照所配置的环境名称和环境 UA （即参数 `UAInfo`）的顺序，配置对应的直达链接。最多支持配置 5 个直达链接。
MiniAppDirectUrl	String	否	`https://example.com`	微信小程序链接，需包含协议头。当观众在移动端微信环境点击商品卡片时，即可跳转至该微信小程序。
RedirectUrl	String	否	`https://example.com`	跳转链接，即商品详情页的链接，需包含协议头。如果观众无法跳转至直达链接或微信小程序，则会跳转至该链接。
ReminderType	Integer	否	`1`	在商品讲解期间的浮窗商品卡片和商品卡片菜单中，动效展示的提醒类型。默认值为 `0`。取值如下： `0`：无 `1`：热卖 `2`：库存当参数取值为 `1` 或 `2` 时，为确保观看页能够展示热卖或库存提醒，必须同时满足以下条件：调用 ModifyActivityMenus 接口，启用商品卡片菜单。将当前接口的 `EnableStatus` 参数值设置为 `1`，上架商品卡片。调用 ExplainProduct 接口，将 `ExplainStatus` 或 `FloatingStatus` 的参数值设置为 `1`，对商品卡片标记商品讲解。
HotSale	String	否	`1000`	热卖提醒数量。长度为 1 到 5 个字符。说明当 `ReminderType` 取值为 `1` 时，该参数必选。
Stock	String	否	`50`	库存提醒数量。长度为 1 到 2 个字符。说明当 `ReminderType` 取值为 `2` 时，该参数必选。
EnableStatus	Integer	否	`1`	是否上架商品。默认值为 `0`。取值如下： `0`：下架 `1`：上架
IsOrderMsgEnable	Integer	否	`1`	是否开启下单消息。默认值为 `0`。取值如下： `0`：关闭 `1`：开启。您需调用 UpdateActivityCommentConfig 接口，同步开启聊天互动菜单的查看商品消息或下单购买消息，从而在聊天区域展示查看商品消息或下单购买消息。

返回参数

参数	类型	示例值	描述
ProductConfig	Object of ProductConfig	`-`	商品卡片菜单的配置信息。
VerticalIconUrl	String	`https://p.example.org/***.png`	移动端观看页的购物车图标 URL，包含协议头。

ProductConfig

参数	类型	示例值	描述
Id	Long	`780`	商品卡片菜单的 ID。
MenuName	String	`商品卡片`	商品卡片菜单的名称。
EnableUA	Boolean	`true`	是否开启直达链接功能。该功能仅移动端支持。取值如下： `true`：开启 `false`：关闭
UAInfo	Object of UAInfo	`-`	直达链接的配置信息。说明该参数仅在 `EnableUA` 取值为 `true` 时生效。
EnableMiniApp	Boolean	`true`	是否开启微信小程序跳转功能。该功能仅移动端支持。取值如下： `true`：开启 `false`：关闭
MiniAppId	String	`dsdwsd`	跳转的微信小程序的原始 ID。说明该参数仅在 `EnableMiniApp` 取值为 `true` 时生效。
DisplayEnable	Integer	`1`	商品卡片在观看页的入口。取值如下： `1`：观看页支持展示商品卡片菜单和浮窗商品卡片。移动端观看页可同步展示购物车图标说明移动端竖屏直播间仅支持展示购物车图标和浮窗商品卡片。仅在启用聊天互动菜单后，移动端横屏直播间才会展示购物车图标。 `2`：观看页仅支持展示浮窗商品卡片
ProductsPosition	Integer	`0`	浮窗商品卡片在 PC 端观看页的展示位置。取值如下： `0`：播放器右上角 `1`：播放器左上角 `2`：播放器左下角 `3`：播放器右下角
EnableFloating	Boolean	`true`	是否开启浮层展示。取值如下： `true`：开启。观众在移动端点击商品卡片后，在当前观看页以浮层形式展示商品详情页。观众可以在观看直播的同时查看商品详情页，实现边看边买 `false`：关闭。观众点击商品卡片后，页面自动跳转至新的浏览器标签页展示商品详情页。观众无法同时观看直播与商品详情页
DefaultRedirectImage	String	`https://example/MenuBar`	商品卡片默认跳转图的 URL，包含协议头。
Product	Object of Product	`-`	商品卡片的配置信息。

UAInfo

参数	类型	示例值	描述
UAInfos	Array of UAInfos	`-`	直达链接的配置信息。说明该参数仅在 `EnableUA` 取值为 `true` 时生效。

Product

参数	类型	示例值	描述
Products	Array of Products	`-`	商品卡片的配置信息。

UAInfos

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

Products

参数	类型	示例值	描述
Id	Long	`105472`	商品卡片的 ID。
Index	Integer	`0`	商品卡片的序号。取值范围为 [0,499]。
IntroduceImage	String	`https://p.example.org/***.png`	商品图的 URL，包含协议头。
PromotionTagType	Integer	`1`	活动标签类型。取值如下： `0`：无 `1`：自定义 `2`：超值购 `3`：惊喜特惠 `4`：低价秒杀
PromotionTagUrl	String	`https://p.example.org/***.png`	活动标签的 URL，包含协议头。
Title	String	`玫瑰慕斯蛋糕（小）`	商品名称。
Remark	String	`超级好吃的玫瑰慕斯蛋糕`	商品介绍。
Highlight	String	`¥15`	商品的售卖价，即当前价格。
Strikethrough	String	`¥30`	商品的参考价，即原价。
SellingPointTag	String	`买二赠一；满50减20`	卖点标签。卖点间以分号（；）相隔。
RedirectImage	String	`https://p.example.org/***.png`	跳转图的 URL，包含协议头。
DirectUrls	Array of String	`["https://example.com","https://example2.com" ]`	直达链接，包含协议头。当观众在环境 UA 匹配成功的移动端平台上点击商品卡片时，即可跳转至该链接。说明该参数仅在 `EnableUA` 取值为 `true` 时生效。
MiniAppDirectUrl	String	`https://example.com`	微信小程序链接，包含协议头。当观众在移动端微信环境点击商品卡片时，即可跳转至该微信小程序。说明该参数仅在 `EnableMiniApp` 取值为 `true` 时生效。
RedirectUrl	String	`https://example.com`	跳转链接，即商品详情页的链接，包含协议头。如果观众无法跳转至直达链接或微信小程序，则会跳转至该链接。
ReminderType	Integer	`1`	在商品讲解期间的浮窗商品卡片和商品卡片菜单中，动效展示的提醒类型。取值如下： `0`：无 `1`：热卖 `2`：库存
HotSale	String	`1000`	热卖提醒数量。说明该参数仅在 `ReminderType` 取值为 `1` 时生效。
Stock	String	`50`	库存提醒数量。说明该参数仅在 `ReminderType` 取值为 `2` 时生效。
EnableStatus	Integer	`1`	是否上架商品。取值如下： `0`：下架 `1`：上架
IsOrderMsgEnable	Integer	`1`	是否开启下单消息。取值如下： `0`：关闭 `1`：开启
ExplainStatus	Integer	`0`	商品讲解状态。取值如下： `0`：未讲解 `1`：讲解中 `2`：讲解结束说明仅在开启直播时移功能时，该参数生效。更多有关直播时移的信息，详见直播时移。
ExplainTime	Long	`0`	最近一次修改商品讲解状态的时间。Unix 时间戳，单位为秒。取值为 `0` 表示未修改过商品讲解状态。
FloatingStatus	Integer	`1`	是否以浮窗形式展示商品卡片。取值如下： `1`：以浮窗形式展示 `其他值`：不以浮窗形式展示说明仅在未开启直播时移功能时，该参数生效。
PageAdvertisementType	Integer	`4`	已废弃。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityProduct&Version=2023-08-01
{
    "ActivityId": 1776****89138,
    "ProductConfig": {
        "Id": 780,
        "EnableFloating": true,
        "EnableUA": true,
        "EnableMiniApp": true,
        "MiniAppId": "dsdwsd",
        "ProductsPosition": 0,
        "DefaultRedirectImage": "https://p.example.org/***.png",
        "DisplayEnable": 1,
        "Product": {
            "Products": [
                {
                    "Title": "玫瑰慕斯蛋糕（小）",
                    "Id": 105472,
                    "Remark": "超级好吃的玫瑰慕斯蛋糕",
                    "Strikethrough": "¥30",
                    "MiniAppDirectUrl": "https://example.com",
                    "DirectUrls": [
                        "https://example.com"
                    ],
                    "EnableStatus": 1,
                    "Index": 0,
                    "RedirectUrl": "https://example.com",
                    "RedirectImage": "https://p.example.org/***.png",
                    "IntroduceImage": "https://p.example.org/***.png",
                    "Highlight": "¥15",
                    "SellingPointTag": "买二赠一；满50减20",
                    "ReminderType": 1,
                    "PromotionTagUrl": "https://p.example.org/***.png",
                    "PromotionTagType": 1,
                    "IsOrderMsgEnable": 1,
                    "HotSale": "1000",
                    "Stock": "50"
                }
            ]
        },
        "UAInfo": {
            "UAInfos": [
                {
                    "UAName": "微信",
                    "UAAddress": "MicroMessenger"
                }
            ]
        },
        "MenuName": "商品卡片"
    },
    "VerticalIconUrl": "https://p.example.org/***.png"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateActivityProduct",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ProductConfig": {
            "Id": 780,
            "EnableFloating": true,
            "EnableUA": true,
            "EnableMiniApp": true,
            "MiniAppId": "dsdwsd",
            "ProductsPosition": 0,
            "DefaultRedirectImage": "https://example/MenuBar",
            "DisplayEnable": 1,
            "UAInfo": {
                "UAInfos": [
                    {
                        "UAName": "微信",
                        "UAAddress": "MicroMessenger"
                    }
                ]
            },
            "MenuName": "商品卡片",
            "Product": {
                "Products": [
                    {
                        "Title": "玫瑰慕斯蛋糕（小）",
                        "Highlight": "¥15",
                        "IntroduceImage": "https://p.example.org/***.png",
                        "RedirectImage": "https://p.example.org/***.png",
                        "RedirectUrl": "https://example.com",
                        "Index": 0,
                        "Id": 105472,
                        "EnableStatus": 1,
                        "Remark": "超级好吃的玫瑰慕斯蛋糕",
                        "Strikethrough": "¥30",
                        "MiniAppDirectUrl": "https://example.com",
                        "DirectUrls": [
                            "https://example.com"
                        ],
                        "PageAdvertisementType": 4,
                        "ExplainStatus": 0,
                        "ExplainTime": 0,
                        "FloatingStatus": 1,
                        "SellingPointTag": "买二赠一；满50减20",
                        "ReminderType": 1,
                        "PromotionTagUrl": "https://p.example.org/***.png",
                        "PromotionTagType": 1,
                        "IsOrderMsgEnable": 1,
                        "HotSale": "1000",
                        "Stock": "50"
                    }
                ]
            }
        },
        "VerticalIconUrl": "https://p.example.org/***.png"
    }
}

错误码

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