跳转至

批量修改广告单元

批量修改广告单元,支持同时修改多个单元的字段信息,每次最多支持10个单元。每个单元的可修改字段与修改广告单元接口一致。

请求地址

https://openapi.aiclk.com/openapi/v2/adgroup/batch-update-v2

所属权限

ads_write

请求方式

POST

Header: Content-Type: application/json

请求参数

请求Url中添加参数:

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

Post body(json)

json体是一个列表结构,列表最多包含10个元素,不允许出现重复的adgroup_id。列表中的每一个元素结构如下:

字段名 类型 是否必须 描述
adgroup_id int 单元ID
adgroup_name string 单元名称
configure_status string 单元状态,允许值:ENABLE, PAUSED, DELETED
对于已删除的单元不可进行任何操作
bid int CPC/CPM/oCPX点击出价,单位:分
cpa_bid int 目标转化出价,单位:分
deep_cpa_bid int 深度转化出价,深度oCPX时必传,单位:分
regions []int 地域定向,传空数组表示不限。枚举值
gender string 性别定向。枚举值
age []string 年龄定向,传空数组表示不限。枚举值
audience_orient []int 人群包定向,传空数组表示不作限制。
可以通过人群包接口查询ID
audience_orient_filter []int 人群包排除,传空数组表示不作限制。
可以通过人群包接口查询ID
user_orient string 新老用户定向,枚举值
os_type string 设备操作系统定向,枚举值
mobile []string 手机类型定向,传空数组表示不限。枚举值
tel_brand_choice string 手机品牌定向,不传默认不限。枚举值
tel_brand_exclude string 手机品牌排除,不传默认不限。枚举值
network_type []string 网络定向,传空数组表示不限。枚举值
hours []int 投放时段,传空数组表示全时段投放。
具体的格式参考:时间格式示例
app_package string 安装包定向开关,允许值:开启-ENABLE,关闭-DISABLE
app_package_value []string 安装包定向列表
app_filter string 安装包排除开关,允许值:开启-ENABLE,关闭-DISABLE
app_filter_value []string 排除的安装包列表
device_orient []string 设备定向,传空数组表示不限
frequency int 展现频次,允许值:整数0-10。0表示不限频次
click_frequency int 点击频次,允许值:整数0-10。0表示不限频次
conversion_filter_orient string 过滤已转化用户,枚举值
conversion_filter_orient_duration string 过滤时间,枚举值
conversion_goal_filter string 过滤已转化目标,枚举值
pack_name_value []string 过滤已转化包名
transfer_optimize string 调起优化,仅限charge_type为CPC时使用,枚举值
retention_rate float 目标次留率,深度oCPX时可填
ocpx_expand string oCPX扩量工具,开启-ENABLE,关闭-DISABLE

备注:

更多字段说明请参考修改广告单元接口文档。

Body 示例

[
    {
        "adgroup_id": 111111,
        "adgroup_name": "修改单元名称1",
        "bid": 200000,
        "configure_status": "ENABLE"
    },
    {
        "adgroup_id": 222222,
        "regions": [110000, 310000],
        "hours": [16777215, 16777215, 16777215, 16777215, 16777215, 16777215, 16777215]
    }
]

请求示例

curl -X POST \
  'https://openapi.aiclk.com/openapi/v2/adgroup/batch-update-v2?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},{"adgroup_id":222222,"regions":[110000,310000]}]'

返回字段释义

字段名 类型 描述
code int 返回码
message string 返回信息
data object 更新结果
-success_ids []int 更新成功的单元ID列表
-errors []object 更新失败的单元信息列表
--adgroup_id int 更新失败的单元ID
--message string 失败原因

返回示例

全部成功

{
    "code": 200,
    "message": "success",
    "data": {
        "success_ids": [111111, 222222],
        "errors": []
    }
}

部分成功

{
    "code": 200,
    "message": "success",
    "data": {
        "success_ids": [111111],
        "errors": [
            {
                "adgroup_id": 222222,
                "message": "单元不存在"
            }
        ]
    }
}