跳转至

获取广告主账户列表

获取广告主账户列表,支持代理商、子代理授权模式下查询。

请求地址

https://openapi.aiclk.com/openapi/v1/agent/info

所属权限

ads_read

请求方式

GET

请求参数

字段名 类型 是否必须 描述
account_id int 代理商、子代理ID(广告投放平台的userID)
query string 请求参数结构,具体字段如下

query参数

字段名 类型 是否必须 描述
account_id array 广告账户ID,示例:[11111,22222],不填时获取该代理下全部账户信息
configure_status array 广告账户状态:
停用-DELETE,审核中-PENDING,审核通过-PASSED ,审核不通过-FAILED ,不填时默认获取非停用的其余状态的账户信息,示例:["DELETE","FAILED"]
fields array 需要的返回字段,允许值:"account_id","username","display_name","balance","coupon"
page int 页数,默认为1
page_size int 页面大小,默认为10,不大于500

query示例

{
       "fields": [
           "account_id",
           "username",
           "balance"
       ]
}

请求示例

 curl -X GET \
  'https://openapi.aiclk.com/openapi/v1/agent/info?account_id=1000002&query={"account_id":[1000006,1000005],"configure_status":[""],"fields":["account_id","username","display_name","balance","coupon"]}' \
  -H 'Host: openapi.aiclk.com' \
  -H 'OGW_ACCESS_TOKEN: your_access_token'

返回字段释义

字段名 类型 描述
code int 返回码
message string 返回信息
data json 返回值,json格式,包含字段如下
- list json 返回值,json格式,列表
-- account_id int 广告主ID
-- acc_type string 账号类型:
广告主-COMMON,子代理-SUB_AGENT
-- username string 登录名称
-- display_name string 广告主名称
-- balance int 余额,单位:分
-- coupon int 优惠券,单位:分
-- configure_status string 状态:
停用-DELETE,审核中-PENDING,审核通过-PASSED ,审核不通过-FAILED
- page_info json 分页信息
-- page int 页数
-- page_size int 页面大小
-- total_number int 总数

返回示例

{
  "code": 200,
  "data": {
    "list": [
      {
        "acc_type": "COMMON",
        "account_id": 123235433,
        "username": "登录名称",
        "display_name": "广告主名称",
        "balance": 10000032,
        "coupon": 1000022,
        "configure_status": "FAILED"
      }
    ],
    "page_info": {
      "page": 1,
      "page_size": 10,
      "total_number": 1
    }
  },
  "message": "success",
  "trace_id": "369021054540e66a"
}