You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/营销广告/GetInPageAdvertisement - 获取页中广告配置信息
GetInPageAdvertisement - 获取页中广告配置信息
最近更新时间：2025.07.16 11:47:52首次发布时间：2025.07.16 11:47:52
复制全文
我的收藏
有用
有用
无用
无用

调用 GetInPageAdvertisement 接口，获取指定直播间中页中广告的图片、跳转链接等配置信息。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 前提条件：确保您拥有火山引擎主账号或具备直播间的营销互动 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetInPageAdvertisement接口名称。当前 API 的名称为 GetInPageAdvertisement。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

ActivityId

Long

是

177985****487296

直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

说明

使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

返回参数

参数类型示例值描述

IsEnable

Integer

1

是否开启页中广告。开启后，观看页展示页中广告。取值如下：

  • 0：关闭。
  • 1：开启。

EnableFloating

Boolean

true

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

  • true：开启。观众在移动端点击页中广告后，在当前观看页以浮层形式展示广告页面。观众可以在观看直播的同时查看广告。
  • false：关闭。观众点击页中广告后，页面自动跳转至新的浏览器标签页展示广告页面。观众无法同时观看直播与广告。
AdvertisementsArray of Advertisements-页中广告信息。

Advertisements

参数类型示例值描述
IdLong1页中广告 ID。
ImageUrlStringhttps://p.example.org/example.png页中广告的图片地址，包含协议头。
HomeUrlStringhttps://example.com页中广告的跳转链接，包含协议头。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetInPageAdvertisement&Version=2023-08-01&ActivityId=177985****487296

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetInPageAdvertisement",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Advertisements": [
            {
                "Id": 1,
                "ImageUrl": "https://p.example.org/example.png",
                "HomeUrl": "https://example.com"
            }
        ],
        "IsEnable": 1,
        "EnableFloating": true
    }
}

错误码

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