接口文档SDK业务专题开发者工具

创建定向
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 targetings/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 中的字段。如不填写,则根据默认值进行返回

特定请求头参数

该接口支持一些特定请求头的参数,该参数支持放入请求的请求头中,注意不是请求体中。

请求头名称 描述
X-Request-Id 资源请求的唯一 id,该请求头参数用于保证接口重试的幂等性,即当请求参数是 A 时,X-Request-Id 为 B 时,即使重复请求,API 侧永远不会新建一个全新的广告资源,避免重试的时候重复创建。如果在创建时重复传入相同的请求参数和 X-Request-Id,那么会返回该 X-Request-Id 对应的唯一的广告资源。支持的接口列表参考投放接口错误处理指引章节

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
integer 广告主帐号 id,有操作权限的帐号 id,不支持代理商 id
targeting_name*
string 定向名称,同一帐号下的定向名称不允许重复
字段长度最小 1 字节,长度最大 150 字节
targeting
struct 定向详细设置,存放所有定向条件
age
struct[] 年龄定向(仅支持单年龄段,范围为 14~66,66 代表的是 66 岁及 66 岁以上,如 18~66 代表大于等于 18 岁)
数组最小长度 1,最大长度 5
min*
integer 年龄最小值限制,(其中 15、16、17 不可以使用)
最小值 14,最大值 66
max*
integer 年龄最大值限制
最小值 18,最大值 66
gender
enum[] 性别定向(仅单选),[枚举详情]
数组长度为 1
枚举列表:{ MALE, FEMALE }
education
enum[] 用户学历,[枚举详情],该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
数组最小长度 1,最大长度 100
枚举列表:{ DOCTOR, MASTER, BACHELOR, SENIOR, JUNIOR, PRIMARY, JUNIOR_COLLEGE }
marital_status
enum[] 婚恋育儿状态,[枚举详情],该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
数组最小长度 1,最大长度 100
枚举列表:{ SINGLE, IN_LOVE, NEWLY_MARRIED, MARRIED, PARENTING, PARENTING_0, PARENTING_0_6, PARENTING_6_12, PARENTING_12_24, PARENTING_24_36, CHILD_PRE_SCHOOL, CHILD_PRIMARY_SCHOOL, CHILD_JUNIOR_SCHOOL, CHILD_HIGH_SCHOOL }
geo_location
struct 地理位置定向,
针对朋友圈广告(campaign_type=CAMPAIGN_TYPE_WECHAT_MOMENTS)地域必填,非朋友圈广告选填
如使用地域定向"regions"、"business_districts"、"custom_locations" 不能同时为空
location_types*
enum[] 地点类型,[枚举详情],选择限制:
  • 对于微信流量(site_set=SITE_SET_WECHAT、SITE_SET_MOMENTS、SITE_SET_MINI_GAME_WECHAT),仅能选择"LIVE_IN"(常住);
  • 使用商圈(business_district)以及自定义地理位置(custom_locations)时,仅可选 "VISITED_IN"(去过),"LIVE_IN"(常住);
  • 如:["LIVE_IN", "VISITED_IN"]

    数组最小长度 1,最大长度 5
    枚举列表:{ RECENTLY_IN, VISITED_IN, LIVE_IN, TRAVEL_IN, LIVE_AND_RECENTLY, INTELLIGENCE }
    regions
    integer[] 省市区县列表,当投放微信流量(site_set=SITE_SET_WECHAT、SITE_SET_MOMENTS、SITE_SET_MINI_GAME_WECHAT)时,仅支持中国大陆(不包含港澳台)地域 id,可通过 [targeting_tags/get] 接口获取
    数组最小长度 0,最大长度 1000
    business_districts
    integer[] 商圈 id 列表,可通过 [targeting_tags/get] 接口获取
    数组最小长度 0,最大长度 400
    custom_locations
    struct[] 自定义地理位置列表,使用火星系坐标,当广告类型为朋友圈广告时(campaign_type=CAMPAIGN_TYPE_WECHAT_MOMENTS),custom_locations 的数组长度限制为最小长度 1。
    数组最小长度 1,最大长度 400
    longitude*
    float 经度,单位度
    最小值-180,最大值 180,最多保留 6 位小数
    latitude*
    float 纬度,单位度
    最小值-90,最大值 90,最多保留 6 位小数
    radius*
    integer 半径,单位米
    最小值 200,最大值 25000
    user_os
    string[] 操作系统定向, 该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,当 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 操作系统上展示,[枚举详情]
    数组最小长度 1,最大长度 100
    可选值:{ IOS, ANDROID, IOS_VERSION_4, IOS_VERSION_5, IOS_VERSION_6, IOS_VERSION_7, IOS_VERSION_8, IOS_VERSION_9, IOS_VERSION_10, IOS_VERSION_11, IOS_VERSION_12, IOS_VERSION_13, IOS_VERSION_14, IOS_VERSION_15, IOS_VERSION_16, IOS_VERSION_17, ANDROID_VERSION_1, ANDROID_VERSION_2, ANDROID_VERSION_3, ANDROID_VERSION_4, ANDROID_VERSION_5, ANDROID_VERSION_6, ANDROID_VERSION_7, ANDROID_VERSION_8, ANDROID_VERSION_9, ANDROID_VERSION_10, ANDROID_VERSION_11, ANDROID_VERSION_12, ANDROID_VERSION_13, ANDROID_VERSION_14 }
    device_price
    enum[] 设备价格定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情]
    数组最小长度 1,最大长度 100
    枚举列表:{ PRICE_1500_LESS, PRICE_1500_2500, PRICE_2500_3500, PRICE_3500_4500, PRICE_4500_MORE }
    device_brand_model
    struct 设备品牌型号定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
    included_list
    integer[] 设备品牌型号定向,可通过 [targeting_tags/get] 接口获取
    数组最小长度 0,最大长度 400
    最小值 0,最大值 10000000000
    excluded_list
    integer[] 排除设备品牌型号列表,不能与 included_list 同时使用,可通过 [targeting_tags/get] 接口获取
    数组最小长度 0,最大长度 400
    最小值 0,最大值 10000000000
    network_type
    enum[] 联网方式定向,[枚举详情]
    数组最小长度 1,最大长度 100
    枚举列表:{ WIFI, NET_2G, NET_3G, NET_4G, NET_5G }
    network_operator
    enum[] 移动运营商定向,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情]
    数组最小长度 1,最大长度 100
    枚举列表:{ CMCC, CUC, CTC }
    app_install_status
    enum[] 应用安装(应用用户),当且仅当 promoted_object_type 为 PROMOTED_OBJECT_TYPE_APP_ANDROID、PROMOTED_OBJECT_TYPE_APP_ANDROID_MYAPP、PROMOTED_OBJECT_TYPE_APP_ANDROID_UNION 时使用,[枚举详情]
    数组长度为 1
    枚举列表:{ NOT_INSTALLED, INSTALLED }
    consumption_status
    enum[] 消费水平,[枚举详情],该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营
    数组最小长度 1,最大长度 100
    枚举列表:{ HIGH, LOW }
    game_consumption_level
    enum[] 游戏消费能力,原 gamer_consumption_ability 定向升级版,gamer_consumption_ability 和 game_consumption_level 不能同时使用.,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情]
    数组最小长度 1,最大长度 2
    枚举列表:{ HIGH, NORMAL }
    financial_situation
    enum[] 财产状态,该功能即将下线,仅部分行业灰度开放,如有问题可联系您的客户运营,[枚举详情]
    数组最小长度 1,最大长度 2
    枚举列表:{ CAR_OWNERS, HOME_OWNERS }
    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 },[枚举详情]
    数组最小长度 0,最大长度 10
    枚举列表:{ WECHAT_OFFICIAL_ACCOUNT_FOLLOWED, WECHAT_COUPON_OBTAINED, WECHAT_OFFICIAL_ACCOUNT_AD_LIKE, WECHAT_MOMENTS_AD_LIKE, MINI_GAME_WECHAT_REGISTERED, WECHAT_WORK_CONTACTS_ADDED, GDT_WECHAT_OFFICIAL_ACCOUNT_FOLLOWED, WECHAT_CHANNELS_FANS, WE_COM_CORP_ID_ADDED, WECHAT_MINI_GAME_AD_LIKE }
    excluded_actions
    enum[] 排除的行为列表,多个行为之间为并集(or)的关系
    数组最小长度 0,最大长度 10
    QQ 账号支持枚举列表:{WECHAT_OFFICIAL_ACCOUNT_AD_LIKE,WECHAT_MOMENTS_AD_LIKE,MINI_GAME_WECHAT_REGISTERED },[枚举详情]
    数组最小长度 0,最大长度 10
    枚举列表:{ WECHAT_OFFICIAL_ACCOUNT_FOLLOWED, WECHAT_COUPON_OBTAINED, WECHAT_OFFICIAL_ACCOUNT_AD_LIKE, WECHAT_MOMENTS_AD_LIKE, MINI_GAME_WECHAT_REGISTERED, WECHAT_WORK_CONTACTS_ADDED, GDT_WECHAT_OFFICIAL_ACCOUNT_FOLLOWED, WECHAT_CHANNELS_FANS, WE_COM_CORP_ID_ADDED, WECHAT_MINI_GAME_AD_LIKE }
    custom_audience
    integer[] 自定义定向用户群,通过 [人群管理模块] 创建的人群 id,custom_audience 和 excluded_custom_audience 个数之和不能超过 200 个,如果有组合人群,则组合人群包数不能超过 50。
    2022 年 6 月 30 日起,竞价 oCPC、oCPM 场景内,仅能使用“一方人群”的人群包,人群详情可参考[人群管理模块]
    数组最小长度 1,最大长度 200
    excluded_custom_audience
    integer[] 自定义排除用户群,通过 [人群管理模块] 创建的人群 id,custom_audience 和 excluded_custom_audience 个数之和不能超过 200 个,如果有组合人群,则组合人群包数不能超过 50。
    2022 年 6 月 30 日起,竞价 oCPC、oCPM 场景内,仅能使用“一方人群”的人群包,人群详情可参考[人群管理模块]
    数组最小长度 1,最大长度 200
    behavior_or_interest
    struct 行为兴趣意向定向,2022 年 6 月 30 日起,该定向将无法在竞价 oCPC、oCPM 场景使用。
    interest
    struct 行为兴趣意向定向的兴趣部分
    targeting_tags
    string[] 兴趣标签列表(待废弃,后续仅支持 category_id_list、keyword_list)
    数组最小长度 1,最大长度 250
    category_id_list
    integer[] 兴趣标签 id 列表,和关键词列表 keyword_list 个数之和不能大于 250,通过[targeting_tags/get]可获取兴趣标签列表 id 和对应标签名称
    数组最小长度 1,最大长度 250
    最小值 1
    keyword_list
    string[] 兴趣关键词列表,和兴趣标签 id 列表 category_id_list 个数之和不能大于 250,通过[targeting_tags/get]可获取兴趣关键词列表
    数组最小长度 1,最大长度 250
    字段长度最小 1 字节,
    behavior
    struct[] 行为兴趣意向定向的行为部分,targeting_tags、category_id_list、keyword_list 三个结构不能同时为空
    数组长度为 1
    targeting_tags
    string[] 行为标签列表(待废弃,后续仅支持 category_id_list、keyword_list)
    数组最小长度 1,最大长度 250
    category_id_list
    integer[] 行为标签 id 列表,和关键词列表 keyword_list 个数之和不能大于 250,通过[targeting_tags/get]可获取行为标签列表 id 和对应标签名称
    数组最小长度 1,最大长度 250
    最小值 1
    keyword_list
    string[] 行为关键词列表,和行为标签 id 列表 category_id_list 个数之和不能大于 250,通过[targeting_tags/get]可获取行为关键词列表
    数组最小长度 1,最大长度 250
    字段长度最小 1 字节,
    scene*
    enum[] 行为兴趣意向定向的行为部分的场景,[枚举详情]
    数组最小长度 1,最大长度 3
    枚举列表:{ BEHAVIOR_INTEREST_SCENE_ALL, BEHAVIOR_INTEREST_SCENE_APP, BEHAVIOR_INTEREST_SCENE_ECOMMERCE, BEHAVIOR_INTEREST_SCENE_INFORMATION }
    time_window*
    enum 行为兴趣意向定向的行为部分的时间窗,[枚举详情]
    枚举列表:{ BEHAVIOR_INTEREST_TIME_WINDOW_SEVEN_DAY, BEHAVIOR_INTEREST_TIME_WINDOW_FIFTEEN_DAY, BEHAVIOR_INTEREST_TIME_WINDOW_THIRTY_DAY, BEHAVIOR_INTEREST_TIME_WINDOW_THREE_MONTH, BEHAVIOR_INTEREST_TIME_WINDOW_SIX_MONTH, BEHAVIOR_INTEREST_TIME_WINDOW_ONE_YEAR }
    intensity*
    enum[] 行为兴趣意向定向的行为部分的强度,[枚举详情]
    数组长度为 1
    枚举列表:{ BEHAVIOR_INTEREST_INTENSITY_ALL, BEHAVIOR_INTEREST_INTENSITY_HIGH }
    intention
    struct 行为兴趣意向定向的意向部分
    targeting_tags
    integer[] 意向标签列表
    数组最小长度 1,最大长度 250
    最小值 0,最大值 4294967295
    excluded_converted_audience
    struct 排除已转化用户定向
    excluded_dimension*
    enum 排除已转化用户定向范围
    同应用,仅当推广目标为应用下载时可以使用,没有选择自定义转化行为(excluded_dimension)时,使用该定向出价需要满足是 oCPC、oCPM 广告;
    同商品,仅当 SDPA 商品广告下使用,不支持自定义转化行为默认排除已下单、和已付费用户,不限制出价方式;
    非同应用、非同商品,没有选择自定义转化行为(excluded_dimension)时,使用该定向出价需要满足是 oCPC、oCPM 广告;,[枚举详情]
    枚举列表:{ EXCLUDED_DIMENSION_CAMPAIGN, EXCLUDED_DIMENSION_UID, EXCLUDED_DIMENSION_BUSINESS_MANAGER, EXCLUDED_DIMENSION_COMPANY_ACCOUNT, EXCLUDED_DIMENSION_APP, EXCLUDED_DIMENSION_PRODUCT }
    conversion_behavior_list
    enum[] 自定义转化行为,没有选择自定义转化行为(excluded_dimension)时,使用该定向需要校验是 oCPC、oCPM 广告,默认取出价转化目标值。当选择了自定义转化行为时,不需要校验 oCPC、oCPM 广告。,[枚举详情]
    数组最小长度 1,最大长度 2
    枚举列表:{ OPTIMIZATIONGOAL_NONE, OPTIMIZATIONGOAL_BRAND_CONVERSION, OPTIMIZATIONGOAL_FOLLOW, OPTIMIZATIONGOAL_CLICK, OPTIMIZATIONGOAL_IMPRESSION, OPTIMIZATIONGOAL_APP_DOWNLOAD, OPTIMIZATIONGOAL_APP_ACTIVATE, OPTIMIZATIONGOAL_APP_REGISTER, OPTIMIZATIONGOAL_ONE_DAY_RETENTION, OPTIMIZATIONGOAL_APP_PURCHASE, OPTIMIZATIONGOAL_ECOMMERCE_ORDER, OPTIMIZATIONGOAL_ECOMMERCE_CHECKOUT, OPTIMIZATIONGOAL_LEADS, OPTIMIZATIONGOAL_ECOMMERCE_CART, OPTIMIZATIONGOAL_PROMOTION_CLICK_KEY_PAGE, OPTIMIZATIONGOAL_VIEW_COMMODITY_PAGE, OPTIMIZATIONGOAL_ONLINE_CONSULTATION, OPTIMIZATIONGOAL_TELEPHONE_CONSULTATION, OPTIMIZATIONGOAL_PAGE_RESERVATION, OPTIMIZATIONGOAL_DELIVERY, OPTIMIZATIONGOAL_MESSAGE_AFTER_FOLLOW, OPTIMIZATIONGOAL_CLICK_MENU_AFTER_FOLLOW, OPTIMIZATIONGOAL_PAGE_EFFECTIVE_ONLINE_CONSULT, OPTIMIZATIONGOAL_PAGE_EFFECTIVE_PHONE_CALL, OPTIMIZATIONGOAL_CONFIRM_EFFECTIVE_LEADS_CONSULT, OPTIMIZATIONGOAL_CONFIRM_EFFECTIVE_LEADS_PHONE, OPTIMIZATIONGOAL_LEADS_COLLECT, OPTIMIZATIONGOAL_FIRST_PURCHASE, OPTIMIZATIONGOAL_APPLY, OPTIMIZATIONGOAL_PRE_CREDIT, OPTIMIZATIONGOAL_CREDIT, OPTIMIZATIONGOAL_WITHDRAW_DEPOSITS, OPTIMIZATIONGOAL_PROMOTION_VIEW_KEY_PAGE, OPTIMIZATIONGOAL_MOBILE_APP_CREATE_ROLE, OPTIMIZATIONGOAL_CANVAS_CLICK, OPTIMIZATIONGOAL_PROMOTION_CLAIM_OFFER, OPTIMIZATIONGOAL_ECOMMERCE_ADD_TO_WISHLIST, OPTIMIZATIONGOAL_CONFIRM_EFFECTIVE_LEADS_RESERVATION, OPTIMIZATIONGOAL_PAGE_RECEIPT, OPTIMIZATIONGOAL_PAGE_SCAN_CODE, OPTIMIZATIONGOAL_SELECT_COURSE, OPTIMIZATIONGOAL_CONFIRM_POTENTIAL_CUSTOMER_PHONE, OPTIMIZATIONGOAL_MOBILE_APP_AD_INCOME, OPTIMIZATIONGOAL_MOBILE_APP_ACCREDIT, OPTIMIZATIONGOAL_PURCHASE_MEMBER_CARD, OPTIMIZATIONGOAL_PAGE_CONFIRM_EFFECTIVE_LEADS, OPTIMIZATIONGOAL_ADD_DESKTOP, OPTIMIZATIONGOAL_RESERVATION, OPTIMIZATIONGOAL_FIRST_ECOMMERCE_ORDER, OPTIMIZATIONGOAL_FIRST_TWENTY_FOUR_HOUR_ECOMMERCE_ORDER, OPTIMIZATIONGOAL_ECOMMERCE_SCANCODE_WX, OPTIMIZATIONGOAL_CLASS_PARTICIPATED, OPTIMIZATIONGOAL_INSURANCE_PURCHASE, OPTIMIZATIONGOAL_MOBILE_APP_SEVEN_DAYS_RETENTION, OPTIMIZATIONGOAL_LIKE, OPTIMIZATIONGOAL_EXTERNAL_LINK_CLICK, OPTIMIZATIONGOAL_BUY_COUPONS, OPTIMIZATIONGOAL_LEAVE_INFORMATION, OPTIMIZATIONGOAL_CORE_ACTION, OPTIMIZATIONGOAL_ONE_DAY_RETENTION_RATIO, OPTIMIZATIONGOAL_PROMOTION_READ_ARTICLE, OPTIMIZATIONGOAL_RESERVATION_CHECK, OPTIMIZATIONGOAL_OPEN_ACCOUNT, OPTIMIZATIONGOAL_SEVEN_DAY_ECOMMERCE_ORDER, OPTIMIZATIONGOAL_ADD_WECHAT, OPTIMIZATIONGOAL_WECOM_CONSULT, OPTIMIZATIONGOAL_ADD_GROUP, OPTIMIZATIONGOAL_QUICK_ORDER, OPTIMIZATIONGOAL_PRE_PAY, OPTIMIZATIONGOAL_PAGE_ONLINE_CONSULT_ACTIVE_ONE_MSG, OPTIMIZATIONGOAL_CALL_DURATION_THIRTY_SECONDS, OPTIMIZATIONGOAL_CLAIM_COURSE, OPTIMIZATIONGOAL_QUIT_GROUP, OPTIMIZATIONGOAL_VIEW_ACQUISITION_CONTENT, OPTIMIZATIONGOAL_BACK_FLOW, OPTIMIZATIONGOAL_PAGE_ONLINE_CONSULT_THREE_MSG, OPTIMIZATIONGOAL_RENEWAL, OPTIMIZATIONGOAL_LOW_PRICE_COURSE, OPTIMIZATIONGOAL_CONSULT_INTENTION, OPTIMIZATIONGOAL_EVERY_DAY_RETENTION, OPTIMIZATIONGOAL_PROMOTION_VIEW_KEY_PAGE_UV, OPTIMIZATIONGOAL_LIVE_STREAM_DURATION_1MIN, OPTIMIZATIONGOAL_LIVE_STREAM_INTERACTION, OPTIMIZATIONGOAL_ECOMMERCE_CANCEL_ORDER, OPTIMIZATIONGOAL_CLICK_LEADS_COMPONENT, OPTIMIZATIONGOAL_REGULAR_PRICE_COURSE, OPTIMIZATIONGOAL_VISIT_STROE, OPTIMIZATIONGOAL_EFFECTIVE_ENTRY, OPTIMIZATIONGOAL_CREDIT_RATIO }
    description
    string 定向描述
    字段长度最小 0 字节,长度最大 250 字节

    使用说明

    1. 使用自定义人群(custom_audience)定向和排他人群定向(excluded_custom_audience)时,请注意人群包的状态,待处理、处理中、冻结、解冻中的人群用于广告定向,在人群状态变成“成功可用”前可能会存在曝光异常的现象。有关人群状态请参考 [自定义人群] 接口。
    2. 地理位置定向的省市区县以及商圈 id、行为兴趣意向定向、微信公众号类型定向、移动媒体类型定向的可选值列表可通过 targeting_tags/get 接口进行获取。

    请求示例

    
    curl 'https://api.e.qq.com/v1.1/targetings/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
    -d 'account_id=<ACCOUNT_ID>' \
    -d 'targeting_name=定向' \
    -d 'targeting={"gender":["MALE"],"age":[{"min":18,"max":30}],"geo_location":{"regions":[110000,310000],"location_types":["LIVE_IN"]}}' \
    -d 'description=description' 
    					

    应答字段

    名称 类型 描述
    targeting_id
    int64 定向 id

    应答示例

    {
        "code": 0,
        "message": "",
        "message_cn": "",
        "data": {
            "targeting_id": "<TARGETING_ID>"
        }
    }

    可视化调试工具