GetAdvertisementDataAPIV2 - 获取直播间营销数据信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetAdvertisementDataAPIV2 - 获取直播间营销数据信息

最近更新时间：2025.03.24 16:50:55首次发布时间：2023.02.01 10:13:46

您可通过此接口获取指定直播间的营销数据。数据 5 分钟更新一次。

注意事项

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

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetAdvertisementDataAPIV2&Version=2020-06-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAdvertisementDataAPIV2`	接口名称。当前 API 的名称为 `GetAdvertisementDataAPIV2`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1779168287`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
Channel	String	否	`123`	根据渠道标识进行筛选。默认查询全部渠道的数据。您可以通过 ListChannelAPI 接口查询渠道标识。

返回参数

参数	类型	示例值	描述
ActivityId	Long	`1779168287`	直播间 ID。
AccountClicks	Object of AccountClicks	`-`	主播账号数据。
AdvertisingClicks	Object of AdvertisingClicks	`-`	营销广告数据，包括页头广告、页中广告、浮标广告、商品卡片。
AdInfo	Array of AdInfo	`-`	营销广告的数据明细，包括页头广告、页中广告、浮标广告、商品卡片。
ShowThumbUpNumber	Integer	`13`	虚拟点赞数。
ActualThumbUpNumber	Integer	`5`	实际点赞数。

AccountClicks

参数	类型	示例值	描述
PV	Integer	`2`	主播账号的点击次数。
UV	Integer	`1`	主播账号的点击人数。
TotalTime	Integer	`0`	已废弃

AdvertisingClicks

参数	类型	示例值	描述
PV	Integer	`2`	所有广告位的点击次数，包括页头广告、页中广告、浮标广告、商品卡片。
UV	Integer	`1`	所有广告位的点击人数，包括页头广告、页中广告、浮标广告、商品卡片。
TotalTime	Integer	`0`	已废弃

AdInfo

参数	类型	示例值	描述
PageAdvertiseType	Integer	`4`	营销广告类型。支持以下取值： `1`：页头广告 `2`：页中广告 `3`：浮标广告 `4`：商品卡片
Content	String	`企业直播`	广告内容。
Link	String	`www.example.com`	广告链接。
Title	String	`商品 1`	广告标题。
PV	Integer	`2`	广告位的点击次数。
UV	Integer	`1`	广告位的点击人数。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetAdvertisementDataAPIV2&Version=2020-06-01&ActivityId=1779168287&Channel=123

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202201201826170101501312091D1C09D2",
        "Action": "GetAdvertisementDataAPIV2",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    },
    "Result": {
        "ActivityId": 1779168287,
        "AccountClicks": {
            "PV": 111,
            "UV": 111,
            "TotalTime": 100
        },
        "AdvertisingClicks": {
            "PV": 111,
            "UV": 100,
            "TotalTime": 100
        },
        "AdInfo": [
            {
                "PageAdvertiseType": 4,
                "Content": "企业直播",
                "Link": "www.example.com",
                "PV": 111,
                "UV": 100,
                "Title": "商品 1"
            }
        ],
        "ShowThumbUpNumber": 13,
        "ActualThumbUpNumber": 5
    }
}

错误码

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