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

广告状态获取 (System Status)

V1.1

loading

本节将为您介绍广告状态 (system status) 相关接口。该接口支持查询一些特殊的系统状态。目前此接口暂时仅支持查询oCPA广告的学习状态。

所属权限(scope):Ads Management


获取广告组系统状态信息
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 system_status/get
请求方法 get

全局参数

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

参数名称 参数类型
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
status_type*
enum 状态类型,[枚举详情]
枚举列表:{ STATUS_TYPE_OCPA_LEARNING }
status_spec*
struct 获取系统状态所需条件
ocpa_learning_spec
struct 获取学习状态所需条件,当 status_type 为 STATUS_TYPE_OCPA_LEARNING 时,ocpa_learning_spec 必填
adgroup_id_list*
integer[] 广告组 id 列表,如[2001,2002,2003,2004]
数组最小长度 0,最大长度 10
最小值 0,最大值 9200000000000000000

使用说明

  1. 此接口暂不支持查询微信及应用宝广告组的学习状态(即 site_set !=SITE_SET_MOBILE_MYAPP 或 SITE_SET_WECHAT)。

请求示例


curl -G 'https://api.e.qq.com/v1.1/system_status/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'status_spec={"ocpa_learning_spec":{"adgroup_id_list":[1234]}}' 
					

应答字段

名称 类型 描述
list
struct[] 返回信息列表
adgroup_id
int64 广告组 id
learning_status
enum 学习状态,[枚举详情]

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "adgroup_id": 111111111,
                "learning_status": "LEARNING_STATUS_PROCESSING"
            }
        ]
    }
}

可视化调试工具