小程序广告数据接口获取文档

更新时间：2024-06-19 17:20:52

简介

小程序开发者可以通过广告数据查询接口查询小程序的曝光量、点击量、点击率、收入等数据。

接口地址

POST https://open.kuaishou.com/openapi/mp/developer/ad/data/query (opens new window)

请求示例

curl --location 'https://open.kuaishou.com/openapi/mp/developer/ad/data/query?app_id=ks2112***&access_token=*****' \
--header 'Content-Type: application/json' \
--data '{
    "startTime":1704038400000,
    "endTime":1704643199999,
    "type":0,
    "page":3,
    "pageSize":10
}'

接口定义

请求参数

值	类型	位置	含义	是否必须
access_token	string	放到 query param, 即url后面	接口调用凭证	是
app_id	string	放到 query param, 即url后面	小程序 appId	是
请求数据	string	放到请求 body 中	json格式的请求参数	是
以下是参数含义
startTime	long	body里	时间范围--开始时间戳	是
endTime	long	body里	时间范围--结束时间戳	是
type	int	body里	0：汇总 1：信息流效果 5：激励视频	是
page	int	body里	页码，从1开始	是
pageSize	int	body里	页的大小	是

body参数实例：

{
    "startTime":1704038400000,
    "endTime":1704643199999,
    "type":0,
    "page":3,
    "pageSize":10
}

请求响应

请求参数

值	类型	含义
result	int	结果码：1表示请求成功；其他非成功
error_msg	string	表示错误的原因
data	json object	表示返回的数据
items	json list	表示返回的条目，每天一条
以下是每一项数据里字段的含义
type	int	参考请求里的type
data	string	日期
queryCnt	long	拉取量
impression	long	曝光量
impressionRadio	double	曝光率
click	long	点击次数
clickRadio	double	点击率
ecpm	double	千次收入
costTotal	double	收入

请求响应示例:

{
    "result": 1,
    "error_msg": "success",
    "data": {
        "items": [
            {
                "type": 0,
                "date": "2024-01-07",
                "queryCnt": 2,
                "impression": 0,
                "impressionRadio": 0.0,
                "click": 0,
                "clickRadio": 0.0,
                "ecpm": 0.0,
                "costTotal": 0.07
            },
            {
                "type": 0,
                "date": "2024-01-06",
                "queryCnt": 100,
                "impression": 20,
                "impressionRadio": 0.0,
                "click": 0,
                "clickRadio": 0.0,
                "ecpm": 0.0,
                "costTotal": 0.07
            }
        ],
        "total": 7
    }
}