微信小程序 廣告·廣告分析數(shù)據(jù)接口

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

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

請注意：

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，則當(dāng)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ù)使用并回傳。具體為：

接口總覽

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

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

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

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

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

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

返回數(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
}

二、獲取小程序廣告細(xì)分?jǐn)?shù)據(jù)（publisher_adunit_general）

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

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

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

返回數(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ù)：

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

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

返回數(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ù)據(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ù)據(jù)包示例（publisher_settlement）

{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "body":"深圳市騰訊計算機(jī)系統(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
}

錯誤碼說明