# 获取服务商广告明细数据

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

接口英文名：GetAgencyAdsDetail

该 API 用于获取授权服务商进行流量主代运营，分小程序产生的广告细分数据，最小颗粒度为广告单元id（aduint）。使用过程中如遇到问题，可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 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	是	当页返回数据条数(最大为200)
start_date	string	是	获取数据的开始时间yyyy-mm-dd
end_date	string	是	获取数据的结束时间yyyy-mm-dd
ad_slot	string	否	广告位类型名称

# 3. 返回参数

# 返回体 `Response Payload`

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

# Res.list(Array) `Object Payload`

list

参数名	类型	说明
ad_unit_id	string	广告单元ID
ad_unit_name	string	广告位名称
appid	string	小程序appid
stat_item	objarray	stat_item

# Res.list(Array).stat_item`Object Payload`

stat_item

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

# 4. 注意事项

其中access_token为component_access_token

# 其他说明

请注意：返回list中的项按照date降序排列，用户请以分页的形式获取。当需要获取全部广告位的细分数据时，无需传递广告位类型名称；当需要获取某类型广告位的细分数据时，需传递广告位类型名称。

# 5. 代码示例

请求示例

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

{
  "page": 1,
  "page_size": 8,
  "start_date": "2020-04-10",
  "end_date": "2020-04-10",
  "ad_slot": "SLOT_ID_WEAPP_REWARD_VIDEO"
}

返回示例

{
    "ret":0
    "err_msg":"",//仅在有错误时返回
    "list":[
        {
            "ad_unit_id":"adunit-9cedd8514XXXX",
            "ad_unit_name":"激励视频长广告",
            "stat_item":{
                "ad_slot":"SLOT_ID_WEAPP_REWARD_VIDEO",
                "date":"2020-04-10",
                "req_succ_count":138250,
                "exposure_count":74771,
                "exposure_rate":0.54083906,
                "click_count":2242,
                "click_rate":0.029984887,
                "income":187766,
                "ecpm":6.790813743,
                "publisher_income":93883,
                "agency_income":93883
            }
            "appid":"wxf3dsfsfsdf13d"
        }
    ],
    "total_num":1
}

# 6. 错误码

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

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

# 7. 适用范围

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