# 获取小程序广告汇总数据

接口应在服务器端调用,详细说明参见服务端API

# 接口说明

# 接口英文名

GetAdposGenenral

# 功能描述

该 API 用于获取小程序广告汇总数据。使用过程中如遇到问题,可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 注意事项

其中access_token为authorizer_access_token

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/wxa/operationams?action=agency_get_adpos_genenral&access_token=xxxxxxxxxxxxxxx 

# 请求参数

属性 类型 必填 说明
page number 返回第几页数据
page_size number 当页返回数据条数
start_date string 获取数据的开始时间 yyyy-mm-dd
end_date string 获取数据的结束时间 yyyy-mm-dd
ad_slot string 广告位类型名称

# 返回参数

属性 类型说明
ret number 错误码
err_msg string 返回错误信息
list array<object> list
属性 类型 说明
slot_id number 广告位类型id
ad_slot string 广告位类型名称
date string 日期
req_succ_count number 拉取数
exposure_count number 曝光量
exposure_rate number 曝光率
click_count number 点击量
click_rate number 点击率
publisher_income number 小程序分账收入(分)
ecpm number 广告千次曝光收益(分)
summary array<object> summary
属性 类型 说明
req_succ_count number 总拉取量
exposure_count number 总曝光量
exposure_rate number 总曝光率
click_count number 总点击量
click_rate number 总点击率
publisher_income number 小程序分账总收入(分)
ecpm number 广告千次曝光收益(分)
total_num number list返回总条数

# 其他说明

1、返回list中的记录按照date降序,slot_id升序排列,用户请以分页的形式获取。如果不传递广告位类型名称,将默认返回全部类型广告位的数据。

2、请求参数中,page_size无上限,但建议服务商预估数据量级后分页获取

# 调用示例

示例说明: HTTPS请求

# 请求数据示例


{
    "page": 1,
    "page_size": 8,
    "start_date": "2020-04-13",
    "end_date":"2020-04-13"
    "ad_slot": "SLOT_ID_WEAPP_INTERSTITIAL"
} 

# 返回数据示例


{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "list":[
        {
            "slot_id":3030046789020061,
            "ad_slot":"SLOT_ID_WEAPP_INTERSTITIAL",
            "date":"2020-04-13",
            "req_succ_count":443610,
            "exposure_count":181814,
            "exposure_rate":0.409850995,
            "click_count":10095,
            "click_rate":0.055523777,
            "publisher_income":52175,
            "ecpm":286.969100289
        }
    ],
    "summary":{
        "req_succ_count":4406394,
        "exposure_count":1797225,
        "exposure_rate":0.407867522,
        "click_count":100167,
        "click_rate":0.055734257,
        "publisher_income":578003,
        "ecpm":321.608591022
    },
    "total_num":1
} 

# 错误码

错误码 错误码取值 解决方案
0 ok ok
-202 内部错误 可在一段时间后重试
1700 参数错误 检验输入参数是否符合文档说明
1701 参数错误 检验输入参数是否符合文档说明
1735 商户未完成协议签署流程 完成签约操作
1737 操作过快 等待一分钟后重新操作
1807 无效流量主 通过开通流量主接口为该appid开通流量主
2009 无效流量主 通过开通流量主接口为该appid开通流量主
2056 服务商未在变现专区开通账户 在第三方平台页面的变现专区开通服务