标签数据文件(Custom Tag)
V1.1
loading
本节将为您介绍客户标签数据文件(Custom Tag File)相关接口,更详细的介绍可以参考【标签数据】章节。
- 上传客户标签数据文件(custom_tag_files/add)
- 查询客户标签数据文件(custom_tag_files/get)
所属权限(scope):Audience Management
所属权限(scope):Audience Management
上传客户标签人群数据文件
全部接口
V1.1
loading
所属权限 | Audience Management |
请求地址 | custom_tag_files/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 中的字段。如不填写,则根据默认值进行返回 |
请求参数
标有*的参数为必填项
名称 | 类型 | 描述 |
---|---|---|
account_id*
|
integer | 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id |
user_id_type*
|
enum | 号码包用户 id 类型,[枚举详情] 枚举列表:{ HASH_IDFA, HASH_IMEI, HASH_MOBILE_PHONE, IDFA, IMEI, WX_OPENID, WX_UNIONID, WECHAT_OPENID, SALTED_HASH_IMEI, SALTED_HASH_IDFA, OAID, HASH_OAID, SHA256_MOBILE_PHONE, MD5_SHA256_IMEI, MD5_SHA256_IDFA, MD5_SHA256_OAID, CAID } |
tag_id*
|
integer | 标签 id |
file*
|
file | 上传标签人群文件,文件格式为 CSV,两列纯文本,英文逗号分隔,第一列是用户标识 id(QQ,IMEI 等);第二列是时间戳(可选填),UNIX 时间,单位到秒,格式如 1901010111 ;支持文件压缩后的 zip 包,压缩后的 zip 包不超过 100M |
operation_type
|
enum | 文件操作类型,如果不填则默认为 APPEND,[枚举详情] 枚举列表:{ APPEND, REDUCE } |
open_app_id
|
string | 微信/QQ 手机版 appid,当且仅当数据文件中的用户 id 类型为 'WECHAT_OPENID'(WX_OPENID)或 'MOBILE_QQ_OPENID' 时有效 字段长度最小 1 字节,长度最大 128 字节 |
请求示例
curl 'https://api.e.qq.com/v1.1/custom_tag_files/add?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-F 'account_id=111111111' \
-F 'user_id_type=IMEI' \
-F 'tag_id=<TAG_ID>' \
-F 'file=@/usr/local/my/tagfile.zip'
应答字段
名称 | 类型 | 描述 |
---|---|---|
custom_tag_file_id
|
integer | 数据文件 id |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"custom_tag_file_id": 10019012
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务
获取客户标签人群文件
全部接口
V1.1
loading
所属权限 | Audience Management |
请求地址 | custom_tag_files/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 |
filtering
|
struct[] | 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件] |
field*
|
string | 过滤字段 可选值:{ tag_id, custom_tag_file_id } |
operator*
|
enum | 操作符 当 field 取值 tag_id 时,枚举列表:{ EQUALS } 当 field 取值 custom_tag_file_id 时,枚举列表:{ EQUALS} |
values*
|
string[] | 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件] 当 field 取值 tag_id 时,数组的值转成整数后必须大于 0 当 field 取值 custom_tag_file_id 时,数组的值转成整数后必须大于 0 |
page
|
integer | 当前页码,默认 1 最小值 1,最大值 2147483647 |
page_size
|
integer | 分页大小,默认 10 最小值 1,最大值 100 |
请求示例
curl -G 'https://api.e.qq.com/v1.1/custom_tag_files/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=111111111' \
-d 'filtering=[
{
"values": []
}
]' \
-d 'page=1' \
-d 'page_size=10'
应答字段
名称 | 类型 | 描述 |
---|---|---|
list
|
struct[] | 返回数组列表 |
tag_id
|
integer | 标签 id |
custom_tag_file_id
|
integer | 数据文件 id |
name
|
string | 文件名称 |
user_id_type
|
enum | 号码包用户 id 类型,[枚举详情] |
operation_type
|
enum | 文件操作类型,如果不填则默认为 APPEND,[枚举详情] |
open_app_id
|
string | 微信/QQ 手机版 appid,当且仅当数据文件中的用户 id 类型为 'WECHAT_OPENID'(WX_OPENID)或 'MOBILE_QQ_OPENID' 时有效 |
process_status
|
integer | 文件状态 0:正常 |
process_code
|
integer | 处理完成后的状态码,0 表示成功,非 0 失败。 |
error_message
|
string | 错误具体信息 |
line_count
|
integer | 文件总行数 |
valid_line_count
|
integer | 文件中没有格式错误的行数 |
user_count
|
integer | 文件包含的用户数 |
created_time
|
string | 创建时间,格式为 yyyy-MM-dd HH:mm:ss,如 2016-11-01 10:42:56 |
page_info
|
struct | 分页信息 |
page
|
integer | 当前页码 |
page_size
|
integer | 分页大小 |
total_number
|
integer | 总行数 |
total_page
|
integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"tag_id": "<TAG_ID>",
"custom_tag_file_id": 10019012,
"user_id_type": "IMEI",
"created_time": 1491019858
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务