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

创建批量请求
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 batch_requests/add
请求方法 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 中的字段。如不填写,则根据默认值进行返回

请求参数

标有*的参数为必填项

名称 类型 描述
batch_request_spec*
struct[] 批量调用接口任务所需条件
数组最大长度 100
relative_path*
string 相对接口请求路径; POST 请求不带参数,形如:v1.2/campaigns/update ; GET 请求带参数,形如:v1.2/campaigns/get?account_id=12345
字段长度最小 1 字节,长度最大 40960 字节
body
string POST 原始请求时的正文,暂时不支持 JSON 编码的字符串
字段长度最小 1 字节,长度最大 40960 字节

使用说明

  1. 目前可以创建批量请求的接口: campaigns/add, campaigns/update, campaigns/get, campaigns/delete, adgroups/add, adgroups/update, adgroups/get, adgroups/delete, advertiser/add, advertiser/get, advertiser/update。
  2. list 参数里返回的响应顺序和 batch_request_spec 中请求参数的顺序一致。

请求示例


curl 'https://api.e.qq.com/v1.1/batch_requests/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'batch_request_spec=[{"relative_path":"v1.2/campaigns/update","body":"account_id=<ACCOUNT_ID>&campaign_id=123&campaign_name=testcampaignname"},{"relative_path":"v1.2/campaigns/get?account_id=<ACCOUNT_ID>&fields=%5b%22campaign_name%22%2c%22campaign_id%22%5d"}]' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
http_code
integer http 返回码,正常返回 200
headers
struct[] http header
name
string 单个 header 名
value
string 单个 header 值
body
string 返回的正文数据,是 JSON 编码的字符串

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "http_code": 200,
                "headers": [
                    {
                        "name": "X-TSA-Trace-Id",
                        "value": "94eff22c95ede3a34b942ae041bf2db6"
                    },
                    {
                        "name": "X-RateLimit-Remaining",
                        "value": "50%,50%"
                    }
                ],
                "body": "{\"code\": 0, \"message\":\"\", \"message_cn\":\"\", \"data\": {\"campaign_id\":123}}"
            },
            {
                "http_code": 200,
                "headers": [
                    {
                        "name": "X-TSA-Trace-Id",
                        "value": "94eff22c95ede3a34b942ae041bf2db6"
                    },
                    {
                        "name": "X-RateLimit-Remaining",
                        "value": "60%,60%"
                    }
                ],
                "body": "{\"code\": 0, \"message\":\"\", \"message_cn\":\"\", \"data\": {\"list\":{\"campaign_id\": 123, \"campaign_name\": \"testcampaignname\"},\"page_info\":{\"page\": 1,\"page_size\": 10, \"total_number\": 1, \"total_page\": 1}}}"
            }
        ]
    }
}

可视化调试工具