创建客户人群

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id
name*	string	人群名称，同一个帐号下的人群不许重名 字段长度最小 1 字节，长度最大 32 字节
type*	enum	人群类型，[枚举详情] 枚举列表：{ CUSTOMER_FILE, LOOKALIKE, USER_ACTION, KEYWORD, AD, COMBINE }
external_audience_id	string	广告主对人群在自己系统里的编码; 只能包含数字或字母或下划线；如果该编码创建过人群，再次用该编码创建人群时，会返回之前用该编码创建的人群 id ；人群编码不能与标签编码（tag_code）重复 字段长度最小 1 字节，长度最大 128 字节
description	string	人群描述 字段长度最小 1 字节，长度最大 100 字节
cooperated	boolean	是否深度合作，不填写默认为 false 可选值：{ true, false }
audience_spec	struct	人群信息，和 type 相关
lookalike_spec	struct	Lookalike 人群信息，当 type=LOOKALIKE 时必填
seed_audience_id*	integer	种子人群 id，种子人群：覆盖人数 100-30000000, 状态必须是'成功可用', 不能是扩展人群
expand_user_count*	integer	lookalike 目标人数，是 500000 的整数倍 最小值 500000，最大值 100000000
user_action_spec	struct	UserAction 人群信息，当 type=USER_ACTION 时必填
user_action_set_id*	integer	用户行为源 id，通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id。请注意，当填写的用户行为数据源类型为 {WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME} 时，必填 user_id 字段中的 wechat_openid (或 wechat_unionid) 及 wechat_app_id。
match_rule_type*	enum	匹配规则类型，当 user_action_set 为 Android/iOS APP 类型时只可选 ACTION，[枚举详情] 枚举列表：{ URL, ACTION }
extract_type	enum	行为人群提取类型，当 match_rule_type=ACTION 时生效，默认 FILTER，[枚举详情] 枚举列表：{ FILTER, AGGREGATION }
time_window*	integer	时间窗，用来圈定最近多少天发生过某行为的人群，如今天是 1 月 14 日，则最近 14 天的范围是 1 月 1 日至 1 月 14 日。当 extractType = AGGREGATION 时，时间窗最大取值为 90 天 最小值 0，最大值 180
url_match_rule	struct	url 匹配规则，当 match_rule_type = URL 时必填
url_matcher_group*	struct[]	匹配规则组，如果为空表示全站浏览人群，多个组之间是 AND 关系 数组最大长度 16
url_matcher*	struct[]	匹配规则，多个匹配规则之间是 OR 关系 数组最大长度 16
param_value*	string	参数值 字段长度最小 1 字节，长度最大 128 字节
operator*	enum	运算符，operator 只允许 EQ、NE、CONTAIN、NOT_CONTAIN，[枚举详情] 枚举列表：{ LT, GT, EQ, NE, CONTAIN, NOT_CONTAIN }
action_match_rule	struct	行为和参数匹配规则，当 match_rule_type = ACTION，extractType 为空或者 extractType = FITLER 时必填
action_type*	enum	标准行为类型，当值为 'CUSTOM' 时表示自定义行为类型，[枚举详情] 枚举列表：{ CUSTOM, REGISTER, VIEW_CONTENT, CONSULT, ADD_TO_CART, PURCHASE, ACTIVATE_APP, SEARCH, ADD_TO_WISHLIST, INITIATE_CHECKOUT, COMPLETE_ORDER, DOWNLOAD_APP, START_APP, RATE, PAGE_VIEW, RESERVATION, SHARE, APPLY, CLAIM_OFFER, NAVIGATE, PRODUCT_RECOMMEND, VISIT_STORE, TRY_OUT, DELIVER, CONFIRM_EFFECTIVE_LEADS, CONFIRM_POTENTIAL_CUSTOMER, CREATE_ROLE, AUTHORIZE, TUTORIAL_FINISH, SCANCODE, ENTER_BACKGROUND, ENTER_FOREGROUND, TICKET, LOGIN, QUEST, UPDATE_LEVEL, CREATE, PAUSE, RESUME, APP_QUIT, BIND_ACCOUNT, ADD_PAYMENT, PRE_CREDIT, CREDIT, WITHDRAW_DEPOSITS, LANDING_PAGE_CLICK, SELECT_COURSE, RE_FUND, PLATFORM_VIEW, ONE_DAY_LEAVE, PRODUCT_VIEW, PURCHASE_MEMBER_CARD, ONLINE_CONSULT, MAKE_PHONE_CALL, FOLLOW, ADD_DESKTOP, RETURN, LEAVE_INFORMATION, PURCHASE_COUPON, ADD_GROUP, ADD_CUSTOMER_PAGE_VIEW, ADD_CUSTOMER_PAGE_INTERACTIVE, CUSTOMER_PROMOTION_PAGE_VIEW, CUSTOMER_PROMOTION_PAGE_INTERACTIVE, ABNORMAL_ACTION, LIVE_STREAM, SCANCODE_WX, STAY_PAY_7, STAY_PAY_15, STAY_PAY_30, INSURANCE_PAY, RESERVATION_CHECK, PARTICIPATED, COMPLETED, REGULAR_PRICE_COURSE, DROP_OUT, CONFIRM_DELIVERY_ORDER, CANCEL_DELIVERY_ORDER, OPEN_ACCOUNT, DEPOSIT, TRADE, SECURITY_NEGATIVE, AD_CLICK, AD_IMPRESSION, SIGN_IN, TRY_OUT_INTENTION, INEFFECTIVE_LEADS, READ_ARTICLE, COMMENT, CARD_CLICK, WECOM_CONSULT, BIND_CARD, LOW_PRICE_COURSE, ADD_WECHAT, PRE_PAY, QUIT_GROUP, PHONE_CONNECTED, RE_ACTIVE, CLAIM_COURSE, VIEW_ACQUISITION_CONTENT, TERMINATION, RENEWAL, CONSULT_INTENTION }
custom_action	string	自定义行为类型，当 action_type=CUSTOM 时必填 字段长度最小 1 字节，长度最大 128 字节
param_matcher_group	struct[]	匹配规则组，多个组之间是 AND 关系 数组最大长度 16
param_matcher*	struct[]	匹配规则，多个匹配规则之间是 OR 关系 数组最大长度 16
param_name*	string	参数名称 字段长度最小 1 字节，长度最大 128 字节
param_value*	string	参数值 字段长度最小 1 字节，长度最大 128 字节
operator*	enum	运算符，[枚举详情] 枚举列表：{ LT, GT, EQ, NE, CONTAIN, NOT_CONTAIN }
action_aggregation_rule	struct	行为和参数聚合规则，当 match_rule_type = ACTION，extractType = AGGREGATION 时必填
action_type*	enum	标准行为类型，当值为 'CUSTOM' 时表示自定义行为类型，[枚举详情] 枚举列表：{ CUSTOM, REGISTER, VIEW_CONTENT, CONSULT, ADD_TO_CART, PURCHASE, ACTIVATE_APP, SEARCH, ADD_TO_WISHLIST, INITIATE_CHECKOUT, COMPLETE_ORDER, DOWNLOAD_APP, START_APP, RATE, PAGE_VIEW, RESERVATION, SHARE, APPLY, CLAIM_OFFER, NAVIGATE, PRODUCT_RECOMMEND, VISIT_STORE, TRY_OUT, DELIVER, CONFIRM_EFFECTIVE_LEADS, CONFIRM_POTENTIAL_CUSTOMER, CREATE_ROLE, AUTHORIZE, TUTORIAL_FINISH, SCANCODE, ENTER_BACKGROUND, ENTER_FOREGROUND, TICKET, LOGIN, QUEST, UPDATE_LEVEL, CREATE, PAUSE, RESUME, APP_QUIT, BIND_ACCOUNT, ADD_PAYMENT, PRE_CREDIT, CREDIT, WITHDRAW_DEPOSITS, LANDING_PAGE_CLICK, SELECT_COURSE, RE_FUND, PLATFORM_VIEW, ONE_DAY_LEAVE, PRODUCT_VIEW, PURCHASE_MEMBER_CARD, ONLINE_CONSULT, MAKE_PHONE_CALL, FOLLOW, ADD_DESKTOP, RETURN, LEAVE_INFORMATION, PURCHASE_COUPON, ADD_GROUP, ADD_CUSTOMER_PAGE_VIEW, ADD_CUSTOMER_PAGE_INTERACTIVE, CUSTOMER_PROMOTION_PAGE_VIEW, CUSTOMER_PROMOTION_PAGE_INTERACTIVE, ABNORMAL_ACTION, LIVE_STREAM, SCANCODE_WX, STAY_PAY_7, STAY_PAY_15, STAY_PAY_30, INSURANCE_PAY, RESERVATION_CHECK, PARTICIPATED, COMPLETED, REGULAR_PRICE_COURSE, DROP_OUT, CONFIRM_DELIVERY_ORDER, CANCEL_DELIVERY_ORDER, OPEN_ACCOUNT, DEPOSIT, TRADE, SECURITY_NEGATIVE, AD_CLICK, AD_IMPRESSION, SIGN_IN, TRY_OUT_INTENTION, INEFFECTIVE_LEADS, READ_ARTICLE, COMMENT, CARD_CLICK, WECOM_CONSULT, BIND_CARD, LOW_PRICE_COURSE, ADD_WECHAT, PRE_PAY, QUIT_GROUP, PHONE_CONNECTED, RE_ACTIVE, CLAIM_COURSE, VIEW_ACQUISITION_CONTENT, TERMINATION, RENEWAL, CONSULT_INTENTION }
custom_action	string	自定义行为类型，当 action_type=CUSTOM 时必填 字段长度最小 1 字节，长度最大 128 字节
aggregation_group*	struct[]	聚合规则数组，多个组之间是 AND 关系 数组最小长度 1，最大长度 4
aggregation_matcher*	struct[]	匹配规则组，多个组之间是 OR 关系 数组长度为 1
aggregation_type*	enum	聚合类型，[枚举详情] 枚举列表：{ SUM, MAX, MIN, COUNT }
count_type	enum	频次类型，aggregation_type = COUNT 时必填，[枚举详情] 枚举列表：{ BY_TIMES, BY_DAY }
param_name	string	参数名称，当 aggregation_type != COUNT 时必填 字段长度最小 1 字节，长度最大 128 字节
comparator*	enum	比较符，[枚举详情] 枚举列表：{ COMPARATOR_GE, COMPARATOR_LE, COMPARATOR_BETWEEN, COMPARATOR_EQ }
comparison_value	integer	参数值，当 comparator != COMPARATOR_BETWEEN 时必填
comparison_min_value	integer	参数值，当 comparator = COMPARATOR_BETWEEN 时必填
comparison_max_value	integer	参数值，当 comparator = COMPARATOR_BETWEEN 时必填
filter_group	struct[]	匹配规则组，多个组之间是 AND 关系 数组最小长度 1，最大长度 16
param_matcher*	struct[]	匹配规则，多个匹配规则之间是 OR 关系 数组长度为 1
param_name*	string	参数名称 字段长度最小 1 字节，长度最大 128 字节
param_value*	string	参数值 字段长度最小 1 字节，长度最大 128 字节
operator*	enum	运算符，[枚举详情] 枚举列表：{ LT, GT, EQ, NE, CONTAIN, NOT_CONTAIN }
lbs_spec	struct	LBS 人群信息，当 type=LBS 时必填
lbs_type*	enum	LBS 类型，LBS 类型只允许 POI、CROSS_CITY、CUSTOM_LOCATION，[枚举详情] 枚举列表：{ POI, CROSS_CITY, CUSTOM_LOCATION }
cross_city_rule	struct	跨城市规则，当 lbs_type=CROSS_CITY 时必填； route 不能超过 10 个
route*	string[]	路线，出发地和目的地的组合，均使用地址的编码值，比如北京的编码为 1，上海的编码为 2 则北京到上海表示为"12"； 0 表示不限，出发的和目的地最多只能一个为 0，不能都为 0，不能填写"00"，路线不能为空 数组最大长度 10
date_range*	struct	时间范围，日期格式，{"start_date":"2017-03-01","end_date":"2017-04-02"}
start_date*	string	开始时间，大于等于 0，不能早于 1 年前，且小于 end_date 字段长度为 10 字节
end_date*	string	结束时间，小于等于今天，且大于 start_date 字段长度为 10 字节
frequency	integer	行为次数，行为次数至少为 1 最小值 1，最大值 2147483647
poi_rule	struct	POI 规则，当 lbs_type=POI 时必填； region_id 个数不能超过 50 个； poi_category_id 个数不能超过 10 个
region_id	integer[]	地区编码 数组最小长度 1，最大长度 50
poi_category_id*	integer[]	POI 分类编码 数组最小长度 1，最大长度 10 最小值 1，最大值 2147483647
date_range*	struct	时间范围，日期格式，{"start_date":"2017-03-01","end_date":"2017-04-02"}
start_date*	string	开始时间，大于等于 0，不能早于 1 年前，且小于 end_date 字段长度为 10 字节
end_date*	string	结束时间，小于等于今天，且大于 start_date 字段长度为 10 字节
day_of_week	enum[]	week 类型，week 类型只允许 MONDAY、TUESDAY、WEDNESDAY、THURSDAY、FRIDAY、SATURDAY、SUNDAY，[枚举详情] 枚举列表：{ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY }
frequency	integer	行为次数，行为次数至少为 1 最小值 1，最大值 2147483647
custom_location_rule	struct	自定义地理位置规则，当 lbs_type=CUSTOM_LOCATION 时必填
poi_type*	enum	LBS 兴趣点类型，[枚举详情] 枚举列表：{ ALL, TRAVEL_IN }
date_range*	struct	时间范围，日期格式，{"start_date":"2017-03-01","end_date":"2017-04-02"}；时间范围需在最近一年内，最大时间跨度为 60 天
start_date*	string	开始时间，大于等于 0，不能早于 1 年前，且小于 end_date 字段长度为 10 字节
end_date*	string	结束时间，小于今天，且大于 start_date 字段长度为 10 字节
frequency_spec	struct	频次定义
comparator	enum	LBS 频次比较操作符类型，目前仅支持 COMPARATOR_BETWEEN，[枚举详情] 枚举列表：{ COMPARATOR_GE, COMPARATOR_LE, COMPARATOR_BETWEEN, COMPARATOR_EQ }
frequency_min_value	integer	最小频次值，当 comparator 为 COMPARATOR_BETWEEN 时必填 最小值 1，最大值 100
frequency_max_value	integer	最大频次值，当 comparator 为 COMPARATOR_BETWEEN 时必填 最小值 1，最大值 100
area_list*	struct[]	地理位置列表 数组最小长度 1，最大长度 20
area_type*	enum	LBS 自定义区域类型，[枚举详情] 枚举列表：{ CIRCLE }
circle_area	struct	圆形区域定义，当 area_type 为 CIRCLE 是必填
longitude*	float	经度，单位度 最小值-180，最大值 180，最多保留 6 位小数
latitude*	float	纬度，单位度 最小值-90，最大值 90，最多保留 6 位小数
radius*	integer	自定义 lbs 打点半径，单位：米 最小值 5000，最大值 100
keyword_spec	struct	Keyword 人群信息，当 type=KEYWORD 时必填
include_keyword*	string[]	包含关键词，最多 100 个，单个关键词字数不超过 10 数组最小长度 1，最大长度 100 字段长度最小 1 字节，长度最大 10 字节
exclude_keyword	string[]	排除关键词，最多 20 个，单个关键词字数不超过 10 数组最大长度 20 字段长度最小 1 字节，长度最大 10 字节
ad_rule_spec	struct	广告人群信息，当 type=AD 时必填
rule_type*	enum	广告行为类型，其中 EXPOSURE 类型需要线下联系运营开通白名单方可使用，[枚举详情] 枚举列表：{ EXPOSURE, CLICK, CONVERSION }
conversion_type	enum[]	广告转化类型，当 rule_type=CONVERSION 时该字段必填，否则该字段不能填写，[枚举详情] 数组最大长度 5 枚举列表：{ APP_START_DOWNLOAD, APP_FINISH_DOWNLOAD, APP_INSTALL, APP_ACTIVATE }
start_date*	string	数据起始日期，格式为 yyyy-MM-dd，必须在 90 天以内，且在今天（不包含）以前 字段长度最小 0 字节，长度最大 10 字节
end_date	string	数据结束日期,格式为 yyyy-MM-dd，必须在 start_date（包含）之后，且在今天（不包含）以前。如果未填写，则人群数据会随源投放数据更新。 字段长度最小 0 字节，长度最大 10 字节
campaign_id_list	integer[]	需要提取人群的 campaign id 列表,通过 [campaigns/get] 接口可获得账号下的推广计划列表，campaign_id_list 和 product_list 字段至多只能填写一个，二者都不填则表示提取该广告主 id 下的所有 campaign 的广告行为数据 数组最大长度 75 最小值 1，最大值 2147483647
promoted_object_list	struct[]	需要提取人群的推广目标列表，通过 [products/get] 模块可获得账号下的推广目标列表，campaign_id_list 和 product_list 字段至多只能填写一个，二者都不填则表示提取该广告主 id 下的所有 campaign 的广告行为数据 数组最大长度 75
promoted_object_type*	enum	推广目标类型，[枚举详情] 枚举列表：{ PROMOTED_OBJECT_TYPE_APP_ANDROID, PROMOTED_OBJECT_TYPE_APP_IOS, PROMOTED_OBJECT_TYPE_QZONE_PAGE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_ARTICLE, PROMOTED_OBJECT_TYPE_QZONE_PAGE_IFRAMED, PROMOTED_OBJECT_TYPE_QZONE_VIDEO_PAGE, PROMOTED_OBJECT_TYPE_APP_PC }
promoted_object_id*	string	推广目标 id 字段长度最小 0 字节，长度最大 128 字节
adgroup_id_list	integer[]	需要提取人群的 adgroup id 列表,通过 [adgroups/get] 接口可获得账号下的广告组列表，campaign_id_list,product_list 和 adgroup_id_list 字段至多只能填写一个，三者都不填则表示提取该广告主 id 下的所有广告行为数据 数组最大长度 75 最小值 1，最大值 2147483647
combine_spec	struct	组合人群信息，当 type=COMBINE 时必填，最多允许用 500 个人群做组合
include*	struct[]	包含的人群，注意这是个二维数组，第一层数组元素之间为 AND 关系，第二层数组元素之间为 OR 关系 数组最小长度 1，最大长度 500
audience_id*	integer	人群 id 或标签 id，通过 [custom_audiences] 模块创建客户人群或[custom_tags] 模块创建客户标签获得，即此处支持填写"audience_id":"<AUDIENCE_ID>"，也支持填写"audience_id":"<TAG_ID>"，不支持 LOOKALIKE 和 COMBINE 人群的 id
time_window	integer	时间窗，仅对客户标签有效，目前仅支持以下几个时间窗选项：1、3、7、10、15、30、90、180、365 最小值 1，最大值 365
exclude	struct[]	排除的人群，注意这是个二维数组，第一层数组元素之间为 AND 关系，第二层数组元素之间为 OR 关系 数组最大长度 500
audience_id*	integer	人群 id 或标签 id，通过 [custom_audiences] 模块创建客户人群或[custom_tags] 模块创建客户标签获得，即此处支持填写"audience_id":"<AUDIENCE_ID>"，也支持填写"audience_id":"<TAG_ID>"，不支持 LOOKALIKE 和 COMBINE 人群的 id
time_window	integer	时间窗，仅对客户标签有效，目前仅支持以下几个时间窗选项：1、3、7、10、15、30、90、180、365 最小值 1，最大值 365
platform	enum	数据应用，不填写默认为 DMP，[枚举详情] 枚举列表：{ DMP, TDC, TDP }