跳到主要内容

文件列表获取


请求地址​

https://api.e.qq.com/v1.3/custom_audience_files/get


请求方法​

GET


所属权限​

人群管理（Audience Management）


请求参数​

参数名描述
access_token授权令牌，完成 OAuth 2.0 授权后获得，参考开发者环境
timestamp当前的时间戳，单位为秒，允许客户端请求最大时间误差为 300 秒。MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳签名算法。MarketingAPI 所使用的时区为 GMT+8，例如当时间戳为 1494840119 时，表示 2017-05-15 17:21:59
nonce随机字串标识，不超过 32 个字符，由调用方自行生成，需保证全局唯一性
fieldsget 接口增加 fields 字段，用于指定返回参数的字段列表，为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写，则根据默认值进行返回

请求体类型​

multipart/form-data


请求体参数​

阅读说明：Y - 必填；C - 条件选填（conditional），请关注“描述”信息；空 - 非必填

名称类型必填描述
account_idintegerY
推广帐号 id或 DataNexus 账号 id
audience_idinteger
人群 id，通过 [custom_audiences] 模块创建客户人群获得
custom_audience_file_idinteger
数据文件 id，通过 [custom_audience_files] 模块上传客户人群数据文件获得
pageinteger
当前页码，默认 1, 最小值 1，最大值 2147483647
page_sizeinteger
分页大小，默认 10，最小值 1，最大值 100

请求体示例​

curl -G 'https://api.e.qq.com/v1.1/custom_audience_files/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'audience_id=<AUDIENCE_ID>' \
-d 'custom_audience_file_id=<CUSTOM_AUDIENCE_FILE_ID>' \
-d 'page=1' \
-d 'page_size=10'

应答体结构​

名称类型描述
listarray
文件列表
audience_idinteger
人群 id
custom_audience_file_idinteger
数据文件 id
namestring
文件名称
user_id_typeenum
号码包类型，见 枚举值
operation_typeenum
文件操作类型，如果不填则默认为 APPEND，见 枚举值
open_app_idstring
微信/QQ 手机版 appid，当且仅当数据文件中的用户 id 类型为 'WECHAT_OPENID'（WX_OPENID）或 'MOBILE_QQ_OPENID' 时有效
process_statusenum
文件处理状态，见 枚举值
process_codeinteger
处理完成后的状态码，0 表示成功，非 0 失败
error_messagestring
错误具体信息
line_countinteger
文件总行数
valid_line_countinteger
文件中没有格式错误的行数
user_countinteger
文件包含的用户数
sizeinteger
文件大小
create_timestring
创建时间，格式为 yyyy-MM-dd HH:mm:ss，如 2016-11-01 10:42:56
page_infoobject
分页信息
pageinteger
当前页码
page_sizeinteger
一页显示的数据条数，默认值：10，最小值 1，最大值 100
total_numberinteger
总条数
total_pageinteger
总页数

应答体示例​

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "audience_id": "<AUDIENCE_ID>",
                "custom_audience_file_id": "<CUSTOM_AUDIENCE_FILE_ID>",
                "name": "设备人群包",
                "user_id_type": "HASH_IMEI",
                "operation_type": "APPEND",
                "open_app_id": "",
                "process_status": "PENDING",
                "process_code": 0,
                "error_message": "",
                "user_count": 100,
                "valid_line_count": 100,
                "line_count": 120,
                "created_time": "2017-01-12 19:20:36"
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}


filtering 结构​

当且仅当接口文档中有filtering参数时，接口才支持过滤逻辑； 过滤条件中，支持包含同一字段多个不同运算并存，不支持同一字段多个相同运算符并存，当出现此条件时的处理为后一参数覆盖前一参数； 多个条件结构间的运算逻辑为”and”； 每个结构包含3个必填节点：field（字段名）、operator （操作符）、values（取值）； values（取值）的数组长度与operator的取值有关，其对应关系如下： 当 operator 为 EQUALS、CONTAINS、LESS_EQUALS、LESS、GREATER_EQUALS、GREATER 时，values数组长度为1； 当 operator 为 IN 时，values数组长度为100

filtering=[{"field":"system_status", "operator": "EQUALS", "values":["AD_STATUS_PENDING"]}, {"field":"adgroup_name", "operator": "CONTAINS", "values": ["广告"]}]



该内容是否有帮助？