tencent cloud

APIs

小程序广告总览数据

聚焦模式
字号
最后更新时间: 2026-04-24 17:17:14

1. 接口描述

接口请求域名: tcsas.intl.tencentcloudapi.com 。

小程序访问分析总览

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAdvertisingOverview。
Version String 公共参数,本接口取值:2025-01-06。
Region String 公共参数,详见产品支持的 地域列表
TimeBegin String 起始时间YYYYMMDD
MNPId String 小程序id
PlatformId String 租户id
TimeEnd String 结束时间YYYYMMDD
Platform Integer // 0-所有,2 - 安卓 3 - 苹果
AdUnitType String //1-BANNER 2-REWARDED

3. 输出参数

参数名称 类型 描述
Data MNPAdvertisingOverview 数据展示
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 demo

输入示例

POST / HTTP/1.1
Host: tcsas.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAdvertisingOverview
<公共请求参数>

{
    "TimeBegin": "20251104",
    "MNPId": "mp1vd81ntbitj9k2",
    "PlatformId": "T04398WY9481762VZTT",
    "TimeEnd": "20251201",
    "Platform": 0,
    "AdUnitType": "1"
}

输出示例

{
    "Response": {
        "Data": {
            "OverviewData": {
                "ClicksNumber": 0,
                "ECPM": "2.41",
                "EstimatedEarnings": "0.01",
                "Impressions": 3,
                "RequestsNumber": 7
            }
        },
        "RequestId": "b5bc03ab-ae15-4fe3-98db-f386aa2a4ea5"
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.NoAccessPermission FailedOperation.NoAccessPermission
FailedOperation.RecordNotFound FailedOperation.RecordNotFound
FailedOperation.UserNotFound FailedOperation.UserNotFound
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter.LoginInfoNotFound MissingParameter.LoginInfoNotFound

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