You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/菜单栏控制/Version：2023-08-01/获取商品卡片菜单的配置信息
获取商品卡片菜单的配置信息
最近更新时间：2025.01.03 10:57:39首次发布时间：2023.09.22 10:49:48
我的收藏

调用 GetActivityProducts 接口，获取指定直播间商品卡片菜单的配置信息，例如商品卡片菜单的 ID、名称、启用状态等信息，以及商品卡片的 ID、商品名称、售卖价等信息。

注意事项

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

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数类型是否必选示例值描述
ActionString是GetActivityProducts接口名称。当前 API 的名称为 GetActivityProducts。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是1776****89138直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

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

ProductConfigs

参数类型示例值描述
IdLong780商品卡片菜单的 ID。
MenuNameString商品卡片商品卡片菜单的名称。

IsEnable

Boolean

true

是否启用商品卡片菜单。取值如下：

  • true：启用
  • false：不启用

EnableUA

Boolean

true

是否开启直达链接功能。该功能仅移动端支持。取值如下：

  • true：开启
  • false：关闭

UAInfo

Object of UAInfo

-

直达链接的配置信息。

说明

该参数仅在 EnableUA 取值为 true 时生效。

EnableMiniApp

Boolean

true

是否开启微信小程序跳转功能。该功能仅移动端支持。取值如下：

  • true：开启
  • false：关闭

MiniAppId

String

dsdwsd

跳转的微信小程序的原始 ID。

说明

该参数仅在 EnableMiniApp 取值为 true 时生效。

DisplayEnable

String

1

商品卡片在观看页的入口。取值如下：

  • 1：观看页支持展示商品卡片菜单和浮窗商品卡片。移动端观看页可同步展示购物车图标

    说明

    • 移动端竖屏直播间仅支持展示购物车图标和浮窗商品卡片。
    • 仅在启用聊天互动菜单后，移动端横屏直播间才会展示购物车图标。
  • 2：观看页仅支持展示浮窗商品卡片

ProductsPosition

Integer

0

浮窗商品卡片在 PC 端观看页的展示位置。取值如下：

  • 0：播放器右上角
  • 1：播放器左上角
  • 2：播放器左下角
  • 3：播放器右下角

EnableFloating

Boolean

true

是否开启浮层展示。取值如下：

  • true：开启。观众在移动端点击商品卡片后，在当前观看页以浮层形式展示商品详情页。观众可以在观看直播的同时查看商品详情页，实现边看边买
  • false：关闭。观众点击商品卡片后，页面自动跳转至新的浏览器标签页展示商品详情页。观众无法同时观看直播与商品详情页
DefaultRedirectImageStringhttps://p.example.org/***.png商品卡片默认跳转图的 URL，包含协议头。
ProductObject of Product-商品卡片的配置信息。
UAAddressString-已废弃。

UAInfo

参数类型示例值描述

UAInfos

Array of UAInfos

-

直达链接的配置信息。

说明

该参数仅在 EnableUA 取值为 true 时生效。

Product

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

UAInfos

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

Products

参数类型示例值描述
IdLong105472商品卡片的 ID。
IndexInteger0商品卡片的序号。取值范围为 [0,499]。
IntroduceImageStringhttps://p.example.org/***.png商品图的 URL，包含协议头。

PromotionTagType

Integer

1

活动标签类型。取值如下：

  • 0：无
  • 1：自定义
  • 2：超值购
  • 3：惊喜特惠
  • 4：低价秒杀
PromotionTagUrlStringhttps://p.example.org/***.png活动标签的 URL，包含协议头。
TitleString玫瑰慕斯蛋糕（小）商品名称。
RemarkString超级好吃的玫瑰慕斯蛋糕商品介绍。
HighlightString¥15商品的售卖价，即当前价格。
StrikethroughString¥30商品的参考价，即原价。
SellingPointTagString买二赠一；满50减20卖点标签。卖点间以分号（；）相隔。
RedirectImageStringhttps://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 时生效。

RedirectUrlStringhttps://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：讲解结束

说明

仅在开启直播时移功能时，该参数生效。更多有关直播时移的信息，详见直播时移。

ExplainTimeLong0最近一次修改商品讲解状态的时间。Unix 时间戳，单位为秒。取值为 0 表示未修改过商品讲解状态。

FloatingStatus

Integer

1

是否以浮窗形式展示商品卡片。取值如下：

  • 1：以浮窗形式展示
  • 其他值：不以浮窗形式展示

说明

仅在未开启直播时移功能时，该参数生效。

PageAdvertisementTypeInteger0已废弃。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityProducts&Version=2023-08-01&ActivityId=1776****89138

返回示例

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

错误码

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