廣告分析數(shù)據(jù)接口說明

向所有成為流量主的公眾號、小程序、小游戲開發(fā)者開放數(shù)據(jù)接口。通過數(shù)據(jù)接口，開發(fā)者可以獲取與公眾平臺官網(wǎng)統(tǒng)計模塊類似但更靈活的數(shù)據(jù)，還可根據(jù)需要進行高級處理。

公司主營業(yè)務(wù)：網(wǎng)站制作、網(wǎng)站設(shè)計、移動網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實現(xiàn)互聯(lián)網(wǎng)宣傳，提高企業(yè)的競爭能力。創(chuàng)新互聯(lián)是一支青春激揚、勤奮敬業(yè)、活力青春激揚、勤奮敬業(yè)、活力澎湃、和諧高效的團隊。公司秉承以“開放、自由、嚴謹、自律”為核心的企業(yè)文化，感謝他們對我們的高要求，感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn)，讓我們激情的團隊有機會用頭腦與智慧不斷的給客戶帶來驚喜。創(chuàng)新互聯(lián)推出崇州免費做網(wǎng)站回饋大家。

請注意：

1. 接口側(cè)數(shù)據(jù)庫中僅存儲了2016年1月1日之后的數(shù)據(jù)，將無法查詢到此前的數(shù)據(jù)，即使查到，也是不可信的臟數(shù)據(jù)；
2. 建議開發(fā)者在調(diào)用接口獲取數(shù)據(jù)后，將數(shù)據(jù)保存在自身數(shù)據(jù)庫中，以最大化訪問的效率，也降低微信側(cè)接口調(diào)用的不必要損耗；
3. 由于數(shù)據(jù)量較大, 所有接口采取分頁獲取的方式, 每頁最大獲取量為90。（eg：total_num 為100，則當page = 1，page_size = 10，則返回前10條；page = 1，page_size = 20，則返回前20條；page = 2，page_size = 10，則返回第11條到第20條）
4. 廣告位枚舉值變更說明由于多個接口都使用了廣告位參數(shù)，為保證體驗的一致性和參數(shù)的可讀性，我們做了一些變更，所有接口均支持以 廣告位類型名稱（ad_slot） 傳遞參數(shù)，回包時新增這個名稱來代表相關(guān)含義。此前的參數(shù) slot_id 也可繼續(xù)使用并回傳。具體為：

廣告位類型名稱（ad_slot）	廣告位類型
SLOT_ID_BIZ_BOTTOM	公眾號底部廣告
SLOT_ID_BIZ_MID_CONTEXT	公眾號文中廣告
SLOT_ID_BIZ_VIDEO_END	公眾號視頻后貼
SLOT_ID_BIZ_SPONSOR	公眾號互選廣告
SLOT_ID_BIZ_CPS	公眾號返傭商品
SLOT_ID_WEAPP_BANNER	小程序banner
SLOT_ID_WEAPP_REWARD_VIDEO	小程序激勵視頻
SLOT_ID_WEAPP_INTERSTITIAL	小程序插屏廣告
SLOT_ID_WEAPP_VIDEO_FEEDS	小程序視頻廣告
SLOT_ID_WEAPP_VIDEO_BEGIN	小程序視頻前貼
SLOT_ID_WEAPP_BOX	小程序格子廣告
SLOT_ID_WEAPP_TEMPLATE	小程序原生模板廣告

接口總覽

廣告分析接口目前可用于獲得“公眾平臺 → 流量主 → 數(shù)據(jù)統(tǒng)計”頁面展示的部分廣告數(shù)據(jù)和“公眾平臺 → 流量主 → 財務(wù)管理”頁面展示的部分收入數(shù)據(jù)，與小程序相關(guān)的接口列表如下:

接口名稱	用途	最大時間跨度	接口調(diào)用地址（必須使用https）
publisher_adpos_general	獲取小程序廣告匯總數(shù)據(jù)	90天	https://api.weixin.qq.com/publisher/stat?action=publisher_adpos_general&access_token=ACCESS_TOKEN
publisher_adunit_general	獲取小程序廣告細分數(shù)據(jù)	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
publisher_settlement	獲取小程序結(jié)算收入數(shù)據(jù)及結(jié)算主體信息	無	https://api.weixin.qq.com/publisher/stat?action=publisher_settlement&access_token=ACCESS_TOKEN

