跳转至

广告单元修改

广告单元关键字段修改

请求地址

v2: https://openapi.aiclk.com/openapi/v1/adgroup/update_v2

所属权限

ads_write

请求方式

POST

Header: Content-Type: application/json

请求参数

请求Url中添加参数:

字段名 类型 是否必须 描述
account_id int 广告主ID(广告投放平台的userID)

Post-Body添加参数:

字段名 类型 是否必须 描述
adgroup_id int 单元ID
adgroup_name 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或iOS。枚举值
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表示不限频次
bid int CPC/CPM/oCPX点击出价,单位:分
cpa_bid int 目标转化出价,单位:分
deep_cpa_bid int 深度转化出价,深度oCPX时必传,单位:分
configure_status string 单元状态
开启-ENABLE,暂停-PAUSED,删除-DELETED
对于已删除的单元不可进行任何操作
retention_rate float 目标次留率,深度oCPX,深度转化目标为次留并且目标考核方式为双目标均达成时可填。
数值为大于等于10%,小于等于60%的百分数,精确到小数点后两位。
深度转化出价与目标次留率同时只能传一个值。
ocpx_expand string oCPX扩量工具,开启-ENABLE,关闭-DISABLE

请求示例

curl -X POST \
  'https://openapi.aiclk.com/openapi/v1/adgroup/update?account_id=1000009' \
  -H 'Content-Type: application/json' \
  -H 'OGW_ACCESS_TOKEN: your_access_token' \
  -d '{"adgroup_id":111111,"adgroup_name":"单元名称","configure_status":"ENABLE","bid":200000,"cpa_bid":100000,"deep_cpa_bid":300000}'

返回字段释义

字段名 类型 描述
code int 返回码
message string 接口信息
data object 返回值

返回示例

{
   "code":200,
   "data":null,
   "message":"success"
}