入门与指南专题介绍帐号管理营销资产广告管理数据洞察人群管理数据接入接口清单
授权认证 帐号管理 营销资产 广告管理 数据洞察 辅助工具 用户行为数据 用户人群数据 用户标签数据 用户属性数据
附录

客户标签 (Custom Tag)

V1.1

loading


本节将为您介绍客户标签(Custom Tag)相关接口,更详细的介绍可以参考【标签数据】章节。


创建客户标签

custom_tags/add

POST

*为必填项
名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
parent_tag_id
integer 父节点 id,不传,则默认为 0,表示该标签为根节点标签
name*
string 标签名称,标签树在同一父节点下的标签名称不能重复
字段长度最小 1 字节,长度最大 32 字节
description
string 标签描述
字段长度最小 1 字节,长度最大 100 字节
tag_code
string 广告主对标签在自己系统里的编码,只能包含数字或字母或下划线;如果该编码创建过标签,再次用该编码创建标签时,会返回之前用该编码创建的标签 id ;标签编码不能与人群编码(outer_audience_id)重复
字段长度最小 1 字节,长度最大 128 字节
platform
enum 数据应用,不填写默认为 DMP,[枚举详情]
枚举列表:{ DMP, TDC, TDP }

curl 'https://api.e.qq.com/v1.1/custom_tags/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-H 'Content-Type: application/json' \
-d '{
    "account_id": "<ACCOUNT_ID>",
    "name": "car",
    "description": "car"
}'
					
名称 类型 描述
tag_id
integer 标签 id
{
    "code": 0,
    "message": "",
    "message_ch": "",
    "data": {
        "tag_id": "<TAG_ID>"
    }
}


获取客户标签

custom_tags/get

GET

*为必填项
名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
parent_tag_id
integer 父节点 id,parent_tag_id,tag_code,tag_id 只能有一个存在
tag_id
integer 标签 id,parent_tag_id,tag_code,tag_id 只能有一个存在
tag_code
string 广告主对标签在自己系统里的编码,parent_tag_id,tag_code,tag_id 只能有一个存在
字段长度最小 1 字节,长度最大 128 字节
platform
enum 数据应用,不填写默认为 DMP,[枚举详情]
枚举列表:{ DMP, TDC, TDP }
page
integer 当前页码,默认 1
最小值 1,最大值 2147483647
page_size
integer 分页大小,默认 10
最小值 1,最大值 100

curl -G 'https://api.e.qq.com/v1.1/custom_tags/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'tag_id=<TAG_ID>' \
-d 'page=1' \
-d 'page_size=10' 
					
名称 类型 描述
list
struct[] 返回数组列表
tag_id
integer 标签 id
parent_tag_id
integer 父节点 id
name
string 标签名称,标签树在同一父节点下的标签名称不能重复
description
string 标签描述
tag_code
string 广告主对标签在自己系统里的编码
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_ch": "",
    "data": {
        "list": [
            {
                "tag_id": 1001911,
                "parent_tag_id": 0,
                "name": "car",
                "description": "car",
                "tag_code": "car_test",
                "created_time": "2017-12-01 10:42:56",
                "user_count": 100
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}


更新客户标签

custom_tags/update

POST

*为必填项
名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
tag_id*
integer 标签 id
name
string name 和 description 至少填写一项
字段长度最小 1 字节,长度最大 32 字节
description
string name 和 description 至少填写一项
字段长度最小 1 字节,长度最大 100 字节

curl 'https://api.e.qq.com/v1.1/custom_tags/update?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'tag_id=<TAG_ID>' \
-d 'name=car' \
-d 'description=car' 
					
{
    "code": 0,
    "message": "",
    "message_ch": ""
}


删除客户标签

custom_tags/delete

POST

*为必填项
名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
tag_id*
integer 标签 id

curl 'https://api.e.qq.com/v1.1/custom_tags/delete?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'tag_id=<TAG_ID>' 
					
{
    "code": 0,
    "message": "",
    "message_ch": ""
}