接口調(diào)用請求說明

一、獲取小程序廣告匯總數(shù)據(jù)（publisher_adpos_general）

需要向相應(yīng)接口調(diào)用地址增加以下GET請求參數(shù)：

參數(shù)	是否必須	說明
page	是	返回第幾頁數(shù)據(jù)
page_size	是	當頁返回數(shù)據(jù)條數(shù)
start_date	是	獲取數(shù)據(jù)的開始時間 yyyy-mm-dd
end_date	是	獲取數(shù)據(jù)的結(jié)束時間 yyyy-mm-dd
ad_slot	否	廣告位類型名稱

請注意： 如果不傳遞廣告位類型名稱，將默認返回全部類型廣告位的數(shù)據(jù)。

返回參數(shù)說明（publisher_adpos_general）

參數(shù)	說明
err_msg	返回錯誤信息
ret	錯誤碼
list: slot_id	廣告位類型id
list: ad_slot	廣告位類型名稱
list: date	日期
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返回總條數(shù)

返回數(shù)據(jù)包示例（publisher_adpos_general）

{
    "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,
            "income":52175,
            "ecpm":286.969100289
        }
    ],
    "summary":{
        "req_succ_count":4406394,
        "exposure_count":1797225,
        "exposure_rate":0.407867522,
        "click_count":100167,
        "click_rate":0.055734257,
        "income":578003,
        "ecpm":321.608591022
    },
    "total_num":1
}

二、獲取小程序廣告細分數(shù)據(jù)（publisher_adunit_general）

需要向相應(yīng)接口調(diào)用地址增加以下GET請求參數(shù)：

參數(shù)	是否必須	說明
page	是	返回第幾頁數(shù)據(jù)
page_size	是	當頁返回數(shù)據(jù)條數(shù)
start_date	是	獲取數(shù)據(jù)的起始日期 yyyy-mm-dd
end_date	是	獲取數(shù)據(jù)的結(jié)束時間 yyyy-mm-dd
ad_slot	否	廣告位類型名稱
ad_unit_id	否	廣告位id

請注意： 當需要獲取全部廣告位的細分數(shù)據(jù)時，無需傳遞廣告位類型名稱及廣告位id；當需要獲取某類型廣告位的細分數(shù)據(jù)時，僅需傳遞廣告位類型名稱；當需要獲取某廣告位id的細分數(shù)據(jù)時，僅需傳遞廣告位id。

返回參數(shù)說明（publisher_adunit_general）

參數(shù)	說明
err_msg	返回錯誤信息
ret	錯誤碼
list: ad_unit_id	廣告位id
list: ad_unit_name	廣告位名稱
list: stat_item: ad_slot	廣告位類型名稱
list: stat_item :date	數(shù)據(jù)日期
list: stat_item :req_succ_count	拉取量
list: stat_item :exposure_count	曝光量
list: stat_item: exposure_rate	曝光率
list: stat_item :click_count	點擊量
list: stat_item :click_rate	點擊率
list: stat_item :income	收入
list: stat_item :ecpm	廣告千次曝光收益(分)
total_num	請求返回總數(shù)

返回數(shù)據(jù)包示例（publisher_adunit_general）

{
    "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,
                "income":93883,
                "ecpm":6.790813743
            }
        }
    ],
    "total_num":1
}

三、獲取小程序廣告位清單（get_adunit_list）

需要向相應(yīng)接口調(diào)用地址增加以下GET請求參數(shù)：

參數(shù)	是否必須	說明
page	是	返回第幾頁數(shù)據(jù)
page_size	是	當頁返回數(shù)據(jù)條數(shù)
ad_slot	否	廣告位類型名稱
ad_unit_id	否	廣告位id

請注意： 當需要獲取全部廣告位的清單時，無需傳遞廣告位類型名稱及廣告位id；當需要獲取某類型廣告位的清單時，僅需傳遞廣告位類型名稱；當需要獲取某廣告位id的數(shù)據(jù)時，僅需傳遞廣告位id。

返回參數(shù)說明（get_adunit_list）

