文档中心

营销数据信息

最近更新时间：2023.06.05 15:48:57

首次发布时间：2022.03.29 22:10:12

获取当前直播间的营销数据，5 分钟更新一次。

说明

企业直播新增渠道推广功能，支持创建不同的渠道。有关如何创建渠道，详见渠道推广。对于使用了渠道推广功能的直播间，请调用GetAdvertisementDataAPIV2 接口获取不同渠道的数据信息。如果您未使用渠道推广功能，请调用本接口获取营销数据信息。

请求说明

接口名称：GetAdvertisementDataAPI
请求方式：GET
接口地址：http://livesaas.volcengineapi.com/?Action=GetAdvertisementDataAPI&Version=2020-06-01
请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称
Version	String	是	接口版本。直播当前 API 的版本为 2020-06-01
ActivityId	Int64	是	直播间 ID。您可通过ListActivityAPI 接口查询 ID
Source	Int32	否	根据页面访问来源进行筛选。支持以下六种取值，取值默认为 `0`。 -1：查询所有 0：查询默认来源 1：查询来源 A 2：查询来源 B 3：查询来源 C 4：查询来源 D

返回参数

参数	类型	描述
ActivityId	Int64	直播间 ID
AccountClicks	ClicksStruct	营销账号数据
AdvertisingClicks	ClicksStruct	营销广告数据
AdInfo	Array of AdInfo	营销广告详细数据
ShowThumbUpNumber	Int	虚拟点赞数
ActualThumbUpNumber	Int	实际点赞数

ClicksStruct

参数	类型	描述
PV	Int	营销账号或营销广告的点击次数。
UV	Int	营销账号或营销广告的点击人数。
TotalTime	Int	已废弃

AdInfo

参数	类型	描述
PageAdvertiseType	Int	广告类型。支持以下四种取值。 1：页头广告 2：页中广告 3：浮标广告 4：商品卡片广告
Content	String	广告内容
Link	String	广告链接
Title	String	广告标题
PV	Int	营销广告的点击次数。
UV	Int	营销广告的点击人数。

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetAdvertisementDataAPI&Version=2020-06-01&ActivityId=1231231231&Source=0

正常返回示例

{
      "ResponseMetadata":{
            "RequestId":"202201201826170101501312091D1C09D2",
            "Action":"GetAdvertisementDataAPI",
            "Version":"2020-06-01",
            "Service":"livesaas",
            "Region":"cn-north-1",
            "SystemTime":1656067132
      },
      "Result":{
            "ActivityId":1111,
            "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
      }
}

异常返回示例

{
      "ResponseMetadata":{
            "RequestId":"201806041104200100100232280022D30",
            "Action":"GetAdvertisementDataAPI",
            "Version":"2020-06-01",
            "Service":"livesaas",
            "Region":"cn-north-1",
            "SystemTime":1656067132,
            "Error":{
                  "Code":"200000",
                  "Message":"参数异常"   
            }
      }
}

错误码

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