UpdateInPageAdvertisement - 新增、更新或删除页中广告--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

UpdateInPageAdvertisement - 新增、更新或删除页中广告

最近更新时间：2025.08.25 11:01:30首次发布时间：2025.07.16 11:47:52

调用 UpdateInPageAdvertisement接口，在指定直播间中新增、更新或删除页中广告。

使用说明

接口行为

通过本接口的 Advertisements 参数，您可以新增、更新和删除直播间中的页中广告。

新增：在请求参数中将 Id 的取值设置为 0，即可新增页中广告。
更新：在请求参数中传入待更新页中广告的 ID 作为 Id 参数值并按需更新页中广告的配置信息，即可更新该页中广告。为保证广告配置信息的参数值不被清空，即便参数在该接口中为非必选，也必须传入对应的参数值。
删除：在请求参数中不传入某页中广告的 ID，即可删除该页中广告。

说明

为避免直播间中已有的页中广告被误删，或配置信息被清空，您必须将不需要删除和更新的页中广告 ID 及其配置信息作为请求参数传入该接口。您可调用 GetInPageAdvertisement 接口，通过返回参数 Advertisements 获取当前直播间中所有页中广告的配置信息。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`177985****487296`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
IsEnable	Integer	是	`1`	是否开启页中广告。开启后，观看页展示页中广告。取值如下： `0`：关闭 `1`：开启
EnableFloating	Boolean	是	`false`	是否开启浮层展示。取值如下： `true`：开启。观众在移动端点击页中广告后，在当前观看页以浮层形式展示广告页面。观众可以在观看直播的同时查看广告。 `false`：关闭。观众点击页中广告后，页面自动跳转至新的浏览器标签页展示广告页面。观众无法同时观看直播与广告。
Advertisements	Array of Advertisements	否	`-`	页中广告信息。说明单次接口调用新增和更新的页中广告总数上限为 30。页中广告在观看页的播放顺序与数组中的顺序一致。

参数	类型	是否必选	示例值	描述
Id	Long	是	`0`	页中广告 ID，用于新增、更新或删除页中广告。详见接口行为。
ImageUrl	String	是	`https://p.example.org/example.png`	页中广告的图片地址，需包含协议头。
HomeUrl	String	否	`https://example.com`	页中广告的跳转链接，需包含协议头。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否操作成功。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateInPageAdvertisement&Version=2023-08-01
{
    "ActivityId": 177985****487296,
    "IsEnable": 1,
    "EnableFloating": false,
    "Advertisements": [
        {
            "ImageUrl": "https://p.example.org/example.png",
            "HomeUrl": "https://example.com",
            "Id": 0
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateInPageAdvertisement",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

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