广告分析接口说明

向所有成为流量主的小程序开发者开放数据接口。通过数据接口,开发者可以获取与公众平台官网统计模块类似但更灵活的数据,还可根据需要进行高级处理。

请注意:

  1. 接口侧数据库中仅存储了2016年1月1日之后的数据,将无法查询到此前的数据,即使查到,也是不可信的脏数据;
  2. 建议开发者在调用接口获取数据后,将数据保存在自身数据库中,以最大化访问的效率,也降低微信侧接口调用的不必要损耗;
  3. 由于数据量较大, 所有接口采取分页获取的方式, 每页最大获取量为90。(eg : total_num 为100, 则当page = 1, page_size = 10, 则返回前10条, page = 1, page_size = 20, 则返回前20条, page = 2, page_size = 10, 则返回第11条到第20条)

接口总览

广告分析接口目前可用于获得“公众平台 → 流量主 → 数据统计”页面展示的部分广告数据,具体接口列表如下:

接口名称 用途                 最大时间跨度 接口调用地址(必须使用https)
publisher_adpos_general 获取小程序广告汇总数据 90天 https://api.weixin.qq.com/publisher/stat?action=publisher_adpos_general&access_token=ACCESS_TOKEN
publisher_adunit_general 获取小程序广告细分数据 90天 https://api.weixin.qq.com/publisher/stat?action=publisher_adunit_general&access_token=ACCESS_TOKEN
get_adunit_list 获取小程序广告位清单 https://api.weixin.qq.com/publisher/stat?action=get_adunit_list&access_token=ACCESS_TOKEN

接口调用请求说明

一、获取小程序广告汇总数据

需要向相应接口调用地址增加以下GET请求参数:

参数 是否必须 说明
page 数据返回页数
page_size 每页返回数据条数
start_date 获取数据的开始时间 yyyy-mm-dd
end_date 获取数据的结束时间 yyyy-mm-dd
slot_id(int) 广告位枚举值, 广告位实际上映射的数字

广告位枚举值

8040321819858439 : banner广告位
1030436212907001 : 激励视频广告位
3030046789020061 : 插屏广告位
7070083760581921 : 格子广告位
7090665964306299 : 前贴视频广告位
5010365819466098 : 视频广告位

返回参数说明

参数 说明
err_msg 返回错误信息
ret 错误码
list: date 日期
list: slot_id 广告位ID
list: req_succ_count 拉取量
list: exposure_count 曝光量
list: exposure_rate 曝光率
list: click_count 点击量
list: click_rate 点击率
list: income 收入(分)
list: ecpm 广告千次曝光收益(分)
summary: req_succ_count 总拉取量
summary: exposure_count 总曝光量
summary: exposure_rate 总曝光率
summary: click_count 总点击量
summary: click_rate 总点击率
summary: income 总收入(分)
summary: ecpm 广告千次曝光收益(分)
total_num list返回总条数

返回数据包示例

{
	"base_resp": {
		"err_msg": "ok",
		"ret": 0
	},
	"list": [{
			"date": "2020-02-26",
            "slot_id": 72058780271891663,
            "req_succ_count": 10010801,
            "exposure_count": 3074169,
			"exposure_rate": 0.307085217,
            "click_count": 18963,
			"click_rate": 0.006168496,
			"income": 1994516,
			"ecpm": 6.488288887
		}
	],
	"summary": {
		"req_succ_count": 38817640,
        "exposure_count": 11129498,
        "exposure_rate": xxx,
        "click_count": 59897,
		"click_rate": xxx,
		"income": 4035491,
		"ecpm": xxx 
	},
	"total_num": 15
}

二、获取小程序广告细分数据

需要向相应接口调用地址增加以下GET请求参数:

参数 是否必须 说明
page 数据返回页数
page_size 每页返回数据条数
start_date 获取数据的起始日期 yyyy-mm-dd
end_date 获取数据的结束时间 yyyy-mm-dd
slot_id(int) 广告位枚举值, 广告位实际上映射的数字

广告位枚举值

8040321819858439 : banner广告位
1030436212907001 : 激励视频广告位
3030046789020061 : 插屏广告位
7070083760581921 : 格子广告位
7090665964306299 : 前贴视频广告位
5010365819466098 : 视频广告位

返回参数说明

参数 说明
err_msg 返回错误信息
ret 错误码
ad_unit_id 广告位id
ad_unit_name 广告位名称
date 数据日期
req_succ_count 拉取量
exposure_count 曝光量
exposure_rate 曝光率
click_count 点击量
click_rate 点击率
income 收入
ecpm 广告千次曝光收益(分)
total_num 请求返回总数

返回数据包示例

{
	"base_resp": {
		"err_msg": "ok",
		"ret": 0
	},
	"list": [{
			"ad_unit_id": "adunit-e82292b235d40ade",
			"ad_unit_name": "激励广告领奖广告位",
			"stat_item": {
            	"date": "2020-02-26",
                "req_succ_count": 18362446,
                "exposure_count": 12554962,
				"exposure_rate": 0.68373037,
				"click_count": 168349,
				"click_rate": 0.013408961,
			    "income": 2590683,
				"ecpm": 1.410859425
			}
		}
	],
	"total_num": 9
}

三、获取小程序广告位清单

需要向相应接口调用地址增加以下GET请求参数:

参数 是否必须 说明
page 数据返回页数
page_size 每页返回数据条数
ad_unit_type(string) 广告位枚举值

广告位枚举值

AD_UNIT_TYPE_BANNER : banner广告位
AD_UNIT_TYPE_REWARED_VIDEO : 激励视频广告位
AD_UNIT_TYPE_INTERSTITIAL : 插屏广告位
AD_UNIT_TYPE_BOX : 格子广告位
AD_UNIT_TYPE_VIDEO_BEGIN : 前贴视频广告位
AD_UNIT_TYPE_VIDEO_FEEDS : 视频广告位

返回参数说明

参数 说明
err_msg 返回错误信息
ret 错误码
ad_unit_id 广告位ID
ad_unit_name 广告位名称
ad_unit_type 广告位类型
ad_unit_size 广告位尺寸
ad_unit_status 广告位状态

返回数据包示例

{
	"ad_unit": [{
			"ad_unit_id": "adunit-bf7a1513277ab6a2",
			"ad_unit_name": "高ecpm广告",
			"ad_unit_type": "AD_UNIT_TYPE_REWARED_VIDEO",
			"ad_unit_status": "AD_UNIT_STATUS_ON",
            "ad_unit_size": [{
				"height": 166,
				"width": 582
			}],
			"appid": "wxd0e404d795ea6f80",
			"bid_floor": 350,
			"video_duration_max": 30,
			"video_duration_min": 6
		}
	],
	"base_resp": {
		"err_msg": "ok",
		"ret": 0
	},
	"total_num": 20
}

错误码说明

错误码返回值 含义
45009 请求过于频繁, 请稍后尝试
45010 无效的接口名
1701 参数错误
2009 无效的流量主