新建广告单元
通过该接口可以新建广告单元
请求地址
v2: https://openapi.aiclk.com/openapi/v1/adgroup/create_v2
所属权限
ads_write
请求方式
POST
Header: Content-Type: application/json
请求参数
请求Url中添加参数:
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| account_id | int | 是 | 广告主ID(广告投放平台的userID) |
Post-Body添加参数:
| 字段名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| campaign_id | int | 是 | 计划ID |
| adgroup_name | string | 是 | 单元名称 |
| adslot_type | string | 是 | 广告类型。枚举值,仅v1接口可用 |
| adslot_type_group | []string | 是 | 广告类型。枚举值 |
| media_type | string | 是 | 投放媒体类型。枚举值 联盟头部流量可多选,用逗号”,“分隔,仅v1接口可用 |
| media_group | []string | 是 | 投放媒体类型。枚举值 |
| regions | []int | 否 | 地域定向,不传默认不限,与regions_district二选一,不可同时传非空;如需显式设置为不限,regions和regions_district均传空数组。枚举值 |
| regions_district | []int | 否 | 省市区(县)地域定向,不传默认不限,与regions二选一,不可同时传非空,最多支持1000处;如需显式设置为不限,regions和regions_district均传空数组。枚举值 |
| gender | string | 否 | 性别定向,不传默认不限。枚举值 |
| age | []string | 否 | 年龄定向,不传默认不限。枚举值 |
| audience_orient | []int | 否 | 人群包定向,不传默认不限 人群包ID可以通过人群包接口查询 |
| audience_orient_filter | []int | 否 | 人群包排除,不传默认不排除。人群包ID可以通过人群包接口查询 |
| user_orient | string | 否 | 新老用户定向,不传默认不限。枚举值 |
| os_type | string | 否 | 设备操作系统定向,计划为应用推广和快应用不传默认Android,其余不传默认不限。枚举值 |
| mobile | []string | 否 | 手机类型定向,不传默认不限。枚举值 |
| tel_brand_choice | string | 否 | 手机品牌定向,不传默认不限。设备操作系统定向为Android时可用,同一手机品牌和排除不能共存。枚举值 |
| tel_brand_exclude | string | 否 | 手机品牌排除,不传默认不限。设备操作系统定向为Android时可用,同一手机品牌和排除不能共存。枚举值 |
| network_type | []string | 否 | 网络定向,不传默认不限。枚举值 |
| hours | []int | 否 | 投放时段,不传默认全时段投放。 具体的格式参考:时间格式示例 |
| app_package | string | 否 | 安装包定向开关,不传默认关闭 允许值:开启-ENABLE,关闭-DISABLE |
| app_package_value | []string | 否 | 安装包定向,开启安装包定向时必填 1、安装包不可以重复 2、数量不能超过10个 3、安装包在排除包中不能共存 4、不能是中文,只能是大小写字母和点 |
| app_filter | string | 否 | 是否开启安装包排除,不传默认关闭 允许值:开启-ENABLE,关闭-DISABLE |
| app_filter_value | []string | 否 | 排除的安装包列表,开启安装包排除时必填 1、安装包不可以重复 2、数量不能超过10个 3、安装包在排除包中不能共存 4、不能是中文,只能是大小写字母和点 |
| conversion_filter_orient | string | 否 | 过滤已转化用户,枚举值,付费方式为oCPX时可填,默认不限 |
| conversion_filter_orient_duration | string | 否 | 过滤时间,枚举值,当过滤已转化用户为“本账户”、“公司主体”、“本产品”、“包名”时必填 |
| conversion_goal_filter | string | 否 | 过滤已转化目标,枚举值,当过滤已转化用户为“计划”、“单元”、“本账户”、“公司主体”、“本产品”、“包名”时必填 |
| pack_name_value | []string | 否 | 过滤已转化包名时必填 1、包名不可以重复 2、数量不能超过10个 3、不能是中文,只能是大小写字母和点 |
| transfer_optimize | string | 否 | 调起优化,仅限charge_type为CPC时使用,不传默认不使用,枚举值 |
| device_orient | []string | 否 | 设备定向 不可以重复 |
| frequency | int | 是 | 展现频次,允许值:整数0-10。0表示不限频次 |
| click_frequency | int | 是 | 点击频次,允许值:整数0-10。0表示不限频次 |
| charge_type | string | 是 | 付费方式。枚举值 |
| conversion_goal | string | 否 | 转化目标,付费方式为oCPX时必传。枚举值 |
| conversion_from | string | 否 | 转化追踪方式,付费方式为oCPX时必传。枚举值 |
| is_deep_ocpx | string | 否 | 是否为深度oCPX,默认否。允许值:是-ENABLE,否-DISABLE 付费方式为oCPX时必传 |
| deep_conversion_goal | string | 否 | 深度转化目标,深度oCPX时必传,枚举值 |
| bid | int | 是 | CPC/CPM/oCPX方式的点击出价,单位:分 |
| cpa_bid | int | 否 | 目标转化出价,当付费方式为oCPX时必填,单位:分 |
| deep_cpa_bid | int | 否 | 深度转化出价,深度oCPX时必传,单位:分 |
| retention_rate | float | 否 | 目标次留率,深度oCPX,深度转化目标为次留时可填。 数值为大于等于10%,小于等于60%的百分数,精确到小数点后两位。 深度转化出价与目标次留率同时只能传一个值。 |
| ocpx_expand | string | 否 | oCPX扩量工具,付费方式为oCPX时可填,默认关闭 允许值:开启-ENABLE,关闭-DISABLE |
| configure_status | string | 否 | 单元状态: 开启-ENABLE,暂停-PAUSED |
Body 示例
{
"campaign_id": 1535350,
"adgroup_name": "测试Name",
"bid": 15,
"cpa_bid": 50,
"deep_cpa_bid": 60,
"audience_orient": [],
"audience_orient_filter": [],
"user_orient": "NEW",
"charge_type": "OCPM",
"adslot_type": "ENGAGEMENT",
"media_type": "QTT",
"regions": [1,2],
"gender": "MALE",
"age": ["BELOW_EIGHTEEN","EIGHTEEN_TO_TWENTY_TWO"],
"os_type": "COMMON",
"mobile": ["HIGH","MIDDLE"],
"network_type": ["WIFI"],
"hours": [],
"app_package": "ENABLE",
"app_package_value": [
"abc.apk"
],
"app_filter": "DISABLE",
"app_filter_value": [],
"device_orient": ["100100020"],
"frequency": 3,
"click_frequency": 3,
"conversion_goal": "ACTIVATION",
"conversion_from": "API",
"cpa_check_priority": "GOAL",
"ocpx_expand": "ENABLE",
"is_deep_ocpx": "ENABLE",
"media_group": ["QTT"],
"tel_brand_choice": "华为,OPPO",
"tel_brand_exclude": "阿尔卑斯,台电"
}
请求示例
curl --location 'https://openapi.aiclk.com/openapi/v1/adgroup/create?account_id=1000002' \
--header 'Content-Type: application/json' \
--header 'OGW_ACCESS_TOKEN: your_access_token' \
--data '{
"campaign_id": 1535350,
"adgroup_name": "测试Name",
"bid": 15,
"cpa_bid": 50,
"deep_cpa_bid": 60,
"audience_orient": [],
"audience_orient_filter": [],
"user_orient": "NEW",
"charge_type": "OCPM",
"adslot_type": "ENGAGEMENT",
"media_type": "QTT",
"regions": [1,2],
"gender": "MALE",
"age": ["BELOW_EIGHTEEN","EIGHTEEN_TO_TWENTY_TWO"],
"os_type": "COMMON",
"mobile": ["HIGH","MIDDLE"],
"network_type": ["WIFI"],
"hours": [],
"app_package": "ENABLE",
"app_package_value": [
"abc.apk"
],
"app_filter": "DISABLE",
"app_filter_value": [],
"device_orient": ["100100020"],
"frequency": 3,
"click_frequency": 3,
"conversion_goal": "ACTIVATION",
"conversion_from": "API",
"cpa_check_priority": "GOAL",
"ocpx_expand": "ENABLE",
"is_deep_ocpx": "ENABLE",
"media_group": ["QTT"],
"tel_brand_choice": "华为,OPPO",
"tel_brand_exclude": "阿尔卑斯,台电"
}'
返回字段释义
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 返回码 |
| message | string | 接口信息 |
| data | object | 返回值 |
| - adgroup_id | int | 单元ID |
返回示例
{
"code":200,
"data":{
"adgroup_id": 1743623
},
"message":"success"
}