接口文档SDK业务专题开发者工具

获取异步报表任务
全部接口
V1.1
loading

所属权限 Ads Insight
请求地址 async_reports/get
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考，代码案例参考。

参数名称 参数类型
access_token 授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节
timestamp

当前的时间戳，单位为秒，允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8，例如当时间戳为 1494840119 时，表示 2017-05-15 17:21:59
nonce 随机字串标识，不超过 32 个字符，由调用方自行生成，需保证全局唯一性
fields get 接口增加 fields 字段，用于指定返回参数的字段列表，为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写，则根据默认值进行返回

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
 integer 广告主帐号 id，有操作权限的帐号 id，不支持代理商 id
filtering
 struct[] 过滤条件，若此字段不传，或传空则视为无限制条件，详见 [过滤条件]
数组最小长度 1，最大长度 10
field*
 string 过滤字段
可选值：{ task_id, task_type, task_name, created_time, result_status, status, cron_status }
operator*
 enum 操作符
当 field 取值 task_id 时，枚举列表：{ EQUALS, IN }
当 field 取值 task_type 时，枚举列表：{ EQUALS, IN }
当 field 取值 task_name 时，枚举列表：{ EQUALS, CONTAINS }
当 field 取值 created_time 时，枚举列表：{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER }
当 field 取值 result_status 时，枚举列表：{ EQUALS, IN }
当 field 取值 status 时，枚举列表：{ EQUALS, IN }
当 field 取值 cron_status 时，枚举列表：{ EQUALS, IN }
values*
 string[] 字段取值

当 field 取值 task_type 时，
枚举列表：{ }

当 field 取值 task_type 且 operator 取值 IN 时，
枚举列表：{ }

当 field 取值 task_name 时，
字段长度最小 1 字节，长度最大 120 字节

当 field 取值 created_time 时，
字段长度为 10 字节

当 field 取值 result_status 时，
枚举列表：{ TASK_RESULT_STATUS_UNKNOWN, TASK_RESULT_STATUS_PENDING, TASK_RESULT_STATUS_PROCESSING, TASK_RESULT_STATUS_SUCCESS, TASK_RESULT_STATUS_FAIL, TASK_RESULT_STATUS_PARTIAL_FAIL, TASK_RESULT_STATUS_SYSTEM_ERROR, TASK_RESULT_STATUS_DELETED }

当 field 取值 result_status 且 operator 取值 IN 时，
枚举列表：{ TASK_RESULT_STATUS_UNKNOWN, TASK_RESULT_STATUS_PENDING, TASK_RESULT_STATUS_PROCESSING, TASK_RESULT_STATUS_SUCCESS, TASK_RESULT_STATUS_FAIL, TASK_RESULT_STATUS_PARTIAL_FAIL, TASK_RESULT_STATUS_SYSTEM_ERROR, TASK_RESULT_STATUS_DELETED }

当 field 取值 status 时，
枚举列表：{ TASK_STATUS_PENDING, TASK_STATUS_PROCESSING, TASK_STATUS_EXPIRED, TASK_STATUS_COMPLETED, TASK_STATUS_FAIL, TASK_STATUS_DELETED, TASK_STATUS_DRAFT }

当 field 取值 status 且 operator 取值 IN 时，
枚举列表：{ TASK_STATUS_PENDING, TASK_STATUS_PROCESSING, TASK_STATUS_EXPIRED, TASK_STATUS_COMPLETED, TASK_STATUS_FAIL, TASK_STATUS_DELETED, TASK_STATUS_DRAFT }

当 field 取值 cron_status 时，
枚举列表：{ CRON_STATUS_ON, CRON_STATUS_OFF, CRON_STATUS_DELETE }

当 field 取值 cron_status 且 operator 取值 IN 时，
枚举列表：{ CRON_STATUS_ON, CRON_STATUS_OFF, CRON_STATUS_DELETE }
page
 integer 搜索页码，默认值：1
最小值 1，最大值 99999
page_size
 integer 一页显示的数据条数，默认值：10
最小值 1，最大值 100

使用说明

  1. 异步任务获取接口支持 7 日内任务记录的查询，单生成任务文件下载有效期为 24 小时。

请求示例


curl 'https://api.e.qq.com/v1.1/async_reports/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"task_id","operator":"EQUALS","values":["1024"]}]' \
-d 'page=1' \
-d 'page_size=10'

应答字段

名称 类型 描述
list
 struct[] 返回信息列表
task_id
 integer 任务 id
task_name
 string 任务名称
status
 enum 任务状态，[枚举详情]
created_time
 integer 任务创建时间戳（Unix 时间戳，单位为秒），大于等于 0
result
 struct 任务结果
code
 integer 返回码，正常返回 0，异常返回大于 0
message
 string 返回消息
data
 struct 任务结果
file_info_list
 struct[] 文件返回结果列表
file_id
 integer 文件 id
md5
 string 文件 md5
page_info
 struct 分页配置信息
page
 integer 搜索页码
page_size
 integer 一页显示的数据条数
total_number
 integer 总条数
total_page
 integer 总页数

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "task_id": 1024,
                "task_name": "test_task_name",
                "status": "TASK_STATUS_COMPLETED",
                "created_time": 1403243242,
                "result": {
                    "code": 0,
                    "message": "",
                    "data": {
                        "file_info_list": [
                            {
                                "file_id": 5,
                                "md5": "79054025255fb1a26e4bc422aef54eb4"
                            }
                        ]
                    }
                }
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}

可视化调试工具

相关阅读

异步报表

广告资源

广告技术

开发文档

辅助工具

帮助支持

手机浏览开发者官网

Copyright © 1998 - Tencent Inc. All Rights Reserved.