推广主物料管理API

推广主物料管理API

更新时间:2018-07-27 16:46:48

物料管理API主要提供对DSP系统中的推广计划、推广组、创意的增删改查等功能。

具体域名请联系阿里云营销引擎技术支持获取。

API调用实例

API调用路径以及参数介绍

创建推广计划(CreateAdPlanRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/adplan

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_plan_name string Y 推广计划名
ad_type int N 推广计划类型(0:标准;1:移动;2:O2O),默认0
quota_status int N 是否设预算(1:不设;0:设置),默认1
daily_max_quota long N 每日预算上限,默认0
start_time string N 投放开始时间(yyyy-mm-dd hh:mm:ss),默认当前时间
end_time string N 投放结束时间(yyyy-mm-dd hh:mm:ss),默认2037-01-01 00:00:00
delivery_time string N 投放小时,默认为空,即不投放 (数值为一周所有小时的坐标(0-167),以多值列顺序存储(例如:周一0点和1点:”0,1”;周五22点和23点:”166,167”)
ad_plan_status int N 计划状态(0:暂停;1:启动),默认1
is_cpt int N 是否CPT计划(0:不是;1:是),默认0
is_constant_speed int N 是否均匀投放(0:否;1:是)

请求样例

  1. http://xxxxxx.aliyuncs.com/adplan
  1. {
  2. "advertiser\_id": 1,
  3. "ad\_plan\_name": "ABC",
  4. "ad\_type": 1,
  5. "quota\_status": 0,
  6. "daily\_max\_quota": 1000,
  7. "start\_time": "2016-7-11 00:00:00",
  8. "end\_time": "2016-7-31 00:00:00",
  9. "delivery\_time": "1,3,5,23,123",
  10. "ad\_plan\_status": 1,
  11. "is\_cpt": 1,
  12. "is_constant_speed": 1
  13. }
  1. public void createAdPlan(HttpServletResponse response) {
  2. String body = null;
  3. try {
  4. body = IOUtils.toString(request.getInputStream(), "UTF-8");
  5. } catch (IOException e) {
  6. e.printStackTrace();
  7. }
  8. Map<String, Object> paramMap = null;
  9. if (StringUtils.isNotBlank(body)) {
  10. paramMap = JSONObject.parseObject(body, new TypeReference<Map<String, Object>>() {
  11. });
  12. }
  13. String url = "/adplan";
  14. Map<String, String> headMap = new HashMap<String, String>();
  15. headMap.put(ORG_DSPID_HEADER, dspId);
  16. try {
  17. openAdService.init({accessId}, {accessKey}});//填写AK信息
  18. } catch (ClientException e) {
  19. e.printStackTrace();
  20. }
  21. try {
  22. String content = openAdService.request(url,MethodType.POST,headMap,paramMap);
  23. System.out.println(content);
  24. } catch (ClientException e) {
  25. e.printStackTrace();
  26. }
  27. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 插入成功,返回计划id
errorCode 错误码
message 错误提示信息

返回样例

JSON格式

  1. { "result": "SUCCESS", "data": 10000002 }

修改推广计划(UpdateAdPlanRequest)

请求方式

PUT

请求结构

http://xxxxxx.aliyuncs.com/adplan/${id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
id long Y 推广计划id
ad_plan_name string N 推广计划名(传值时不能为空)
ad_type int N 推广计划类型(0:标准;1:移动;2:O2O)
quota_status int N 是否设预算(1:不设;0:设置)
daily_max_quota long N 每日预算上限
start_time string N 投放开始时间(yyyy-mm-dd hh:mm:ss)
end_time string N 投放结束时间(yyyy-mm-dd hh:mm:ss)
delivery_time string N 投放小时,默认为空,即不投放 (数值为一周所有小时的坐标(0-167),以多值列顺序存储(例如:周一0点和1点:”0,1”;周五22点和23点:”166,167”)
ad_plan_status int N 计划状态(0:暂停;1:启动)
is_constant_speed int N 是否匀速投放,0:非匀速投放;1:匀速投放。默认为0

请求样例

  1. http://xxxxxx.aliyuncs.com/adplan/12123
  1. {
  2. "id": 1,
  3. "ad\_plan\_name": "ABC",
  4. "ad\_type": 1,
  5. "quota\_status": 0,
  6. "daily\_max\_quota": 1000,
  7. "start\_time": "2016-7-11 00:00:00",
  8. "end\_time": "2016-7-31 00:00:0",
  9. "delivery\_time": "1,3,5,23,123",
  10. "ad\_plan\_status": 1,
  11. "is_constant_speed": 1
  12. }
  1. public void putAdPlan(@PathVariable long id,HttpServletResponse response) {
  2. String body = null;
  3. try {
  4. body = IOUtils.toString(request.getInputStream(), "UTF-8");
  5. } catch (IOException e) {
  6. e.printStackTrace();
  7. }
  8. Map<String, Object> paramMap = null;
  9. if (StringUtils.isNotBlank(body)) {
  10. paramMap = JSONObject.parseObject(body, new TypeReference<Map<String, Object>>() {
  11. });
  12. }
  13. String url = "/adplan/" + id + "/";
  14. Map<String, String> headMap = new HashMap<String, String>();
  15. headMap.put(ORG_DSPID_HEADER, dspId);
  16. try {
  17. openAdService.init({accessId}, {accessKey}});//填写AK信息
  18. } catch (ClientException e) {
  19. e.printStackTrace();
  20. }
  21. try {
  22. String content = openAdService.request(url,MethodType.PUT,headMap,paramMap);
  23. System.out.println(content);
  24. } catch (ClientException e) {
  25. e.printStackTrace();
  26. }
  27. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 成功返回true,失败返回false
errorCode 错误码
message 错误提示信息

返回样例

JSON返回

  1. { "result": "SUCCESS", "data": true }

删除推广计划(DeleteAdPlanRequest)

请求方式

DELETE

请求结构

http://xxxxxx.aliyuncs.com/adplan/${ad_plan_id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_plan_id long Y 推广计划id

请求样例

  1. http://xxxxxx.aliyuncs.com/adplan/1
  1. public void deleteAdPlan(@PathVariable long id,HttpServletResponse response) {
  2. String url = "/adplan/" + id + "/";
  3. Map<String, String> headMap = new HashMap<String, String>();
  4. headMap.put(ORG_DSPID_HEADER, dspId);
  5. try {
  6. openAdService.init({accessId}, {accessKey}});//填写AK信息
  7. } catch (ClientException e) {
  8. e.printStackTrace();
  9. }
  10. try {
  11. String content = openAdService.request(url,MethodType.DELETE,headMap,null);
  12. System.out.println(content);
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 成功返回true,失败返回false
errorCode 错误码
message 错误提示信息

返回样例

JSON返回

  1. { "result": "SUCCESS", "data": true }

查询单个推广计划(GetAdPlanRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/adplan/query/${ad_plan_id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_plan_id long Y 推广计划id

请求样例

  1. http://xxxxxx.aliyuncs.com/adplan/query/1
  1. public void getAdPlan(@PathVariable long id,HttpServletResponse response) {
  2. String url = "/adplan/query/" + id;
  3. Map<String, String> headMap = new HashMap<String, String>();
  4. headMap.put(ORG_DSPID_HEADER, dspId);
  5. try {
  6. openAdService.init({accessId}, {accessKey}});//填写AK信息
  7. } catch (ClientException e) {
  8. e.printStackTrace();
  9. }
  10. try {
  11. String content = openAdService.request(url,MethodType.GET,headMap,null);
  12. System.out.println(content);
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 推广计划id
gmt_modified 推广修改时间
ad_plan_name 推广计划名
advertiser_id 推广主id
ad_type 推广计划类型
quota_status 是否设预算(1:不设置,0:设置)
daily_max_quota 每日预算上限
start_time 投放开始时间
end_time 投放结束时间
delivery_time 投放小时
ad_plan_status 计划状态(0:暂停;1:启动; 2:已过期;3:等待中;4:投放中)
is_cpt 是否CPT计划(0:不是;1:是)
is_constant_speed 是否匀速投放

返回样例

JSON返回

  1. {
  2. "result": "SUCCESS",
  3. "data": {
  4. "gmt\_modified": "2016-12-22 14:08:06",
  5. "id": 9999979,
  6. "ad\_plan\_name": "AB",
  7. "advertiser\_id": 1,
  8. "ad\_plan\_status": 0,
  9. "ad\_type": 1,
  10. "quota\_status": 0,
  11. "daily\_max\_quota": 100,
  12. "start\_time": "2016-12-21 00:00:00",
  13. "end\_time": "2017-01-31 23:59:59",
  14. "delivery\_time": "0,1",
  15. "is\_cpt": 1,
  16. "is_constant_speed":1
  17. }
  18. }

推广计划列表(GetAdPlanListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/adplan/adv/query?page=${page}&size=${size}&query\_str=${query_str}&status=${status}&dsp_query=${dsp_query}&adv_id=${adv_id}&ad_type=${ad_type}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
page int N 当前页码,默认1
size int N 一页展现条数,默认10
query_str string N 计划名称匹配关键字(中文需urlencode后传输)
ad_type int N 计划类型(0:标准;1:移动;2:O2O)
dsp_query boolean N dsp_query为true时ad_type和adv_id查询可用
adv_id int N 推广主ID
status int N 计划状态 0:暂停 1:启动 2:过期 3:等待中 4:投放中

请求样例

  1. http://xxxxxx.aliyuncs.com/adplan/adv/query?page=1&size=10
  1. public void getAdPlanList(HttpServletResponse response) {
  2. String page = request.getParameter("page");
  3. String size = request.getParameter("size");
  4. String url = "/adplan/adv/query?page" + page + "&size=" + size;
  5. String query_str = request.getParameter("query_str");
  6. if(StringUtils.isNotBlank(query_str)){
  7. url = url + "&query_str=" + query_str;
  8. }
  9. String ad_type = request.getParameter("ad_type");
  10. if(StringUtils.isNotBlank(ad_type)){
  11. url = url + "&ad_type=" + ad_type;
  12. }
  13. String dsp_query = request.getParameter("dsp_query");
  14. if(StringUtils.isNotBlank(dsp_query)){
  15. url = url + "&dsp_query=" + dsp_query;
  16. }
  17. String adv_id = request.getParameter("adv_id");
  18. if(StringUtils.isNotBlank(adv_id)){
  19. url = url + "&adv_id=" + adv_id;
  20. }
  21. String status = request.getParameter("status");
  22. if(StringUtils.isNotBlank(status)){
  23. url = url + "&status=" + status;
  24. }
  25. Map<String, String> headMap = new HashMap<String, String>();
  26. headMap.put(ORG_DSPID_HEADER, dspId);
  27. try {
  28. openAdService.init({accessId}, {accessKey}});//填写AK信息
  29. } catch (ClientException e) {
  30. e.printStackTrace();
  31. }
  32. try {
  33. String content = openAdService.request(url,MethodType.GET,headMap,null);
  34. System.out.println(content);
  35. } catch (ClientException e) {
  36. e.printStackTrace();
  37. }
  38. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
total 记录总数
errorCode 错误码
message 错误提示信息
id 推广计划id
gmt_modified 推广修改时间
ad_plan_name 推广计划名
advertiser_id 推广主id
ad_type 推广计划类型
quota_status 是否设预算
daily_max_quota 每日预算上限
start_time 投放开始时间
end_time 投放结束时间
delivery_time 投放小时
ad_plan_status 计划状态(0:暂停;1:启动;2:已过期; 3:等待中;4:投放中)
is_cpt 是否CPT计划(0:不是;1:是)
is_constant_speed 是否匀速投放

返回样例

JSON返回

  1. {
  2. "result": "SUCCESS",
  3. "data": {
  4. "list": [{
  5. "gmt\_modified": "2016-12-28 00:20:40",
  6. "id": 70,
  7. "ad\_plan\_name": "ABC",
  8. "advertiser\_id": 1,
  9. "ad\_plan\_status": 4,
  10. "ad\_type": 0,
  11. "quota\_status": 1,
  12. "daily\_max\_quota": 0,
  13. "start\_time": "2016-12-28 00:00:00",
  14. "end\_time": "2016-12-28 23:59:59",
  15. "delivery\_time": "0,1,2,3,4,5,6,7,8",
  16. "is\_cpt": 1,
  17. "is_constant_speed":1
  18. }, {
  19. "gmt\_modified": "2016-12-27 19:41:02",
  20. "id": 69,
  21. "ad\_plan\_name": "BCD",
  22. "advertiser\_id": 1,
  23. "ad\_plan\_status": 2,
  24. "ad\_type": 0,
  25. "quota\_status": 1,
  26. "daily\_max\_quota": 0,
  27. "start\_time": "2016-12-27 00:00:00",
  28. "end\_time": "2016-12-27 23:59:59",
  29. "delivery\_time": "0,1,2,3,4,5,6,7,8",
  30. "is\_cpt": 1,
  31. "is_constant_speed":1
  32. }],
  33. "total": 2
  34. }
  35. }

创建推广组(CreateAdGroupRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/adgroup

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_plan_id long Y 推广组所属推广计划id
ad_group_name string Y 推广组名称
ad_bid_type int N 出价类型(0:CPC;1:CPM;2:CPA;3:CPI;4:CPT),默认1
ad_bid_price string N 出价(单位:元),默认0
ad_source_type string Y 流量来源(1:阿里妈妈Tanx;3:百度BES;6:网易YEX;7:灵集XTrader;8:硬核联盟;9:佳投;10:Smaato;11:其他;12:AdView;13:去哪儿;14:舜飞;15:多盟;16:OpenAd;17:Oppo;19:京东金融),多值列逗号隔开
mobile_source_type int N 流量来源类型(2:APP;3:移动网站),默认0,移动推广组必填
ad_server_type int N 投放渠道(0:全网通投;1:媒体分类;2:媒体;3:推广位),默认0
media_category_ids string N 推广组指定的投放媒体类目(媒体类目字典),多值列逗号隔开,默认null
media_ids string N 推广组指定的投放媒体(媒体上限1000个),多值列逗号隔开,默认null
view_type_ids string Y 推广组所选推广位类型 (取值见推广位类型字典),多值列逗号隔开
keywords string N 关键词匹配(不超过3个),默认null,多值列逗号隔开
target_area_ids string N 定向人群-地域(取值见地域字典,0:全选),不选默认0
mobile_target_os_ids string N 定向人群-移动操作系统(1:ios;2:android),不选默认0
mobile_target_device_ids string N 定向人群-移动设备类型 (1:手机;2:平板),不选默认 0
mobile_target_network_ids string N 定向人群-移动网络 (1:WIFI;2:2G, 3:3G;4:4G),不选默认0
ot_group string N 定向人群-人群ID(最多1000个),默认null 二方人群(获取到的人群id前面拼上”0_“ ); 友盟人群(获取到的人群id前面拼上”1_“ );高德人群(获取到的人群id前面拼上”2_“)
ad_group_status int N 推广组状态(0:暂停;1:启动),默认1
group_type int Y 推广组类型(0:移动;1:PC)
daily_show_limit int N 推广组曝光频控,每日对于每个用户的展现次数上限,默认值0,表示没有上限
pids string N 需要投放的推广位id,多值列,逗号分隔
target_city_ids string N 定向人群-城市定向(取值见城市字典)
target_adx_tags string N 定向人群-ADX标签定向(取值见adx标签字典)
device_language string N 定向人群-语言定向(取值见ISO_639-1代码表)
target_lbs string N 定向人群-商圈定向(取值按经纬度和半径)

请求样例

  1. http://xxxxxx.aliyuncs.com/adgroup
  1. JSON
  2. {
  3. "view_type_ids": "1",
  4. "ad_source_type": "2",
  5. "ad_plan_id": "556600050",
  6. "ad_group_name": "111111",
  7. "media_category_ids": "",
  8. "media_ids": "",
  9. "pids": "",
  10. "ad_server_type": 0,
  11. "target_area_ids": "9000000",
  12. "target_city_ids": "",
  13. "target_lbs": "38:38:5",
  14. "target_adx_tags": "",
  15. "device_language": "en",
  16. "keywords": "guanjian",
  17. "daily_show_limit": 100,
  18. "ad_bid_type": 0,
  19. "ad_bid_price": 1,
  20. "ad_group_status": 1,
  21. "ot_group": "0_0_e6527e84_370b_448a_ab17_7903c90a9010",
  22. "mobile_target_device_ids": 0,
  23. "mobile_target_network_ids": 0,
  24. "mobile_target_os_ids": 0,
  25. "group_type": 1
  26. }
  1. public void createAdGroup(HttpServletRequest request,HttpServletResponse response) {
  2. String body = null;
  3. try {
  4. body = IOUtils.toString(request.getInputStream(), "UTF-8");
  5. } catch (IOException e) {
  6. e.printStackTrace();
  7. }
  8. Map<String, Object> paramMap = null;
  9. if (StringUtils.isNotBlank(body)) {
  10. paramMap = JSONObject.parseObject(body, new TypeReference<Map<String, Object>>() {
  11. });
  12. }
  13. String url = "/adgroup";
  14. Map<String, String> headMap = new HashMap<String, String>();
  15. headMap.put(ORG_DSPID_HEADER, dspId);
  16. try {
  17. openAdService.init({accessId}, {accessKey}});//填写AK信息
  18. } catch (ClientException e) {
  19. e.printStackTrace();
  20. }
  21. try {
  22. String content = openAdService.request(url,MethodType.POST,headMap,paramMap);
  23. System.out.println(content);
  24. } catch (ClientException e) {
  25. e.printStackTrace();
  26. }
  27. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 插入成功,返回计划id
errorCode 错误码
message 错误提示信息

返回样例

JSON返回

  1. { "result": "SUCCESS", "data": true }

修改推广组(UpdateAdGroupRequest)

请求方式

PUT

请求结构

http://xxxxxx.aliyuncs.com/adgroup/${id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
id long Y 推广组id
ad_plan_id long Y 推广组所属推广计划id
ad_group_name string Y 推广组名称
ad_bid_type int N 出价类型(0:CPC;1:CPM;2:CPA;3:CPI;4:CPT),默认1
ad_bid_price string N 出价(单位:元),默认0
ad_source_type string Y 流量来源(1:阿里妈妈Tanx;3:百度BES;6:网易YEX;7:灵集XTrader;8:硬核联盟;9:佳投;10:Smaato;11:其他;12:AdView;13:去哪儿;14:舜飞;15:多盟;16:OpenAd;17:Oppo;19:京东金融),多值列逗号隔开
mobile_source_type int N 流量来源类型(2:APP;3:移动网站),默认0,移动推广组必填
ad_server_type int N 投放渠道(0:全网通投;1:媒体分类;2:媒体;3:推广位),默认0
media_category_ids string N 推广组指定的投放媒体类目(媒体类目字典),多值列逗号隔开,默认null
media_ids string N 推广组指定的投放媒体(媒体上限1000个),多值列逗号隔开,默认null
view_type_ids string Y 推广组所选推广位类型 (取值见推广位类型字典),多值列逗号隔开
keywords string N 关键词匹配(不超过3个),默认null,多值列逗号隔开
target_area_ids string N 定向人群-地域(取值见地域字典,0:全选),不选默认0
mobile_target_os_ids string N 定向人群-移动操作系统(1:ios;2:android),不选默认0
mobile_target_device_ids string N 定向人群-移动设备类型 (1:手机;2:平板),不选默认 0
mobile_target_network_ids string N 定向人群-移动网络 (1:WIFI;2:2G, 3:3G;4:4G),不选默认0
ot_group string N 定向人群-人群ID(最多1000个),默认null 二方人群(获取到的人群id前面拼上”0_“ ); 友盟人群(获取到的人群id前面拼上”1_“ );高德人群(获取到的人群id前面拼上”2_“)
ad_group_status int N 推广组状态(0:暂停;1:启动),默认1
group_type int Y 推广组类型(0:移动;1:PC)
daily_show_limit int N 推广组曝光频控,每日对于每个用户的展现次数上限,默认值0,表示没有上限
pids string N 需要投放的推广位id,多值列,逗号分隔
target_city_ids string N 定向人群-城市定向(取值见城市字典)
target_adx_tags string N 定向人群-ADX标签定向(取值见adx标签字典)
device_language string N 定向人群-语言定向(取值见ISO_639-1代码表)
target_lbs string N 定向人群-商圈定向(取值按经纬度和半径)

请求样例

  1. http://xxxxxx.aliyuncs.com/adgroup/121
  1. JSON
  2. {
  3. "id": 10000005,
  4. "ad\_group\_name": "abc",
  5. "ad\_bid\_type": 0,
  6. "ad\_bid\_price": 12,
  7. "ad\_source\_type": 0,
  8. "keywords": null,
  9. "media\_type": "0",
  10. "media": "0",
  11. "view\_type\_ids": 101,
  12. "area": "0",
  13. "device": "0",
  14. "os": "0",
  15. "network": "0",
  16. "ot\_group": null,
  17. "ad\_server\_type": 0,
  18. "group\_type": 0,
  19. "mobile\_source\_type": 2,
  20. "ad\_group\_status": 1,
  21. "daily\_show\_limit": 100,
  22. "pids": "1,2,3"
  23. }
  1. public void createAdGroup(HttpServletRequest request,HttpServletResponse response) {
  2. String body = null;
  3. try {
  4. body = IOUtils.toString(request.getInputStream(), "UTF-8");
  5. } catch (IOException e) {
  6. e.printStackTrace();
  7. }
  8. Map<String, Object> paramMap = null;
  9. if (StringUtils.isNotBlank(body)) {
  10. paramMap = JSONObject.parseObject(body, new TypeReference<Map<String, Object>>() {
  11. });
  12. }
  13. String url = "/adgroup";
  14. Map<String, String> headMap = new HashMap<String, String>();
  15. headMap.put(ORG_DSPID_HEADER, dspId);
  16. try {
  17. openAdService.init({accessId}, {accessKey}});//填写AK信息
  18. } catch (ClientException e) {
  19. e.printStackTrace();
  20. }
  21. try {
  22. String content = openAdService.request(url,MethodType.PUT,headMap,paramMap);
  23. System.out.println(content);
  24. } catch (ClientException e) {
  25. e.printStackTrace();
  26. }
  27. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 成功返回true,失败返回false
errorCode 错误码
message 错误提示信息

返回样例

JSON返回

  1. { "result": "SUCCESS", "data": true }

删除推广组(DeleteAdGroupRequest)

请求方式

DELETE

请求结构

http://xxxxxx.aliyuncs.com/adgroup/${ad_group_id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_group_id long Y 推广组id

请求样例

  1. http://xxxxxx.aliyuncs.com/adgroup/1
  1. public void deleteAdGroupRequest(@PathVariable long id,HttpServletRequest request,HttpServletResponse response) {
  2. String url = "/adgroup/" + id;
  3. Map<String, String> headMap = new HashMap<String, String>();
  4. headMap.put(ORG_DSPID_HEADER, dspId);
  5. try {
  6. openAdService.init({accessId}, {accessKey}});//填写AK信息
  7. } catch (ClientException e) {
  8. e.printStackTrace();
  9. }
  10. try {
  11. String content = openAdService.request(url,MethodType.DELETE,headMap,null);
  12. System.out.println(content);
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 成功返回true,失败返回false
errorCode 错误码
message 错误提示信息

返回样例

JSON返回

  1. JSON
  2. { "result": "SUCCESS", "data": true }

查询单个推广组(GetAdGroupRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/adgroup/query/${ad_group_id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_group_id long Y 推广组id

请求样例

  1. http://xxxxxx.aliyuncs.com/adgroup/query/1
  1. public void getAdGroupRequest(@PathVariable long id,HttpServletResponse response) {
  2. String url = "/adgroup/query/" + id + "/";
  3. Map<String, String> headMap = new HashMap<String, String>();
  4. headMap.put(ORG_DSPID_HEADER, dspId);
  5. try {
  6. openAdService.init({accessId}, {accessKey}});//填写AK信息
  7. } catch (ClientException e) {
  8. e.printStackTrace();
  9. }
  10. try {
  11. String content = openAdService.request(url,MethodType.GET,headMap,null);
  12. System.out.println(content);
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 推广组id
gmt_modified 推广组修改时间
ad_plan_name 推广计划名
ad_bid_price 出价(单位:元)
ad_bid_type 出价类型(0:CPM;1:CPC;2:CPA;3:CPI;4:CPT)
ad_group_name 推广组名称
ad_group_status 推广组状态(0:暂停;1:启动)
ad_plan_id 推广计划ID
ad_server_type 投放渠道(0:全网通投;1:媒体分类;2:媒体;3:推广位)
ad_source_type 流量来源(1:阿里妈妈Tanx;3:百度BES;6:网易YEX;7:灵集XTrader;8:硬核联盟;9:佳投;10:Smaato;11:其他;12:AdView;13:去哪儿;14:舜飞;15:多盟;16:OpenAd;17:Oppo;19:京东金融),多值列逗号隔开
group_type 推广组类型(0:移动;1:PC)
keywords 关键词匹配
media_category_ids 推广组指定的投放媒体类目(媒体类目字典),多值列逗号隔开
media_ids 推广组指定的投放媒体(媒体上限1000个),多值列逗号隔开
mobile_source_type 流量来源类型(2:APP;3:移动网站)
mobile_target_device_ids 定向人群-移动设备类型 (1:手机;2:平板)
mobile_target_network_ids 定向人群-移动网络 (0:不选;1:WIFI;2:2G, 3:3G;4:4G)
mobile_target_os_ids 定向人群-移动操作系统(1:ios;2:android)
ot_group 定向人群-人群ID(最多1000个)
target_area_ids 定向人群-地域(取值见地域字典,0:全选/不选)
view_type_ids 推广组所选推广位类型 (取值见推广位类型字典),多值列逗号隔开
daily_show_limit 推广组曝光频控,每日对于每个用户的展现次数上限,默认值0,表示没有上限
pids 需要投放的推广位id,多值列,逗号分隔
target_city_ids 定向人群-城市定向(取值见城市字典)
target_adx_tags 定向人群-ADX标签定向(取值见adx标签字典)
device_language 定向人群-语言定向(取值见ISO_639-1代码表)
target_lbs 定向人群-商圈定向(取值按经纬度和半径)

返回样例

  1. http://xxxxxx.aliyuncs.com/adgroup/query/123

JSON返回

  1. {
  2. "result": "SUCCESS",
  3. "data": {
  4. "media_category_ids": "",
  5. "keywords": "guanjian",
  6. "media_ids": "",
  7. "mobile_target_os_ids": "0",
  8. "target_lbs": "38:38:5",
  9. "group_type": 1,
  10. "gmt_modified": "2018-06-13 14:43:23",
  11. "target_area_ids": "9000000",
  12. "ot_group": "0_0_e6527e84_370b_448a_ab17_7903c90a9010",
  13. "ad_group_status": 1,
  14. "id": 90000000074,
  15. "ad_source_type": "2",
  16. "ad_bid_type": 0,
  17. "mobile_target_device_ids": "0",
  18. "ad_group_name": "111111",
  19. "ad_bid_price": 1.000,
  20. "target_adx_tags": "",
  21. "ad_server_type": 0,
  22. "view_type_ids": "1",
  23. "ad_plan_id": 556600050,
  24. "daily_show_limit": 100,
  25. "device_language": "en",
  26. "mobile_source_type": 0,
  27. "pids": "",
  28. "mobile_target_network_ids": "0"
  29. }
  30. }

推广组列表(GetAdGroupListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/adgroup/adv/query/?page=${page}&size=${size}&query_str=${query_str}&ad_type=${ad_type}&ad_plan_id=${ad_plan_id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_plan_id long Y 推广计划id
ad_type string N 推广组类型(0:PC;1:移动)
query_str string N 推广组名称匹配关键词(中文需urlencode后传输)
dsp_query boolean N 当dsp_query为true时会根据ad_type和adv_id进行搜索
adv_id string N 推广主id
page int N 当前页码,默认1
size int N 一页展现条数,默认10

请求样例

  1. http://xxxxxx.aliyuncs.com/adgroup/adv/query/?page=1&size=10&ad_plan_id=111

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 推广组id
gmt_modified 推广组修改时间
ad_plan_name 推广计划名
ad_bid_price 出价(单位:元)
ad_bid_type 出价类型(0:CPM;1:CPC;2:CPA;3:CPI;4:CPT)
ad_group_name 推广组名称
ad_group_status 推广组状态(0:暂停;1:启动)
ad_plan_id 推广计划ID
ad_server_type 投放渠道(0:全网通投;1:媒体分类;2:媒体;3:推广位)
ad_source_type 流量来源(1:阿里妈妈Tanx;3:百度BES;6:网易YEX;7:灵集XTrader;8:硬核联盟;9:佳投;10:Smaato;11:其他;12:AdView;13:去哪儿;14:舜飞;15:多盟;16:OpenAd;17:Oppo;19:京东金融),多值列逗号隔开
group_type 推广组类型(0:移动;1:PC)
keywords 关键词匹配
media_category_ids 推广组指定的投放媒体类目(媒体类目字典),多值列逗号隔开
media_ids 推广组指定的投放媒体(媒体上限1000个),多值列逗号隔开
mobile_source_type 流量来源类型(2:APP;3:移动网站)
mobile_target_device_ids 定向人群-移动设备类型 (1:手机;2:平板)
mobile_target_network_ids 定向人群-移动网络 (0:不选;1:WIFI;2:2G, 3:3G;4:4G)
mobile_target_os_ids 定向人群-移动操作系统(1:ios;2:android)
ot_group 定向人群-人群ID(最多1000个)
target_area_ids 定向人群-地域(取值见地域字典,0:全选/不选)
view_type_ids 推广组所选推广位类型 (取值见推广位类型字典),多值列逗号隔开
daily_show_limit 推广组曝光频控,每日对于每个用户的展现次数上限,默认值0,表示没有上限
pids 需要投放的推广位id,多值列,逗号分隔
target_city_ids 定向人群-城市定向(取值见城市字典)
target_adx_tags 定向人群-ADX标签定向(取值见adx标签字典)
device_language 定向人群-语言定向(取值见ISO_639-1代码表)
target_lbs 定向人群-商圈定向(取值按经纬度和半径)

返回样例

JSON返回

  1. JSON
  2. {
  3. "result": "SUCCESS",
  4. "data": {
  5. "list": [{
  6. "media_category_ids": "",
  7. "keywords": "guanjian",
  8. "media_ids": "",
  9. "mobile_target_os_ids": "0",
  10. "target_lbs": "38:38:5",
  11. "group_type": 1,
  12. "gmt_modified": "2018-06-13 14:43:23",
  13. "target_area_ids": "9000000",
  14. "ot_group": "0_0_e6527e84_370b_448a_ab17_7903c90a9010",
  15. "ad_group_status": 1,
  16. "id": 90000000074,
  17. "ad_source_type": "2",
  18. "ad_bid_type": 0,
  19. "mobile_target_device_ids": "0",
  20. "ad_group_name": "111111",
  21. "ad_bid_price": 1.000,
  22. "target_adx_tags": "",
  23. "ad_server_type": 0,
  24. "view_type_ids": "1",
  25. "ad_plan_id": 556600050,
  26. "daily_show_limit": 100,
  27. "device_language": "en",
  28. "mobile_source_type": 0,
  29. "pids": "",
  30. "mobile_target_network_ids": "0"
  31. }, {
  32. "media_category_ids": "",
  33. "keywords": "guanjian",
  34. "media_ids": "",
  35. "mobile_target_os_ids": "0",
  36. "target_lbs": "38:38:5",
  37. "group_type": 1,
  38. "gmt_modified": "2018-06-13 14:43:23",
  39. "target_area_ids": "9000000",
  40. "ot_group": "0_0_e6527e84_370b_448a_ab17_7903c90a9010",
  41. "ad_group_status": 1,
  42. "id": 90000000075,
  43. "ad_source_type": "2",
  44. "ad_bid_type": 0,
  45. "mobile_target_device_ids": "0",
  46. "ad_group_name": "111111",
  47. "ad_bid_price": 1.000,
  48. "target_adx_tags": "",
  49. "ad_server_type": 0,
  50. "view_type_ids": "1",
  51. "ad_plan_id": 556600050,
  52. "daily_show_limit": 100,
  53. "device_language": "en",
  54. "mobile_source_type": 0,
  55. "pids": "",
  56. "mobile_target_network_ids": "0"
  57. }],
  58. "total": 2
  59. }
  60. }

创建创意(CreateAdCreativeRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/adcreative

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_group_id long Y 创意所属推广组id
creative_name string Y 创意名称
creative_desc string N 创意描述,默认null
img_path string N 图片地址(该链接是图片的地址的前缀(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_.jpg) ,完整的图片链接需要在最后一个”_”后面拼接上尺寸的base64加密串(如:320*200,base64加密之后再做urlencode:MzIwKjIwMA%3d%3d),最终串:(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_MzIwKjIwMA%3d%3d.jpg)
img_size string N 图片尺寸,格式:宽*高,默认null
image_type string N 图片类型:2-image/png,3-image/gif,4-image/jpg
dest_url string N 目标地址链接,默认null
category int Y 创意所属类目信息
wechat_url string N 目标微信地址,默认null
creative_type int N 创意类型(1:图文;2:微信;3:文字链;4:图片;5:动画或视频),默认1
animation_type int N 动画类型(0:VIDEO_ALL ;20:VIDEO_SWF; 21:VIDEO_FLV; 22:VIDEO_MPEG4; 23:VIDEO_AVI; 24:VIDEO_MOV; 25:VIDEO_WMV; 26:VIDEO_3PG; 27:VIDEO_RMVB; 28:VIDEO_WEBM; 29:VIDEO_MP4),默认0
animation_url string N 动画素材上传地址,默认null
animation_width int N 动画素材宽度,默认0
animation_height int N 动画素材高度,默认0
animation_monitor_url string N 动画曝光监控地址,默认null
monitor_url string N 曝光监控地址,默认null
click_monitor_url string N 点击监控地址,默认null
creative_status int N 创意状态(0:未审核;1:启动;2:通过暂停;-2:不通过),默认0
user_define string N 自定义字段 (存储自定义字段body值以及schema信息)
user_content string N 自定义字段(存储自定义字段body值)
is_download int Y 是否为下载型 (0为否,1为是)
download_url string Y 下载地址(当is_download为1时此字段为必填)
title string N 推广位标题

请求样例

  1. {
  2. "ad_plan_id": "556600045",
  3. "ad_group_id": "90000000051",
  4. "category": "44065",
  5. "img_size": "0*0",
  6. "creative_name": "1111111111",
  7. "creative_type": "4",
  8. "dest_url": "http://www.aliyun.com",
  9. "monitor_url": "http://www.aliyun.com/1",
  10. "click_monitor_url": "http://www.aliyun.com/2",
  11. "is_download": 1,
  12. "img_path": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/Y2ppY3U5cTk2MDAxcjNiNXV2ZTJ3cTlxaQ==_1_NzI4Kjkw.jpg",
  13. "imageSizeNew": "728*90",
  14. "imagePathNew": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/Y2ppY3U5cTk2MDAxcjNiNXV2ZTJ3cTlxaQ==_1_.jpg",
  15. "download_url": "http://www.aliyun.com/3",
  16. "image_type": 1,
  17. "user_content": "{\"body\":{\"2\":\"3\"}}",
  18. "user_define": "{\"id\":0,\"title\":\"自定义模板\",\"items\":[{\"name\":\"2\",\"value\":\"3\",\"type\":\"string\"}],\"body\":{\"2\":\"3\"}}",
  19. "uuid": "cjicu9q96001r3b5uve2wq9qi"
  20. }
  1. public void createAdCreativeRequest(HttpServletResponse response) {
  2. String body = null;
  3. try {
  4. body = IOUtils.toString(request.getInputStream(), "UTF-8");
  5. } catch (IOException e) {
  6. e.printStackTrace();
  7. }
  8. Map<String, Object> paramMap = null;
  9. if (StringUtils.isNotBlank(body)) {
  10. paramMap = JSONObject.parseObject(body, new TypeReference<Map<String, Object>>() {
  11. });
  12. }
  13. String url = "/adcreative/";
  14. Map<String, String> headMap = new HashMap<String, String>();
  15. headMap.put(ORG_DSPID_HEADER, dspId);
  16. try {
  17. openAdService.init({accessId}, {accessKey}});//填写AK信息
  18. } catch (ClientException e) {
  19. e.printStackTrace();
  20. }
  21. try {
  22. String content = openAdService.request(url,MethodType.POST,headMap,paramMap);
  23. System.out.println(content);
  24. } catch (ClientException e) {
  25. e.printStackTrace();
  26. }
  27. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回true/false
errorCode 错误码
message 错误提示信息

返回样例

JSON格式

  1. { "result": "SUCCESS", "data": true }

修改创意(UpdateAdCreativeRequest)

请求方式

PUT

请求结构

  1. http://xxxxxx.aliyuncs.com/adcreative/${id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
id long Y 创意id
ad_group_id long Y 创意所属推广组id
creative_name string Y 创意名称
creative_desc string N 创意描述,默认null
img_path string N 图片地址(该链接是图片的地址的前缀(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_.jpg) ,完整的图片链接需要在最后一个”_”后面拼接上尺寸的base64加密串(如:320*200,base64加密之后再做urlencode:MzIwKjIwMA%3d%3d),最终串:(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_MzIwKjIwMA%3d%3d.jpg)
img_size string N 图片尺寸,格式:宽*高,默认null
image_type string N 图片类型:2-image/png,3-image/gif,4-image/jpg
dest_url string N 目标地址链接,默认null
category int Y 创意所属类目信息
wechat_url string N 目标微信地址,默认null
creative_type int N 创意类型(1:图文;2:微信;3:文字链;4:图片;5:动画或视频),默认1
animation_type int N 动画类型(0:VIDEO_ALL ;20:VIDEO_SWF; 21:VIDEO_FLV; 22:VIDEO_MPEG4; 23:VIDEO_AVI; 24:VIDEO_MOV; 25:VIDEO_WMV; 26:VIDEO_3PG; 27:VIDEO_RMVB; 28:VIDEO_WEBM; 29:VIDEO_MP4),默认0
animation_url string N 动画素材上传地址,默认null
animation_width int N 动画素材宽度,默认0
animation_height int N 动画素材高度,默认0
animation_monitor_url string N 动画曝光监控地址,默认null
monitor_url string N 曝光监控地址,默认null
click_monitor_url string N 点击监控地址,默认null
creative_status int N 创意状态(0:未审核;1:启动;2:通过暂停;-2:不通过),默认0
user_define string N 自定义字段 (存储自定义字段body值以及schema信息)
user_content string N 自定义字段(存储自定义字段body值)
is_download int Y 是否为下载型 (0为否,1为是)
download_url string Y 下载地址(当is_download为1时此字段为必填)
is_tmp string N 取值”false”(修改审核通过或者不通过的创意) or “true”(修改未审核的创意)

请求样例

  1. http://xxxxxx.aliyuncs.com/adcreative/1
  1. {
  2. "ad_plan_id": "556600045",
  3. "ad_group_id": "90000000047",
  4. "category": 90288,
  5. "img_size": "728*90",
  6. "creative_name": "1111111111",
  7. "creative_type": "5",
  8. "dest_url": "http://www.aliyun.com",
  9. "is_download": 1,
  10. "download_url": "http://www.aliyun.com/3",
  11. "animation_url": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/Y2ppY3VseWhtMDAxeDNiNXVjdnFidDNkeg==_1.mp4",
  12. "user_content": "{\"body\":{\"2\":\"3\"}}",
  13. "user_define": "{\"id\":0,\"title\":\"自定义模板\",\"items\":[{\"name\":\"2\",\"value\":\"3\",\"type\":\"string\"}],\"body\":{\"2\":\"3\"}}",
  14. "is_tmp": "true"
  15. }
  1. public void updateAdCreativeRequest(@PathVariable long id,HttpServletResponse response) {
  2. String body = null;
  3. try {
  4. body = IOUtils.toString(request.getInputStream(), "UTF-8");
  5. } catch (IOException e) {
  6. e.printStackTrace();
  7. }
  8. Map<String, Object> paramMap = null;
  9. if (StringUtils.isNotBlank(body)) {
  10. paramMap = JSONObject.parseObject(body, new TypeReference<Map<String, Object>>() {
  11. });
  12. }
  13. String url = "/adcreative/" + id + "/";
  14. Map<String, String> headMap = new HashMap<String, String>();
  15. headMap.put(ORG_DSPID_HEADER, dspId);
  16. try {
  17. openAdService.init({accessId}, {accessKey}});//填写AK信息
  18. } catch (ClientException e) {
  19. e.printStackTrace();
  20. }
  21. try {
  22. String content = openAdService.request(url,MethodType.PUT,headMap,paramMap);
  23. System.out.println(content);
  24. } catch (ClientException e) {
  25. e.printStackTrace();
  26. }
  27. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 成功返回true,失败返回false
errorCode 错误码
message 错误提示信息

返回样例

JSON格式

  1. { "result": "SUCCESS", "data": true }

删除创意(DeleteAdCreativeRequest)

请求方式

DELETE

请求结构

http://xxxxxx.aliyuncs.com/adcreative/${ad\_creative\_id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_creative_id long Y 创意id

请求样例

  1. http://xxxxxx.aliyuncs.com/adcreative/1

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 成功返回true,失败返回false
errorCode 错误码
message 错误提示信息

返回样例

JSON格式

  1. { "result": "SUCCESS", "data": true }

推广主下创意列表(GetAdCreativeListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/adcreative/adv/query/?page=${page}&size=${size}&query_str=${query_str}&ad_type=${ad_type}&ad_plan_id=${ad_plan_id}&ad_group_id=${ad_group_id}&status=${status}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_plan_id long N 推广计划id
ad_group_id long Y 推广组id
ad_type string N 推广组类型0:PC,1:移动
query_str string N 创意名称匹配关键词(中文需urlencode后传输)
page int N 当前页码,默认1
size int N 一页展现条数,默认10

请求样例

  1. http://xxxxxx.aliyuncs.com/adgroup/adv/query/?page=1&size=10&query_str=abc
  1. public void getAdCreativeListRequest(HttpServletResponse response) {
  2. String page = request.getParameter("page");
  3. String size = request.getParameter("size");
  4. String url = "/adgroup/adv/query/?page="+page+"&size="+size;
  5. String ad_plan_id = request.getParameter("ad_plan_id");
  6. String ad_group_id = request.getParameter("ad_group_id");
  7. String ad_type = request.getParameter("ad_type");
  8. String query_str = request.getParameter("query_str");
  9. if(StringUtils.isNotBlank(ad_plan_id)){
  10. url = url + "&ad_plan_id=" + ad_plan_id;
  11. }
  12. if(StringUtils.isNotBlank(ad_group_id)){
  13. url = url + "&ad_group_id=" + ad_group_id;
  14. }
  15. if(StringUtils.isNotBlank(ad_type)){
  16. url = url + "&ad_type=" + ad_type;
  17. }
  18. if(StringUtils.isNotBlank(query_str)){
  19. url = url + "&query_str=" + query_str;
  20. }
  21. Map<String, String> headMap = new HashMap<String, String>();
  22. headMap.put(ORG_DSPID_HEADER, dspId);
  23. try {
  24. openAdService.init({accessId}, {accessKey}});//填写AK信息
  25. } catch (ClientException e) {
  26. e.printStackTrace();
  27. }
  28. try {
  29. String content = openAdService.request(url,MethodType.GET,headMap,null);
  30. System.out.println(content);
  31. } catch (ClientException e) {
  32. e.printStackTrace();
  33. }
  34. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 创意id
gmt_modified 创意修改时间
ad_plan_name 推广计划名称
ad_group_name 推广组名称
ad_plan_id 推广计划ID
ad_group_id 推广组ID
category 创意类目id
creative_name 创意名称
creative_desc 创意描述
creative_status 创意状态(0:未审核;1:启动;2:通过暂停;-2:不通过)
dest_url 目标链接地址
group_type 推广组类型( 1:移动;0:PC)
img_path 图片地址(该链接是图片的地址的前缀(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_.jpg) ,完整的图片链接需要在最后一个”_”后面拼接上尺寸的base64加密串(如:320*200,base64加密之后再做urlencode:MzIwKjIwMA%3d%3d),最终串:(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_MzIwKjIwMA%3d%3d.jpg)
img_size 图片大小
wechat_url 目标微信地址
creative_type 创意类型(1、图文;2:微信;3:文字链;4:图片;5:动画或视频)
animation_type 动画类型(1:gif;2:flash.swf;3:flash.flv;4:mp4;5:avi;6:mov;7:wmv;8:3pg;9:mkv;10:rmvb),默认0
animation_url 动画素材上传地址
animation_width 动画素材宽度
animation_height 动画素材高度
animation_monitor_url 动画曝光监控地址
monitor_url 监控地址,默认null
click_monitor_url 点击监控地址,默认null
user_define 用户自定义字段
is_tmp 取值”false”(审核通过或者不通过的创意) or “true”(未审核的创意)
is_download 是否为下载型(0:否 1:是)
download_url 下载地址

返回样例

JSON格式

  1. {
  2. "result": "SUCCESS",
  3. "data": {
  4. "list": [{
  5. "gmt\_modified": "2017-01-04 15:08:15",
  6. "ad\_plan\_name": "lmn",
  7. "ad\_group\_name": "122",
  8. "ad\_plan\_id": 9999979,
  9. "group\_type": 0,
  10. "id": 10000002,
  11. "ad\_group\_id": 10000003,
  12. "wechat\_url": null,
  13. "creative\_name": "abc",
  14. "img\_path": "http://200x200.jpg",
  15. "img\_size": "200\*200",
  16. "dest\_url": "http://www.aliyun.com",
  17. "category": 90653,
  18. "creative\_status": 0,
  19. "check\_reason": "",
  20. "is\_default": 0,
  21. "is_download":1,
  22. "download_url":"www.aliyun.com"
  23. }],
  24. "total": 1
  25. }
  26. }

推广主下通过创意id获取创意(GetAdCreativeByIdRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/adcreative/{ad_creative_id}

参数列表

HEAD
ORG-ADID 推广主ID
参数 类型 必填 描述
ad_creative_id long N 创意id

请求样例

  1. http://xxxxxx.aliyuncs.com/adcreative/123123

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 创意id
gmt_modified 创意修改时间
ad_plan_name 推广计划名称
ad_group_name 推广组名称
ad_plan_id 推广计划ID
ad_group_id 推广组ID
category 创意类目id
creative_name 创意名称
creative_desc 创意描述
creative_status 创意状态(0:未审核;1:启动;2:通过暂停;-2:不通过)
dest_url 目标链接地址
group_type 推广组类型( 1:移动;0:PC)
img_path 图片地址(该链接是图片的地址的前缀(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_.jpg) ,完整的图片链接需要在最后一个”_”后面拼接上尺寸的base64加密串(如:320*200,base64加密之后再做urlencode:MzIwKjIwMA%3d%3d),最终串:(http://imgoacdn.aliyuncs.com/Y2pkYTBnaDM1dcdEEEMrNXI1aXBldzUxdA%3D%3D_1_MzIwKjIwMA%3d%3d.jpg)
img_size 图片大小
wechat_url 目标微信地址
creative_type 创意类型(1、图文;2:微信;3:文字链;4:图片;5:动画或视频)
animation_type 动画类型(1:gif;2:flash.swf;3:flash.flv;4:mp4;5:avi;6:mov;7:wmv;8:3pg;9:mkv;10:rmvb),默认0
animation_url 动画素材上传地址
animation_width 动画素材宽度
animation_height 动画素材高度
animation_monitor_url 动画曝光监控地址
monitor_url 监控地址,默认null
click_monitor_url 点击监控地址,默认null
user_define 用户自定义字段(存储自定义字段body值以及schema值)
user_content 用户自定义字段(存储自定义字段body值)
is_tmp 取值”false”(审核通过或者不通过的创意) or “true”(未审核的创意)
is_download 是否为下载型(0:否 1:是)
download_url 下载地址

返回样例

JSON格式

  1. {
  2. "result": "SUCCESS",
  3. "data": {
  4. "gmt\_modified": "2017-01-04 15:08:15",
  5. "ad\_plan\_name": "lmn",
  6. "ad\_group\_name": "122",
  7. "ad\_plan\_id": 9999979,
  8. "group\_type": 0,
  9. "id": 10000002,
  10. "ad\_group\_id": 10000003,
  11. "wechat\_url": null,
  12. "creative\_name": "abc",
  13. "img\_path": "http://200x200.jpg",
  14. "img\_size": "200\*200",
  15. "dest\_url": "http://www.aliyun.com",
  16. "category": 90653,
  17. "creative\_status": 0,
  18. "check\_reason": "",
  19. "is\_default": 0,
  20. "is_download":1,
  21. "download_url":"www.aliyun.com"
  22. }
  23. }

图片上传接口

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/upload/image?sizes=${size}

参数列表

HEAD 类型 说明
ORG-DSPID long DSP_ID
FILE-EXT-NAME String required 图片后缀名称(例:jpg、png、jpeg、flv、gif、webp)
参数 类型 必填 描述
sizes string Y 该创意所支持图片尺寸大小多值列
string Y 图片二进制流转成String

请求样例

  1. http://xxxxxx.aliyuncs.com/upload/image?sizes=728*90,320*100
  1. public void updateImage(HttpServletResponse response) {
  2. String size = request.getParameter("sizes");
  3. boolean isMultipart = ServletFileUpload.isMultipartContent(request);
  4. if (isMultipart) {
  5. Map<String, String> headMap = new HashMap<String, String>();
  6. MultipartFile multipartFile = ((MultipartHttpServletRequest) request).getFile("file");
  7. String FILE_EXT_NAME = StringUtils.substringAfterLast(multipartFile.getOriginalFilename(), ".");
  8. headerMap.put("FILE-EXT-NAME", FILE_EXT_NAME);
  9. String url = "/upload/image?sizes="+size;
  10. headMap.put(ORG_DSPID_HEADER, dspId);
  11. try {
  12. headerMap.remove("content-length");
  13. headerMap.put("content-type", "application/json;charset=UTF-8");
  14. String body = new String(Base64.encodeBase64(multipartFile.getBytes()),"utf-8");
  15. openAdService.init({accessId}, {accessKey}});//填写AK信息
  16. OpenAdRequest openAdRequest = new OpenAdRequest("2017-03-08", url,methodType);
  17. openAdRequest.setContentType(FormatType.RAW);
  18. openAdRequest.setAcceptFormat(FormatType.JSON);
  19. openAdRequest.setMethod(MethodType.POST);
  20. openAdRequest.setContent(body.getBytes("UTF-8"),"utf-8", FormatType.RAW);
  21. if(headerMap != null && !headerMap.isEmpty()){
  22. for (String key : headerMap.keySet()) {
  23. openAdRequest.putHeaderParameter(key,headerMap.get(key));
  24. }
  25. }
  26. HttpResponse baseResponse = client.doAction(openAdRequest);
  27. byte[] contentBytes = baseResponse.getContent();
  28. String strTmp = null;
  29. try {
  30. strTmp = new String(contentBytes,"UTF-8");
  31. } catch (UnsupportedEncodingException e) {
  32. e.printStackTrace();
  33. }
  34. System.out.println(strTmp);
  35. } catch (ClientException e) {
  36. e.printStackTrace();
  37. } catch (IOException e) {
  38. e.printStackTrace();
  39. }
  40. }
  41. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回图片尺寸,大小,存储地址等信息
errorCode 错误码
message 错误提示信息

返回样例

JSON返回

  1. {
  2. "data": {
  3. "byte": 120432,
  4. "width": 728,
  5. "url": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/Y2ppZWE5YTR3MDAwdzNiNXV3ZmJ2enkwag==_1_NzI4Kjkw.jpg",
  6. "height": 90
  7. },
  8. "result": "SUCCESS"
  9. }

视频上传接口

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/upload/video/

参数列表

HEAD 类型 说明
ORG-DSPID long DSP_ID
FILE-EXT-NAME String required 视频后缀名称(例:wmv、gif、3pg、wav、mkv、rmvb、mp4、avi、mov、swf、mov)
参数 类型 必填 描述
String Y 文件二进制流转String

请求样例

  1. <http://xxxxxx.aliyuncs.com/upload/video/>
  1. public void updateVideo(HttpServletResponse response) {
  2. boolean isMultipart = ServletFileUpload.isMultipartContent(request);
  3. if (isMultipart) {
  4. Map<String, String> headMap = new HashMap<String, String>();
  5. MultipartFile multipartFile = ((MultipartHttpServletRequest) request).getFile("file");
  6. String FILE_EXT_NAME = StringUtils.substringAfterLast(multipartFile.getOriginalFilename(), ".");
  7. headerMap.put("FILE-EXT-NAME", FILE_EXT_NAME);
  8. String url = "/upload/video/";
  9. headMap.put(ORG_DSPID_HEADER, dspId);
  10. try {
  11. headerMap.remove("content-length");
  12. headerMap.put("content-type", "application/json;charset=UTF-8");
  13. String body = new String(Base64.encodeBase64(multipartFile.getBytes()),"utf-8");
  14. openAdService.init({accessId}, {accessKey}});//填写AK信息
  15. OpenAdRequest openAdRequest = new OpenAdRequest("2017-03-08", url,methodType);
  16. openAdRequest.setContentType(FormatType.RAW);
  17. openAdRequest.setAcceptFormat(FormatType.JSON);
  18. openAdRequest.setMethod(MethodType.POST);
  19. openAdRequest.setContent(body.getBytes("UTF-8"),"utf-8", FormatType.RAW);
  20. if(headerMap != null && !headerMap.isEmpty()){
  21. for (String key : headerMap.keySet()) {
  22. openAdRequest.putHeaderParameter(key,headerMap.get(key));
  23. }
  24. }
  25. HttpResponse baseResponse = client.doAction(openAdRequest);
  26. byte[] contentBytes = baseResponse.getContent();
  27. String strTmp = null;
  28. try {
  29. strTmp = new String(contentBytes,"UTF-8");
  30. } catch (UnsupportedEncodingException e) {
  31. e.printStackTrace();
  32. }
  33. System.out.println(strTmp);
  34. } catch (IOException e) {
  35. e.printStackTrace();
  36. } catch (ClientException e) {
  37. e.printStackTrace();
  38. }
  39. }
  40. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回大小,存储地址等信息
errorCode 错误码
message 错误提示信息

返回样例

JSON返回

  1. {
  2. "result": "SUCCESS",
  3. "data": {
  4. "byte": 15598,
  5. "width": 200,
  6. "url": "http://200x200.jpg",
  7. "height": 200
  8. }
  9. }