參數(shù)	說明
err_msg	返回錯誤信息
ret	錯誤碼
ad_slot	廣告位類型名稱
ad_unit_id	廣告位ID
ad_unit_name	廣告位名稱
ad_unit_size	廣告位尺寸
ad_unit_status	廣告位狀態(tài)

返回數(shù)據(jù)包示例（get_adunit_list）

{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "ad_unit":[
        {
            "ad_slot":"SLOT_ID_WEAPP_REWARD_VIDEO",
            "ad_unit_id":"adunit-e9418ee19XXXXX",
            "ad_unit_name":"rewaXXXX",
            "ad_unit_size":[
                {
                    "height":166,
                    "width":582
                }
            ],
            "ad_unit_status":"AD_UNIT_STATUS_ON",
            "ad_unit_type":"AD_UNIT_TYPE_REWARED_VIDEO",
            "appid":"wx0afc78670fXXXX",
            "video_duration_max":30,
            "video_duration_min":6
        }
    ],
    "total_num":1
}

四、獲取小程序結(jié)算收入數(shù)據(jù)及結(jié)算主體信息（publisher_settlement）

需要向相應(yīng)接口調(diào)用地址增加以下GET請求參數(shù)：

參數(shù)	是否必須	說明
page	是	數(shù)據(jù)返回頁數(shù)
page_size	是	每頁返回數(shù)據(jù)條數(shù)
start_date	是	獲取數(shù)據(jù)的開始時間 yyyy-mm-dd
end_date	是	獲取數(shù)據(jù)的結(jié)束時間 yyyy-mm-dd

請注意： 只要與獲取數(shù)據(jù)的起止時間有重合，結(jié)算區(qū)間對應(yīng)的數(shù)據(jù)都將返回。例如，請求2月11日至3月26日的數(shù)據(jù)，將會返回2月上半月、2月下半月、3月上半月、3月下半月四個結(jié)算區(qū)間的數(shù)據(jù)。

返回參數(shù)說明（publisher_settlement）

參數(shù)	說明
err_msg	返回錯誤信息
ret	錯誤碼
body	主體名稱
revenue_all	累計收入
penalty_all	扣除金額
settled_revenue_all	已結(jié)算金額
settlement_list: date	數(shù)據(jù)更新時間
settlement_list: zone	日期區(qū)間
settlement_list: month	收入月份
settlement_list: order	1 = 上半月，2 = 下半月
settlement_list: sett_status	1 = 結(jié)算中；2、3 = 已結(jié)算；4 = 付款中；5 = 已付款
settlement_list: settled_revenue	區(qū)間內(nèi)結(jié)算收入
settlement_list: sett_no	結(jié)算單編號
settlement_list: mail_send_cnt	申請補發(fā)結(jié)算單次數(shù)
settlement_list: slot_revenue: slot_id	產(chǎn)生收入的廣告位
settlement_list: slot_revenue: slot_settled_revenue	該廣告位結(jié)算金額
total_num	請求返回總條數(shù)

返回數(shù)據(jù)包示例（publisher_settlement）

{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "body":"深圳市騰訊計算機系統(tǒng)有限公司",
    "penalty_all":0,
    "revenue_all":5178368698,
    "settled_revenue_all":2613696765,
    "settlement_list":[
        {
            "date":"2020-03-25",
            "zone":"2020年3月1日至15日"
            "month":"202003",
            "order":1,
            "sett_status":1,
            "settled_revenue":718926045,
            "sett_no":"XXX",
            "mail_send_cnt":"0",
            "slot_revenue":[
                {
                    "slot_id":"SLOT_ID_WEAPP_BANNER",
                    "slot_settled_revenue":34139443
                },
                {
                    "slot_id":"SLOT_ID_WEAPP_REWARD_VIDEO",
                    "slot_settled_revenue":684786602
                }
            ]
        }
    ],
    "total_num":1
}

錯誤碼說明

錯誤碼返回值	含義
45009	請求過于頻繁, 請稍后嘗試
45010	無效的接口名
1701	參數(shù)錯誤
2009	無效的流量主

當前文章：創(chuàng)新互聯(lián)小程序教程：微信小程序廣告·廣告分析數(shù)據(jù)接口
文章源于：http://uogjgqi.cn/article/dhihisg.html