# 获取服务商广告汇总数据

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：GetAgencyAdsStat

该 API 用于获取服务商通过流量主代运营模式产生的广告汇总数据。使用过程中如遇到问题，可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/getdefaultamsinfo?access_token=ACCESS_TOKEN

# 云调用

本接口不支持云调用

# 第三方调用

本接口支持第三方平台调用。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	说明
access_token	string	是	接口调用凭证，可使用 authorizer_access_token

# 请求体 `Request Payload`

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

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
ret	number	错误码
err_msg	string	返回错误信息
summary	objarray	summary
list	objarray	list
total_num	number	请求返回总条数

# Res.summary(Array) `Object Payload`

summary

参数名	类型	说明
click_count	number	总点击数
exposure_count	string	总曝光数
income	number	总广告收入(分)
req_succ_count	number	总拉取量
ecpm	number	汇总eCPM(分)
exposure_rate	number	汇总曝光率
click_rate	number	汇总点击率
publisher_income	number	总小程序分账后收入(分)
agency_income	number	总服务商分账后收入(分)
exposure_uv	number	总曝光uv
open_uv	number	总打开uv

# Res.list(Array) `Object Payload`

list

参数名	类型	说明
date	string	日期
click_count	number	点击数
exposure_count	number	曝光数
income	number	单日总广告收入(分)
req_succ_count	number	拉取量
ecpm	number	eCPM(分)
exposure_rate	number	曝光率
click_rate	number	点击率
ad_slot	string	广告位类型名称
publisher_income	number	小程序分账后收入(分)
agency_income	number	服务商分账后收入(分)
publisher_appid	string	小程序appid

# 4. 注意事项

其中access_token为component_access_token

# 5. 代码示例

请求示例

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

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

返回示例

{
    "ret":0,
    "err_msg":"", // 仅失败返回
    "list":[
        {
            "slot_id":3030046789020061,
            "ad_slot":"SLOT_ID_WEAPP_INTERSTITIAL",
            "date":"2021-04-13",
            "req_succ_count":443610,
            "exposure_count":181814,
            "exposure_rate":0.409850995,
            "click_count":10095,
            "click_rate":0.055523777,
            "income":104350,
            "ecpm":286.969100289,
            "agency_income":52175,
            "publisher_income":52175,
	    "publisher_appid":"wxf3dsfsfsdf13d"
        }
    ],
    "summary":{
        "req_succ_count":4406394,
        "exposure_count":1797225,
        "exposure_rate":0.407867522,
        "click_count":100167,
        "click_rate":0.055734257,
        "income":578003,
        "ecpm":321.608591022
        "exposure_uv":3456,
        "open_uv":4567
    },
    "total_num":1
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述	解决方案
-202	内部错误	可在一段时间后重试
0	ok	ok
1700	参数错误	检验输入参数是否符合文档说明
1701	参数错误	检验输入参数是否符合文档说明
1737	操作过快	等待一分钟后重新操作
2056	服务商未在变现专区开通账户	在第三方平台页面的变现专区开通服务

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。