任务
1、创建任务
通过此接口可以创建任务
请求地址
https://ads.cloud.huawei.com/openapi/v2/promotion/adgroup/create
请求方法
POST
请求参数
参数名称 |
类型 |
是否必选 |
描述 |
adgroup_name |
string |
是 |
任务名称必填,最大长度不得超 128,正则 regexp=” ^[^^|]+$”,不能重名 |
campaign_id |
string |
是 |
计划 ID 最大长度不得超 50,必 填,只能填写数字, 正则 regexp=”^[^^\n|]+$” 注:该任务所属计划和产品上的 产品类型需一致 详见【创建计划】 |
channel_package_id |
string |
否 |
渠道包 ID 即查询渠道包接口中返回的 channel_package_id; 注:推广产品类型 product_type 为 ANDROID_APP 时用到 详见【查询渠道包】 |
targeting_template_id |
long |
是 |
定向模板 ID 即创建定向模板接口中返回的 targeting_template_id; 注:非 APP 的推广产品不能有 APP 安装定向; 定向模板仅用于创建广告时快捷 选择定向条件;编辑定向模板, 不会自动将定向内容同步到与此 定向模板相关联的广告中。 详见【创建定向模板】 |
product_id |
long |
是 |
推广产品 ID 即创建推广产品中接口中返回的 product_id; |
注:任务上非 app 的产品 ID 和 任务 ID 为一对一对应关系。 计划和产品上的产品类型需一致 详见【创建推广产品】 |
|||
adgroup_begin_time |
string |
是 |
投放开始日期,格式:YYYY- MM-DD 如: 2020-01-01 注:开始时间不能小于当前时 间,开始时间不能大于结束时 间; 开始时间和结束时间差值需要在 5.1.1 查询版位获得的投放此版 位的任务最短和最长投放时间范 围之内 |
adgroup_end_time |
string |
否 |
投放结束日期,格式:YYYY- MM-DD,为空表示长期投投放 如: 2020-01-02 注:若存在结束时间,那么结束 时间不能小于开始时间 |
time_period_type |
string |
是 |
时间段类型,可以从三种类型中 根据自己需要选择一个。 版位查询到的 is_support_time_period 要有权限 time_period 为空时, 时间段类型 不得为 TIME_PERIOD_DAY_SPECIFIC 或 TIME_PERIOD_HOUR_SPECIFI C 详见【时间段类型】 |
time_period |
string |
否 |
time_period_type 为 TIME_PERIOD_DAY_SPECIFIC 、 TIME_PERIOD_HOUR_SPECIFI C 时必填。且满足正则 ^[01]{336}$ 按照特定时间段投放时, 01010100010010……表示指定特 殊时段,半小时为粒度,用 0 、 1 标识是否选中, 1 为选中, 0 为未选中。一天 24 小时,即每 天 24*2=48 位,共 7 天,即共 48*7=336 位 |
如果 time_period_type 为 TIME_PERIOD_ALL,则表示一 周内每天的特定小时,需要每 48 个值都重复。 注:时间段要与任务的日期区间 有交集。 例:如果任务开始时间是 2020- 06-22 (周一), 结束时间是 2020-06-24 (周三) ,且选择的 类型是 TIME_PERIOD_DAY_SPECIFIC 或 TIME_PERIOD_HOUR_SPECIFI C,那 time_period 的入参需要与 任务的时间段有交集;若用户想 在 22/23/24 的每天早上 6 点到 9 点投放任务,则 time_period 的 参数可表示为 00000000000011111100…0000… (共 336 位, 每 48 位代表一天 24 小时,重复 7 次) |
|||
price_type |
string |
是 |
出价方式 注: CPM (Cost Per Mille), CPC (Cost Per Click), CPD (Cost Per Download) 详见【付费方式】 |
price |
float |
是 |
出价,整数位不得超过 9 位, 小 数位不得超 2 位; 注:范围在计划日限额和对应出 价方式查询版位底价之间 |
conversion_cost |
float |
否 |
期望转化成本, price_type 为 PRICING_OCPC 时专用, 暂时 只支持 APP 和网页。 整数位不得超过 9 位,小数位不 得超 2 位 |
creative_size_id |
long |
是 |
版位 ID 详见【查询版位】 |
channel_info |
string |
否 |
转化跟踪参数 不得超 1024 位 只允许出现英文字母大小写、数 字、中划线、下划线。 |
dyn_price_flag |
string |
否 |
智能提价标志 仅当推广产品为 |
ANDROID_APP 且定向模板中 installed_apps_struct 值为 true 时 有效 详见【智能提价标志】 |
|||
dyn_price_upper_limit |
float |
否 |
dyn_price_flag 为 DYNAMIC_PRICE_ENABLE 时 必填 智能提价上限,范围在 1 到 10 之间, 整数位不得超过 2 位,小数位不 得超 1 位 |
tracking_id |
long |
否 |
转化跟踪指标 ID ,price_type 为 PRICING_OCPC 时必填 |
请求示例
=================================================================== =======================================POST
/openapi/v2/promotion/adgroup/create HTTP/1. 1
Accept:application/json
Content-Type:application/json
Authorization:Bearer CgB6e3x9ERGComr9dENxZX22iBk+mLuf1yGtQVPUjPJUMrstfKlqpdXk+kfHU9J8ZJ/soY IZHZzT446GeSYumluQuhsK7jvz4kz1Bkms4CLI/rE=
{
"adgroup_name":"营销大促任务",
"campaign_id":"35003379",
"targeting_template_id":65002521,
"product_id":4100227,
"adgroup_begin_time":"2020-05-09",
"adgroup_end_time":"2020-05- 10",
"time_period_type":"TIME_PERIOD_ALL",
"price_type":"PRICING_CPM",
"price":100,
"creative_size_id":1,
"dyn_price_flag":"DYNAMIC_PRICE_DISABLE",
"dyn_price_upper_limit":1
}
=================================================================== =======================================
响应字段
参数名称 |
类型 |
是否必选 |
描述 |
code |
string |
是 |
返回码 |
message |
string |
否 |
返回描述 |
data |
Struct1 |
否 |
任务 ID |
ruct1)定义
参数名称 |
类型 |
是否必选 |
描述 |
adgroup_id |
long |
是 |
任务 ID |
应答示例
=================================================================== ======================================
HTTPS/1. 1 200 OK
{
"code":200 ,
"data":{
"adgroupId":45003296
}
}
=================================================================== ======================================
2、查询任务
通过此接口可以查询任务
请求地址
https://ads.cloud.huawei.com/openapi/v2/promotion/adgroup/query
请求方法
GET
请求参数
参数名称 |
类型 |
是否必选 |
描述 |
page_num |
integer |
是 |
搜索页码 取值范围 1~10000 |
page_size |
integer |
是 |
一页展示数量 取值范围 10~50 |
以下为过滤条件 |
|||
campaign_id |
string |
否 |
计划 ID 最大长度不得超 50,必 填,只能填写数字, 不能使用 “^”和换行 |
adgroup_name |
string |
否 |
任务名称 注:字段不能为 null |
adgroup_ids |
long[] |
否 |
任务 ID 列表 |
product_type |
string |
否 |
推广产品 详见【推广产品】 |
product_id |
long |
否 |
推广产品 ID 注:任务上非 app 的产品 ID 和 任务 ID 为一对一关系。 计划和产品上的产品类型需一 致 |
store_app_id |
string |
否 |
华为应用市场 APP ID ,如: C12345 |
updated_begin_time |
string |
否 |
任务更新的开始时间,格 式:"yyyy-MM-dd HH:mm:ss" |
updated_end_time |
string |
否 |
任务更新的结束时间,格 式:"yyyy-MM-dd HH:mm:ss" |
请求示例
=================================================================== ======================================
GET
/openapi/v2/promotion/adgroup/query?page_num=1&page_size=10&campaign_id=3004340 &adgroup_ids=[123,456]&product_type=ANDROID_APP&app_install_flag=APP_INSTAL LED&product_id=C12345&store_app_id=1
HTTP/1. 1
Accept:application/json
Content-Type:application/json
Authorization:Bearer CgB6e3x9ERGComr9dENxZX22iBk+mLuf1yGtQVPUjPJUMrstfKlqpdXk+kfHU9J8ZJ/soY IZHZzT446GeSYumluQuhsK7jvz4kz1Bkms4CLI/rE=
=================================================================== ======================================
响应字段
参数名称 |
类型 |
是否必选 |
描述 |
code |
string |
是 |
返回码 |
message |
string |
否 |
返回描述 |
data |
Struct1 |
否 |
任务列表 |
data(Struct1)定义
参数名称 |
类型 |
是否必选 |
描述 |
total |
integer |
是 |
任务总条数 |
data |
Struct2[] |
否 |
任务列表 |
data(Struct2)定义
参数名称 |
类型 |
是否必选 |
描述 |
adgroup_name |
string |
是 |
任务名称 |
adgroup_id |
long |
是 |
任务 ID |
campaign_id |
string |
是 |
计划 ID |
campaign_name |
string |
是 |
计划名称 |
adgroup_status |
string |
是 |
任务操作状态 详见【计划/任务/创意操作状 态】 |
channel_package_id |
integer |
否 |
渠道包 ID 详见【创建渠道包】 |
campaign_daily_budget _status |
string |
否 |
计划日限额状态 详见【计划日限额状态】 |
show_status |
string |
是 |
界面显示的状态 详见【任务界面显示的状态】 |
targeting_id |
long |
是 |
任务定向包 ID |
详见【创建定向包】 |
|||
product_id |
long |
是 |
推广产品 ID 详见【创建推广产品】 |
adgroup_begin_time |
string |
是 |
投放开始日期,格式:YYYY- MM-DD 如: 2020-01-01 |
adgroup_end_time |
string |
是 |
投放结束日期,格式:YYYY- MM-DD,为空表示长期投投放 如: 2020-01-02 1. 如果是长期投放,结束时间 为空,自动补充 |
time_period_type |
string |
否 |
时间段类型 详见【时间段类型】 |
time_period |
string |
否 |
time_period_type 为 TIME_PERIOD_DAY_SPECIFIC 、 TIME_PERIOD_HOUR_SPECIFI C 时有值。 按照特定时间段投放时, 01010100010010……表示指定特 殊时段,半小时为粒度,用 0 、 1 标识是否选中, 1 为选中, 0 为未选中。一天 24 小时,即每 天 24*2=48 位,共 7 天,即共 48*7=336 位 |
price_type |
string |
是 |
出价方式 详见【付费方式】 |
price |
float |
是 |
出价 |
conversion_cost |
float |
否 |
期望转化成本, price_type 为 PRICING_OCPC 时专用 |
ocpc_status |
string |
否 |
oCPC 学习状态,price_type 为 PRICING_OCPC 时专用 详见【oCPC 学习状态】 |
creative_size_type |
string |
是 |
版位形式 详见【版位形式】 |
creative_size_sub_type |
string |
是 |
版位子形式 详见【版位子形式】 |
creative_size_id |
long |
是 |
版位 ID |
channel_info |
string |
否 |
转化跟踪参数 |
dyn_price_flag |
string |
否 |
智能提价标志 仅当推广产品为 ANDROID_APP 且定向模板中 installed_apps_struct 值为 true 时 有效 详见【智能提价标志】 |
dyn_price_upper_limit |
float |
否 |
智能提价上限 dyn_price_flag 为 DYNAMIC_PRICE_ENABLE 时 有效 |
tracking_id |
long |
否 |
转化指标 ID |
应答示例
=================================================================== =======================================
HTTPS/1. 1 200 OK
{
"code": "200",
"data": {
"total": 6897,
"data": [{
"adgroup_id": 45002510,
"campaign_name": "ceshiaa",
"targeting_id": 65001925,
"price": "10.00",
"product_id": 3001269,
"app_install_flag": "APP_NOT_INSTALLED",
"campaign_daily_budget_status": "CAMPAIGN_DAILY_BUDGET_NOT_EXCEED", "show_status": "ADGROUP_STATUS_AUDIT",
"campaign_id": "35002563",
"creative_size_type": "CREATIVE_SIZE_TYPE_SINGLE_PICTURE",
"tracking_id": 35000225,
"time_period_type": "TIME_PERIOD_ALL",
"creative_size_subtype": "FEED_SMALL_PICTURE",
"creative_size_id": 5,
"adgroup_begin_time": "2020-04-21",
"ocpc_status": "OCPC_STATUS_STUDY",
"price_type": "PRICING_OCPC",
"conversion_cost": "20.00",
"adgroup_status": "OPERATION_STATUS_ENABLE",
"adgroup_name": "ceshiTbr"
},
{
"adgroup_id": 45002509,
"campaign_name": "美丽传说大促",
"targeting_id": 65001924,
"price": "2.00",
"product_id": 3001269,
"app_install_flag": "APP_INSTALLED",
"campaign_daily_budget_status": "CAMPAIGN_DAILY_BUDGET_NOT_EXCEED", "show_status": "ADGROUP_STATUS_AUDIT",
"campaign_id": "35002563",
"creative_size_type": "CREATIVE_SIZE_TYPE_SINGLE_PICTURE",
"tracking_id": 35000225,
"time_period_type": "TIME_PERIOD_ALL",
"creative_size_subtype": "FEED_SMALL_PICTURE",
"creative_size_id": 5,
"adgroup_begin_time": "2020-04-20",
"ocpc_status": "OCPC_STATUS_STUDY",
"price_type": "PRICING_OCPC",
"conversion_cost": "20.00",
"adgroup_status": "OPERATION_STATUS_ENABLE",
"adgroup_name": "信息流小图-225*150-20200420-竞价 jtbr"
}]
}
}
=================================================================== =======================================

评论列表