跳转至

人群包列表

通过人群包列表接口,您可以查询广告主下所有的人群包信息。

请求地址

https://openapi.aiclk.com/openapi/v1/dmp/audience/list

所属权限

dmp

请求方式

GET

请求参数

字段名 类型 是否必须 描述
account_id int 广告主ID(广告投放平台的userID)
status int 状态(0-6)
0-广告主删除 1-待处理 2-处理成功 3-未匹配 4-等待上传到OSS 5-失效 6-匹配不足
audience_id int 人群包ID
origin_type int 人群包类型,0.标签圈人1.lookalike2.组合运算3.上传文件4.系统推荐 多个逗号(,)分隔
keyword string 搜索字符
disable int 禁用/启用 0启用 1禁用
page int 分页码,默认值: 1
page_size int 分页大小,默认值: 10

请求示例

curl -X GET \
  'https://openapi.aiclk.com/openapi/v1/dmp/audience/list?account_id=1000001' \
  -H 'OGW_ACCESS_TOKEN: your_access_token'

返回字段释义

字段名 类型 描述
code int 返回码
message string 接口信息
data object 返回值,json格式,包含如下字段
- account_id object 用户ID
- audience_id object 人群包ID
- audience_name object 人群包名称
- origin_type object 人群包创建类型 0-标签圈人 1-lookalike 2-组合运算 3-上传文件 4-系统推荐
- status object 人群包状态:0-已删除 1-待处理 2-处理成功 3-未匹配 4-等待上传到COS 5-失效 6-匹配不足 7-正在处理
- create_time object 创建时间
- update_time object 更新时间
- disable object 是否启用 0-启用,1-禁用
- cover_num object 覆盖人数
- pushed object 是否已经推送到投放平台 0-未推送, 1-已推送
- frequency object 人群包更新频率

返回示例

{
    "code": 200,
    "data": {
        "list": [
            {
                "account_id": 1000001,
                "audience_id": 1000001,
                "audience_name": "audience-extend",
                "type": 1,
                "status": 1,
                "create_time": "2019-11-21 11:35:14",
                "update_time": "2019-11-21 11:35:14",
                "disable": 1,
                "cover_num": 0,
                "pushed": 0,
                "frequency": 30
            },
            ...
        ],
        "total": 926
    },
    "message": "success"
}