更新浮标广告配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新浮标广告配置信息

最近更新时间：2024.06.19 11:38:01首次发布时间：2024.06.19 11:38:01

您可通过此接口更新指定直播间中浮标广告的开启状态、广告链接等配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1798615803802`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
IsEnable	Integer	否	`1`	是否开启浮标广告。支持以下取值，默认取值为 `0`。 `0`：关闭 `1`：开启
ImageUrl	String	否	`https://p.example.org/6ed59yyum2-z75.png`	浮标广告图片地址。需要包含 https 协议头。说明首次通过该接口更新浮标广告配置信息时，该参数必传。
HomeUrl	String	否	`https://example.com`	浮标广告的跳转链接。需要包含 https 协议头。
IsCloseEnable	Integer	否	`1`	观众是否可以关闭浮标广告。支持以下取值，默认取值为 `0`。 `0`：可以关闭 `1`：不可以关闭
EnableFloating	Boolean	否	`true`	是否开启浮层展示。支持以下取值，默认取值为 `false`。 `true`：开启。点击浮标广告后，将在当前直播页面展开广告，观众可在看直播的同时查看广告。该选项仅在移动端观看页面生效。 `false`：关闭。点击浮标广告后，将打开新的浏览器标签页展示广告，观众无法同时观看直播与广告。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	是否更新成功。支持以下取值： `true`：成功 `false`：失败

Status

Boolean

true

是否更新成功。支持以下取值：

true：成功
false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateFloatingAdvertisement&Version=2023-08-01
{
    "ActivityId": 1798615803802,
    "ImageUrl": "https://p.example.org/6ed59yyum2-z75.png",
    "HomeUrl": "https://example.com",
    "IsCloseEnable": 1,
    "IsEnable": 1,
    "EnableFloating": true
}

返回示例

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

错误码

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