获取定向
全部接口
V1.1
loading
V1.1
loading
所属权限 | Ads Management,Ads Insights |
请求地址 | targetings/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[] | 过滤条件,若此字段不传,或传空则视为无限制条件,详见 [过滤条件] 数组最小长度 1,最大长度 2 |
field*
|
string | 过滤字段 可选值:{ targeting_id, targeting_name, created_time, last_modified_time, targeting_source_type, share_from_account_id, share_from_targeting_id } |
operator*
|
enum | 操作符 当 field 取值 targeting_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 targeting_name 时,枚举列表:{ EQUALS, CONTAINS } 当 field 取值 created_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER } 当 field 取值 last_modified_time 时,枚举列表:{ EQUALS, LESS_EQUALS, LESS, GREATER_EQUALS, GREATER } 当 field 取值 targeting_source_type 时,枚举列表:{ EQUALS } 当 field 取值 share_from_account_id 时,枚举列表:{ EQUALS, IN } 当 field 取值 share_from_targeting_id 时,枚举列表:{ EQUALS, IN } |
values*
|
string[] | 字段取值,values 数组的个数限制与 operator 的取值相关,详见 [过滤条件] 当 field 取值 targeting_name 时, 字段长度最小 1 字节,长度最大 120 字节 当 field 取值 created_time 时, 字段长度为 10 字节 当 field 取值 last_modified_time 时, 字段长度为 10 字节 当 field 取值 targeting_source_type 时, 枚举列表:{ TARGETING_SOURCE_TYPE_CREATE, TARGETING_SOURCE_TYPE_SHARE } |
page
|
integer | 搜索页码,默认值:1 最小值 1,最大值 99999 |
page_size
|
integer | 一页显示的数据条数,默认值:10。最小值 1,最大值 100 |
使用说明
- 当且仅当根据定向 id 进行查询时,获取的定向列表包含已删除的定向。
- v1.0 创建并使用的 targeting 已迁移到 adgroup 信息中,v1.1 的 targeting 模块不支持 v1.0 创建定向包的读写。
请求示例
curl -G 'https://api.e.qq.com/v1.1/targetings/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'filtering=[{"field":"targeting_name","operator":"EQUALS","values":["定向"]}]' \
-d 'page=1' \
-d 'page_size=10'
应答字段
名称 | 类型 | 描述 |
---|---|---|
list
|
struct[] | 返回信息列表 |
targeting_id
|
int64 | 定向 id |
targeting_name
|
string | 定向名称,同一帐号下的定向名称不允许重复 |
targeting
|
struct | 定向详细设置,存放所有定向条件 |
age
|
struct[] | 年龄定向(仅支持单年龄段,范围为 14~66,66 代表的是 66 岁及 66 岁以上,如 18~66 代表大于等于 18 岁) |
min
|
integer | 年龄最小值限制,(其中 15、16、17 不可以使用) |
max
|
integer | 年龄最大值限制 |
gender
|
enum[] | 性别定向(仅单选),[枚举详情] |
education
|
enum[] | 用户学历,[枚举详情],该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营 |
marital_status
|
enum[] | 婚恋育儿状态,[枚举详情],该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营 |
working_status
|
enum[] | 工作状态,[枚举详情] |
geo_location
|
struct | 地理位置定向, 针对朋友圈广告(campaign_type=CAMPAIGN_TYPE_WECHAT_MOMENTS)地域必填,非朋友圈广告选填 如使用地域定向"regions"、"business_districts"、"custom_locations" 不能同时为空 |
location_types
|
enum[] | 地点类型,[枚举详情],选择限制: |
regions
|
integer[] | 省市区县列表,当投放微信流量(site_set=SITE_SET_WECHAT、SITE_SET_MOMENTS、SITE_SET_MINI_GAME_WECHAT)时,仅支持中国大陆(不包含港澳台)地域 id,可通过 [targeting_tags/get] 接口获取 |
business_districts
|
integer[] | 商圈 id 列表,可通过 [targeting_tags/get] 接口获取 |
custom_locations
|
struct[] | 自定义地理位置列表,使用火星系坐标,当广告类型为朋友圈广告时(campaign_type=CAMPAIGN_TYPE_WECHAT_MOMENTS),custom_locations 的数组长度限制为最小长度 1。 |
longitude
|
float | 经度,单位度 |
latitude
|
float | 纬度,单位度 |
radius
|
integer | 半径,单位米 |
user_os
|
enum[] | 操作系统定向, 当 promoted_object_type=PROMOTED_OBJECT_TYPE_APP_ANDROID、PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION、PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP 时,广告只会在 Android 操作系统上展示;当 promoted_object_type=PROMOTED_OBJECT_TYPE_APP_IOS 时,广告只会在 iOS 操作系统上展示,[枚举详情] |
new_device
|
enum[] | 新设备,最近三个月第一次使用该设备的用户,[枚举详情] |
device_price
|
enum[] | 设备价格定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情] |
device_brand_model
|
struct | 设备品牌型号定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营 |
included_list
|
integer[] | 设备品牌型号定向,可通过 [targeting_tags/get] 接口获取 |
excluded_list
|
integer[] | 排除设备品牌型号列表,不能与 included_list 同时使用,可通过 [targeting_tags/get] 接口获取 |
network_type
|
enum[] | 联网方式定向,[枚举详情] |
network_operator
|
enum[] | 移动运营商定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情] |
network_scene
|
enum[] | 上网场景,[枚举详情] |
dressing_index
|
enum[] | 穿衣指数,[枚举详情] |
uv_index
|
enum[] | 紫外线指数,[枚举详情] |
makeup_index
|
enum[] | 化妆指数,[枚举详情] |
climate
|
enum[] | 气象,[枚举详情] |
temperature
|
struct[] | 温度(仅单温度段,以绝对零度值(-273)表示 0 度,依次增加,例如 223~323 表示-50 度到 50 度。数字与“~”之间不允许存在空格) |
min
|
integer | 温度最小值限制 |
max
|
integer | 温度最大值限制 |
air_quality_index
|
enum[] | 空气质量指数,[枚举详情] |
app_install_status
|
enum[] | 应用安装(应用用户),当且仅当 promoted_object_type 为 PROMOTED_OBJECT_TYPE_APP_ANDROID、PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP、PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION 时使用,[枚举详情] |
consumption_status
|
enum[] | 消费水平,[枚举详情],该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营 |
game_consumption_level
|
enum[] | 游戏消费能力,原 gamer_consumption_ability 定向升级版,gamer_consumption_ability 和 game_consumption_level 不能同时使用.,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情] |
residential_community_price
|
struct[] | 居住社区价格(仅支持单价格段,范围为:1~100000,单位是“元/m ²”) |
min
|
integer | 居住社区价格最小值限制,可填写的值为 1,1000,2000,3000,4000,5000,6000,7000,8000,9000,10000,20000,30000,40000,50000,60000,70000,80000,90000,100000 |
max
|
integer | 居住社区价格最大值限制,可填写的值为 1000,2000,3000,4000,5000,6000,7000,8000,9000,10000,20000,30000,40000,50000,60000,70000,80000,90000,100000,999999999,最大值 999999999 代表 10 万以上 |
financial_situation
|
enum[] | 财产状态,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情] |
consumption_type
|
enum[] | 消费类型定向,[枚举详情] |
wechat_ad_behavior
|
struct | 微信再营销,原微信广告行为定向升级为微信再营销,当且仅当投放微信流量(site_set=SITE_SET_WECHAT、SITE_SET_MOMENTS)时有效 |
actions
|
enum[] | 包含的行为列表,多个行为之间为并集(or)的关系 数组最小长度 0,最大长度 10 QQ 账号支持枚举列表:{WECHAT_OFFICIAL_ACCOUNT_AD_LIKE,WECHAT_MOMENTS_AD_LIKE,MINI_GAME_WECHAT_REGISTERED },[枚举详情] |
excluded_actions
|
enum[] | 排除的行为列表,多个行为之间为并集(or)的关系 数组最小长度 0,最大长度 10 QQ 账号支持枚举列表:{WECHAT_OFFICIAL_ACCOUNT_AD_LIKE,WECHAT_MOMENTS_AD_LIKE,MINI_GAME_WECHAT_REGISTERED },[枚举详情] |
custom_audience
|
integer[] | 自定义定向用户群,通过 [人群管理模块] 创建的人群 id,custom_audience 和 excluded_custom_audience 个数之和不能超过 200 个,如果有组合人群,则组合人群包数不能超过 50。 2022 年 6 月 30 日起,竞价 oCPC、oCPM 场景内,仅能使用“一方人群”的人群包,人群详情可参考[人群管理模块]。 |
excluded_custom_audience
|
integer[] | 自定义排除用户群,通过 [人群管理模块] 创建的人群 id,custom_audience 和 excluded_custom_audience 个数之和不能超过 200 个,如果有组合人群,则组合人群包数不能超过 50。 2022 年 6 月 30 日起,竞价 oCPC、oCPM 场景内,仅能使用“一方人群”的人群包,人群详情可参考[人群管理模块]。 |
behavior_or_interest
|
struct | 行为兴趣意向定向,2022 年 6 月 30 日起,该定向将无法在竞价 oCPC、oCPM 场景使用。 |
interest
|
struct | 行为兴趣意向定向的兴趣部分 |
targeting_tags
|
string[] | 兴趣标签列表(待废弃,后续仅支持 category_id_list、keyword_list) |
category_id_list
|
integer[] | 兴趣标签 id 列表,和关键词列表 keyword_list 个数之和不能大于 250,通过[targeting_tags/get]可获取兴趣标签列表 id 和对应标签名称 |
keyword_list
|
string[] | 兴趣关键词列表,和兴趣标签 id 列表 category_id_list 个数之和不能大于 250,通过[targeting_tags/get]可获取兴趣关键词列表 |
behavior
|
struct[] | 行为兴趣意向定向的行为部分,targeting_tags、category_id_list、keyword_list 三个结构不能同时为空 |
targeting_tags
|
string[] | 行为标签列表(待废弃,后续仅支持 category_id_list、keyword_list) |
category_id_list
|
integer[] | 行为标签 id 列表,和关键词列表 keyword_list 个数之和不能大于 250,通过[targeting_tags/get]可获取行为标签列表 id 和对应标签名称 |
keyword_list
|
string[] | 行为关键词列表,和行为标签 id 列表 category_id_list 个数之和不能大于 250,通过[targeting_tags/get]可获取行为关键词列表 |
scene
|
enum[] | 行为兴趣意向定向的行为部分的场景,[枚举详情] |
time_window
|
enum | 行为兴趣意向定向的行为部分的时间窗,[枚举详情] |
intensity
|
enum[] | 行为兴趣意向定向的行为部分的强度,[枚举详情] |
intention
|
struct | 行为兴趣意向定向的意向部分 |
targeting_tags
|
integer[] | 意向标签列表 |
wechat_official_account_category
|
integer[] | 微信流量类型定向,当且仅当投放微信版位(SITE_SET_WECHAT)且非朋友圈广告(campaign_type != CAMPAIGN_TYPE_WECHAT_MOMENTS)时可以使用,通过[targeting_tags/get]可获取微信流量类型 |
mobile_union_category
|
integer[] | 移动媒体类型定向,当且仅当投放移动联盟流量时(site_set = SITE_SET_MOBILE_UNION)时可以使用。(字段待废弃,2021 年 10 月 29 日后不支持新建和更新) |
business_interest
|
integer[] | 商业兴趣定向,通过 [targeting_tags/get] 接口获取 |
keyword
|
struct | 关键词定向 |
words
|
string[] | 关键词 |
app_behavior
|
struct | app 行为定向 |
object_type
|
enum | 行为对象的类型,仅支持 APP 类目,[枚举详情] |
object_id_list
|
integer[] | 行为对象的 id,当 object_type = APP_CLASS 时,表示类目 id,类目 id 需填写最细一级 id |
time_window
|
integer | 行为对象的有效期,单位天 |
act_id_list
|
enum[] | app 行为对象的行为,[枚举详情] |
paid_user
|
enum[] | 付费用户,[枚举详情] |
deprecated_custom_audience
|
integer[] | 自定义人群,通过 [人群管理模块] 创建的人群 id,不支持人群类型为 COMBINE 的人群 id |
deprecated_excluded_custom_audience
|
integer[] | 排他人群,通过 [人群管理模块] 创建的人群 id,不支持人群类型为 COMBINE 的人群 id |
deprecated_region
|
integer[] | 地域定向,可通过 [targeting_tags/get] 接口获取 |
excluded_converted_audience
|
struct | 排除已转化用户定向 |
excluded_dimension
|
enum | 排除已转化用户定向范围 同应用,仅当推广目标为应用下载时可以使用,没有选择自定义转化行为(excluded_dimension)时,使用该定向出价需要满足是 oCPC、oCPM 广告; 同商品,仅当 SDPA 商品广告下使用,不支持自定义转化行为默认排除已下单、和已付费用户,不限制出价方式; 非同应用、非同商品,没有选择自定义转化行为(excluded_dimension)时,使用该定向出价需要满足是 oCPC、oCPM 广告;,[枚举详情] |
conversion_behavior_list
|
enum[] | 自定义转化行为,没有选择自定义转化行为(excluded_dimension)时,使用该定向需要校验是 oCPC、oCPM 广告 |
is_include_unsupported_targeting
|
boolean | 是否包含不支持定向,true:包含 API 暂不支持读写的定向信息,false:不包含 API 暂不支持读写的定向信息 |
description
|
string | 定向描述 |
is_deleted
|
boolean | 是否已删除,true:是,false:否 |
created_time
|
integer | 创建时间(时间戳) |
last_modified_time
|
integer | 最后修改时间(时间戳) |
targeting_translation
|
string | 已选择定向条件的描述 |
targeting_source_type
|
enum | 定向包来源,自建或者来自分享,[枚举详情] 默认值:自建 |
share_from_account_id
|
integer | 分享的源账户 id 默认值:分享的源账户 id |
share_from_targeting_id
|
integer | 分享的源定向 id 默认值:分享的源定向 id |
page_info
|
struct | 分页配置信息 |
page
|
integer | 搜索页码 |
page_size
|
integer | 一页显示的数据条数 |
total_number
|
integer | 总条数 |
total_page
|
integer | 总页数 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"targeting_id": "<TARGETING_ID>",
"targeting_name": "定向",
"targeting": {
"gender": [
"MALE"
],
"age": [
{
"min": 18,
"max": 30
}
],
"geo_location": {
"regions": [
110000,
310000
],
"location_types": [
"LIVE_IN"
]
}
},
"description": "description",
"is_deleted": false,
"created_time": 1491019858,
"last_modified_time": 1491098468
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务