# 获取小程序广告细分数据

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

# 接口说明

# 接口英文名

GetAdposDetail

# 功能描述

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

# 注意事项

其中access_token为authorizer_access_token

# 调用方式

# HTTPS 调用


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

# 请求参数

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

# 返回参数

属性

类型

说明

ret

number

错误码

err_msg

string

错误信息

list

array<object>

list

属性

类型

说明

ad_unit_id

string

广告单元ID

ad_unit_name

string

广告位名称

stat_item

array<object>

stat_item

属性	类型	说明
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	广告千次曝光收益(分)

total_num

number

请求返回总数

# 其他说明

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

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

# 调用示例

示例说明: HTTPS请求

# 请求数据示例


{
    "page":  1,
    "page_size": 8,
    "start_date": "2020-04-10",
    "end_date": "2020-04-10",
    "ad_unit_id": "adunit-9cedd8514XXXX"
}

# 返回数据示例


{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "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,
                "publisher_income":93883,
                "ecpm":6.790813743
            }
        }
    ],
    "total_num":1
}

# 错误码

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