创建定向模板
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
https://ad.e.kuaishou.com/rest/openapi/gw/dsp/target/template/create
请求参数
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| advertiser_id | long | 必填 | 广告主 ID | 在获取 accessToken 的时候返回 |
| template_name | string | 必填 | 定向模板名称 | 名字需要唯一 |
| target | struct | 定向信息 | 如下 |
target
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| region | long[] | 可选 | 地域 | 传值为 [] 表示不限，传递上一级 id 时，children id 可以不传，不允许同时传 parent id 和 children id， 地域信息可通过 /region/list 接口获取 |
| district_ids | long[] | 可选 | 商圈定向 | 与 region 字段不能同时传、白名单控制，最多选 100 个。 可以通过/rest/openapi/v1/region/district/list 接口获取商圈信息 |
| behavior_interest | struct | 非必填 | 行为兴趣定向 | |
| user_type | int | 可选 | 用户类型 | 0：实时 1：常驻 2：不限 |
| ages_range | int [] | 可选 | 可选年龄段 | 18：18-23 岁 24：24-30 岁 31：31-40 岁 41：41-49 岁 50：50-100 岁 |
| age | struct | 可选 | 自定义年龄段 | 年龄最小限制，大于等于 18 min 和 max 年龄区间最小为 5 岁 |
| gender | int | 可选 | 性别 | 1：女性, 2：男性，0 表示不限 |
| platform_os | int | 可选 | 定向的 os 版本 | 应用安装类计划以 app_id 中的 platform_os 为准 1：Android，2：iOS，0 表示不限 |
| android_osv | int | 可选 | Android 版本 | 3：不限，4：4.x+，5：5.x+，6：6.x+，7：7.x+，8：8.x+，9：9.x+，10：10.x+； |
| ios_osv | int | 可选 | iOS 版本 | 6：不限，7：7.x+，8：8.x+，9：9.x+，10：10.x+；11：11.x+；12：12.x+；13：13.x+；14：14.x+；15：15.x+；16：16.x+； |
| network | int | 可选 | 网络环境 | 1：WI-FI，2：移动网络，0：表示不限 |
| filter_converted_level | int | 可选 | 过滤已转化人群纬度 | 0：不限 1：广告组 2：广告计划 3：本账户 4：公司主体 5：APP |
| device_brand | int[] | 可选 | 设备品牌 | 传值为[]表示不限；当 platform为iOS定向时，没有设备品牌定向；1：苹果（platform字段为空时可选）；2：VIVO；3：OPPO；4：华为；5：小米；6：荣耀；7：三星；8：魅族；9：金立；10：HTC；11：联想；12：酷派；13：酷比；14：中兴；15：乐视；16：LG；17：中国移动；18：360；19：百度；20：努比亚；21：一加；22：海信；23：朵唯；24：美图；25：锤子；26：谷歌；27：小辣椒；28：诺基亚；29：康佳 |
| device_price | int[] | 可选 | 设备价格， | 1：1,500 元以下（近期下线）， 新增：11：1000以下，12：1001 |
| app_interest_ids | long[] | 可选（新） | APP 行为-按分类 | id 不能重复且必须准确，具体 id 可通过下方标签接口获取；仅包含安卓数据，若操作系统定向 IOS 则无效；不能同时选择 app_ids（新标签体系字段，替换 app_interest，与 app_interest 同时传递，app_interest 字段失效） |
| app_ids | long[] | 可选 | APP 行为-按 APP 名称 | 可通过 /rest/openapi/v1/tool/app/search 查询 1、APP 行为定向，id 不能重复且必须准确； 2、只有「提升应用安装」的计划且 Android 应用支持此定向；其他计划填写无效； 3、iOS 不支持行为定向，填写无效；app_ids 和 app_interest_ids 不能同时选择 |
| population | long[] | 可选 | 定向人群包 | 可通过/rest/openapi/v1//dmp/population/list 查询 1、定向人群包，人群包 id 不能重复且必须准 确 2、人群包状态必须是已推送状态 |
| paid_audience | long[] | 可选 | 付费人群包 | 可通过/rest/openapi/v1//dmp/population/list 查询 1、付费人群包，人群包 id 不能重复且必须准确 2、人群包状态必须是已推送状态，与定向、排除人群包互斥 |
| exclude_population | long[] | 可选 | 排除人群包 | 1、排除人群包，人群包 id 不能重复且必须准确；人群包状态必须是已推送状态 2、如果同时传了 population 和 exclude_population，则表示同时定向排除； 3、population 和 exclude_population 这两个字段不能包含交集的 id |
| intelli_extend_option | int | 可选 | 智能定向开关 | 0：表示自定义定向（默认）；1：智能定向 |
| behavior_type | int | 可选 | 行为兴趣类型 | 0：默认；1：自定义行为意向；2：行为意向系统优选 |
| celebrity | struct | 选填 | 快手网红 | behaviors、fans_star两个字段必填充 |
| media_source_type | int | 选填 | 媒体包来源 | 默认为 0，0-不限，1-行业优质流量包，2-广告主自定义 |
| media | long[] | 选填 | 媒体定向包 | 若选择使用定向行业优质流量包（media_source_type = 1），此处单选：1 - 超休闲游戏；2 - 重度游戏；4 - 直营电商；5 - 平台电商；若选择使用广告主自定义媒体包（media_source_type = 2），此处多选，填写媒体包 id【仅联盟广告位生效】 |
| exclude_media | long[] | 选填 | 媒体定向排除包 | media 和 exclude_media 只可选其一，若选择使用排除行业优质流量包（media_source_type = 1），此处单选：1 - 超休闲游戏；2 - 重度游戏；4 - 直营电商；5 - 平台电商；若选择使用广告主自定义媒体包（media_source_type = 2），此处多选，填写媒体包 id；【仅联盟广告位生效】 |
| seed_population | long[] | 选填 | 种子人群包 | 当账户开通种子人群包功能后方可使用此功能。该定向仅支持快手站内广告位，不支持联盟广告位。 |
| ip_type | int | 选填 | 地域IP类型 | 白名单可用，0-默认IP、1-广协IP |
age
| 字段 | 类型 | 说明 | 备注 | |
|---|---|---|---|---|
| min | int | 可选 | 年龄最小值 | 年龄最小限制，大于等于 18 |
| max | int | 可选 | 年龄最大值 | 年龄最大限制，少于等于 55 |
behavior_interest
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| behavior | struct | 必填 | 行为定向 | behavior 与 interest 同时不传，则清空行为兴趣定向 |
| interest | struct | 选填 | 兴趣定向 | behavior 与 interest 同时不传，则清空行为兴趣定向 |
behavior
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| keyword | struct[] | 非必填 | 行为定向关键词 | 根据/rest/openapi/v1/tool/keyword/query 接口获取 |
| label | string[] | 非必填 | 行为定向 类目词 | 根据/rest/openapi/v1/tool/label/behavior_interest 接口获取。将行为类目 id 从最高层类目 id 开始，以“-”连接起来，假如有一个类目 id 为 80202，父类目 id 为 802，最高层类目 id 为 8，则此时应该写"8-802-80202"；如果想全选最高层类目"8"底下的所有子类目，填"8" |
| time_type | int | 必填 | 在多少天内发生行为的用户 | 0:7 天 1：15 天 2：30 天 3：90 天 4：180 天 |
| strength_type | int | 必填 | 行为强度 | 0：不限 1：高强度 |
| scene_type | int[] | 必填 | 行为场景 | 1：社区 2：APP 3：电商 4：推广 |
keyword
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| id | long | 必填 | 关键词 id | id 与 name 需互相匹配 |
| name | string | 必填 | 关键词名称 | id 与 name 需互相匹配 |
interest
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| label | string[] | 非必填 | 兴趣定向类目词 | 根据/rest/openapi/v1/tool/label/behavior_interest 接口获取。将兴趣类目 id 从最高层类目 id 开始，以“-”连接起来，假如有一个类目 id 为 80202，父类目 id 为 802，最高层类目 id 为 8，则此时应该写"8-802-80202"；如果想全选最高层类目"8"底下的所有子类目，填"8" |
| strength_type | int | 必填 | 兴趣标签强度 | 0：不限 1：高强度 |
celebrity
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| behaviors | int[] | 必填 | 行为类型 | 该字段为平台对应快手网红功能中的行为类型，可多选，但不可不选，不选会导致快手网红定向失效，定义如下 0:关注、1:视频互动、2:直播互动 |
| fans_stars | fans_star[] | 必填 | 网红内容 | 该字段包括平台对应快手网红功能中的网红分类和快手网红两项，数据保证录入顺序，可从【快手网红-网红分类】和【快手网红-搜索快手网红】接口获取对应数据 |
fans_star
| 字段 | 类型 | 是否必填 | 说明 | 备注 |
|---|---|---|---|---|
| id | string | 如使用该 功能则必填此项，该字段有两种含义 1、当是网红分类，即type=1时，该字段传入对应网红分类对应的父ID与当前ID的拼接字符串，如传入"33-177"表示一级网红分类"游戏"下的二级网红分类"沙盒游戏"，如选中的是一级网红分类，则直接传入当前ID如"33" 2、当是快手网红，即type=2时，该字段传入对应快手网红的author_id，如传入"1151465119"表示快手网红小脑斧来自N次元 | ||
| type | int | 如使用该功能则必填此项，该字段为平台对应快手网红功能中的网红分类和快手网红两项，可从【快手网红-网红分类】和【快手网红-搜索快手网红】接口获取对应数据 1:网红分类、2:快手网红 | ||
| name | string | 如使用该功能则必填此项，该字段有两种含义 1、当是网红分类，即type=1时，该字段传入对应网红分类对应的父name与当前name的拼接字符串，如传入"游戏-沙盒游戏"表示一级网红分类"游戏"下的二级网红分类"沙盒游戏"，如选中的是一级网红分类，则直接传入当前ID如"游戏"，保证传入的值与传入id对应网红标签name（拼接）一致 2、当是快手网红，即type=2时，该字段传入对应快手网红的kwai_id，如传入"小脑斧来自N次元"表示快手网红小脑斧来自N次元，保证传入的值与传入id对应的快手网红的kwai_id保持一致 | ||
| category | int[] | 当是快手网红，即type=2时，该字段传值有效，对应当前快手网红的分类，格式为first_label_id,second_label_id，如果second_label_id不存在，则只传入first_label_id，如传入32, 241表示当前快手网红属于影视-影视分类二级网红分类 |
请求参数
Body 参数application/json
返回响应
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ad.e.kuaishou.com/rest/openapi/gw/dsp/target/template/create' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": 123123,
"template_name": "这是一个模板"
"target": {
"celebrity": {
"fans_stars": [
{
"name": "生活-亚洲生活",
"id": "26-228",
"category": null,
"type": 1
},
{
"name": "生活-欧洲生活",
"id": "26-118",
"category": null,
"type": 1
}
],
"behaviors": [
1
]
},
"gender": 2,
"media": [],
"network": 0,
"device_price": [
5,
6,
7
],
"media_source_type": 0,
"target_source": null,
"user_type": 0,
"exclude_population": [
950011889
],
"device_brand_ids": [],
"district_ids": null,
"ages_range": [
31,
41,
50
],
"android_osv": 3,
"app_ids": null,
"disable_installed_app_switch": 0,
"behavior_type": 1,
"app_names": null,
"filter_converted_level": 0,
"filter_time_range": 0,
"platform_os": 1,
"population": [
950012677
],
"business_interest": null,
"behavior_interest": {
"interest": {
"strength_type": 1,
"label": [
"1-101",
"1-103",
"1-104"
],
"keyword": []
},
"behavior": {
"strength_type": 1,
"time_type": 4,
"label": [
"1-101"
],
"keyword": [],
"scene_type": [
1,
2,
3,
4
]
}
},
"seed_population": null,
"ios_osv": null,
"app_interest_ids": [],
"paid_audience": [],
"intelli_extend_option": 0,
"region": [
110101
],
"exclude_media": []
}
}'响应示例响应示例
{
"code": 0,
"message": "OK",
"data": {
"template_id": 2959088
}
}
修改于 2023-10-25 02:15:05