接口文档SDK业务专题开发者工具

实时消耗 (Realtime Cost)

V1.1

loading


本节将为您介绍实时消耗 (Realtime Cost) 相关的接口。通过该接口,您可以获取到广告帐号、推广计划以及广告组今日的实时消耗。

接口所属权限(scope):Ads Management

所属权限(scope):Account Management



获取实时消耗
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 realtime_cost/get
请求方法 get

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台,暂不支持微信公众平台。
标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
level*
string 获取实时消耗的类型级别
可选值:{ ADVERTISER, CAMPAIGN, ADGROUP }
date*
string 日期,查询日期,日期格式:YYYY-MM-DD,只支持今天的数据查询
字段长度为 10 字节
filtering
struct[] 过滤条件,过滤条件,当 level=CAMPAIGN 或 ADGROUP 时,该字段必填;若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 2
field*
string 过滤字段,当 level 为 CAMPAIGN 时,field 仅可选择 campaign_id ;当 level 为 ADGROUP 时,field 仅可选择 adgroup_id ;
可选值:{ adgroup_id, campaign_id }
operator*
enum 操作符
当 field 取值 adgroup_id 时,枚举列表:{ EQUALS }
当 field 取值 campaign_id 时,枚举列表:{ EQUALS }
values*
string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10
最小值 1,最大值 100

请求示例


curl -G 'https://api.e.qq.com/v1.1/realtime_cost/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'level=ADGROUP' \
-d 'date=2017-04-25' \
-d 'filtering=[{"field":"adgroup_id","operator":"EQUALS","values":["<ADGROUP_ID>"]}]' \
-d 'page=1' \
-d 'page_size=10' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
campaign_id
integer 推广计划 id,当获取广告主维度报表时,该值为 0,无意义
adgroup_id
integer 广告组 id,当获取广告主维度、推广计划维度报表时,该值为 0,无意义
cost
integer 实时消耗,单位分
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "campaign_id": "<CAMPAIGN_ID>",
                "adgroup_id": "<ADGROUP_ID>",
                "cost": 1300
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具


【待废弃,请使用新接口 wechat_daily_cost/get 】获取微信账户实时消耗
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 daily_cost/get
请求方法 get

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于微信公众平台,暂不支持腾讯广告平台。
标有*的参数为必填项

名称 类型 描述
account_id
integer 推广帐号 id,直客客户必须填写,代理商可不填写; 如代理商不填写,则获取代理商下全部子客户的信息
date_range*
struct 日期范围,日期范围,支持 7 天内的数据查询
start_date*
string 开始日期,日期格式:YYYY-MM-DD,且小于等于 end_date
字段长度为 10 字节
end_date*
string 结束日期,日期格式:YYYY-MM-DD,且大于等于 begin_date
字段长度为 10 字节
filtering
struct[] 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件]
数组最小长度 1,最大长度 10
field*
string
可选值:{ wechat_account_id }
operator*
enum 操作符
当 field 取值 wechat_account_id 时,枚举列表:{ EQUALS, IN }
values*
string[] 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件]
当 field 取值 wechat_account_id 时,
字段长度最小 1 字节,长度最大 120 字节

当 field 取值 wechat_account_id 且 operator 取值 IN 时,
字段长度最小 1 字节,长度最大 120 字节
page
integer 搜索页码,默认值:1
最小值 1,最大值 99999
page_size
integer 一页显示的数据条数,默认值:10
最小值 1,最大值 100

使用说明

  1. 获取微信服务商下广告主子客实时消耗信息,只允许微信服务商调用。

请求示例


curl -G 'https://api.e.qq.com/v1.1/daily_cost/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'filtering=[]' \
-d 'page=1' \
-d 'page_size=10' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
account_id
integer 推广帐号 id
wechat_account_id
string 微信账号 id:若为微信公众号则为微信公众号 id,若为通用账号则为通用账号 id。
date
string 日期,日期格式:YYYY-MM-DD
cost
integer 实时消耗,单位分
page_info
struct 分页配置信息
page
integer 搜索页码
page_size
integer 一页显示的数据条数
total_number
integer 总条数
total_page
integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "account_id": "<ACCOUNT_ID>"
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具