管理员物料管理API

管理员物料管理API

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

此API主要描述管理员对广告物料的管理。

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

API调用实例

API调用路径以及参数介绍

创建抄底创意(CreateAdDefaultCreativeRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/default_creative

参数列表

参数 类型 必填 描述
creative_desc string N 创意描述,默认null
img_path string N 图片路径,默认null
img_size string Y 图片尺寸,格式:宽*高,默认null
dest_url string Y 目标地址链接
wechat_url string N 目标微信地址,默认null
creative_type int Y 创意类型(1、图文;2:微信;3:文字链;4:图片;5:动画或视频),默认1
animation_type int N 动画类型(1:图片;2:flash.swf;3:flash.flv;4: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
user_define string Y 自定义字段JSON格式。无值填”不使用模板”
button_text string N 按钮描述,默认null
button_href string N 按钮链接,默认null
button_style string N 按钮样式,默认null
background_color string N 按钮背景色,默认null
title string N title,默认null
uuid string N 图片上传uuid,默认null
is_download int Y 是否下载型创意,默认填0
download_url string N 下载url,默认null
user_content string N 用户模板信息,默认null

请求样例

  1. http://xxxxxx.aliyuncs.com/default_creative
  1. {
  2. "creative_type": "5",
  3. "img_size": "728*15",
  4. "dest_url": "http://www.aliyun.com",
  5. "is_download": 0,
  6. "animation_url": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/Y2ppYjNzNWc0MDAyaTNiNXZsdXN2Y2I0cw==_1.mp4",
  7. "user_content": "{\"body\":{}}",
  8. "user_define": "{\"id\":0,\"title\":\"自定义模板\",\"items\":[{\"name\":\"\",\"value\":\"\",\"type\":\"string\"}],\"body\":{}}",
  9. "uuid": "cjib3s5g4002i3b5vlusvcb4s"
  10. }
  1. public void creativeDefaultCreative(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 = "/default_creative";
  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 }

修改抄底创意(UpdateAdDefaultCreativeRequest)

请求方式

PUT

请求结构

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

参数列表

参数 类型 必填 描述
creative_desc string N 创意描述,默认null
img_path string N 图片路径,默认null
img_size string Y 图片尺寸,格式:宽*高,默认null
dest_url string Y 目标地址链接
wechat_url string N 目标微信地址,默认null
creative_type int Y 创意类型(1、图文;2:微信;3:文字链;4:图片;5:动画或视频),默认1
animation_type int Y 动画类型(1:图片;2:flash.swf;3:flash.flv;4: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
user_define string Y 自定义字段JSON格式。无值填”不使用模板”
button_text string N 按钮描述,默认null
button_href string N 按钮链接,默认null
button_style string N 按钮样式,默认null
background_color string N 按钮背景色,默认null
title string N title,默认null
uuid string N 图片上传uuid,默认null
is_download int Y 是否下载型创意,默认填0
download_url string N 下载url,默认null
user_content string N 用户模板信息,默认null

请求样例

  1. http://xxxxxx.aliyuncs.com/default_creative/10000002/
  1. {
  2. "creative_type": "4",
  3. "img_size": "640*320,200*140",
  4. "dest_url": "http://www.aliyun.com",
  5. "is_download": 0,
  6. "img_path": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/Y2ppYmJ4azVwMDAydTNiNXY4eGRvamd0Mg==_1_.jpg",
  7. "user_content": "{\"body\":{}}",
  8. "user_define": "{\"id\":0,\"title\":\"自定义模板\",\"items\":[{\"name\":\"\",\"value\":\"\",\"type\":\"string\"}],\"body\":{}}",
  9. "uuid": "cjibbxk5p002u3b5v8xdojgt2"
  10. }
  1. public void updateDefaultCreative(@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 = "/default_creative/" + 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 }

删除抄底创意(DeleteAdDefaultCreativeRequest)

请求方式

DELETE

请求结构

http://xxxxxx.aliyuncs.com/default_creative/${ad_creative_id}/

参数列表

参数 类型 必填 描述
ad_creative_id long Y 抄底创意id

请求样例

  1. http://xxxxxx.aliyuncs.com/default_creative/1/
  1. public void deleteDefaultCreative(@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 = "/default_creative/" + 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.DELETE,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 }

抄底创意列表(GetAdDefaultCreativeListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/default_creative/dsp/list/?page=${page}&size=${size}&queryStr=${queryStr}

参数列表

参数 类型 必填 描述
query_str string N 创意名称匹配关键词(中文需urlencode后传输)
page int N 当前页码,默认1
size int N 一页展现条数,默认10

请求样例

  1. http://xxxxxx.aliyuncs.com/default_creative/dsp/list/?page=1&size=10&queryStr=abc
  1. public void getDefaultCreative(HttpServletResponse response) {
  2. String queryStr = request.getParameter("queryStr");
  3. String page = request.getParameter("page");
  4. String size = request.getParameter("size");
  5. String url = "/default_creative/dsp/list/" + "?page=" + pageNumber + "&size=" + size;
  6. if(StringUtils.isNotBlank(queryStr) && !queryStr.equals("null")){
  7. url= url + "&queryStr=" + queryStr;
  8. }
  9. Map<String, String> headMap = new HashMap<String, String>();
  10. headMap.put(ORG_DSPID_HEADER, dspId);
  11. try {
  12. openAdService.init({accessId}, {accessKey}});//填写AK信息
  13. } catch (ClientException e) {
  14. e.printStackTrace();
  15. }
  16. try {
  17. String content = openAdService.request(url,MethodType.GET,headMap,null);
  18. System.out.println(content);
  19. } catch (ClientException e) {
  20. e.printStackTrace();
  21. }
  22. }

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 创意id
gmt_modified 创意修改时间
creative_desc 创意描述
creative_status 创意状态(0:未审核;1:启动;-2:不通过;2:通过暂停)
dest_url 目标链接地址
img_path 图片地址
img_size 图片大小
wechat_url 目标微信地址
animation_type 动画类型(1:图片;2:flash.swf;3:flash.flv;4:mp4)
animation_url 动画素材上传地址
animation_width 动画素材宽度
animation_height 动画素材高度
animation_monitor_url 动画曝光监控地址
monitor_url 监控地址,默认null
click_monitor_url 点击监控地址,默认null

返回样例

JSON返回

  1. {
  2. "data": {
  3. "total": 1,
  4. "list": [{
  5. "gmt_modified": "2016-08-26 16:17:54",
  6. "img_path": " 0_1_234×60.png",
  7. "dest_url": "http://www.taobao.com",
  8. "id": 11,
  9. "dspId": 1,
  10. "img_size": "234*60",
  11. "gmtCreate": "2016-08-26 16:17:54"
  12. }]
  13. },
  14. "result": "SUCCESS"
  15. }

创意审核列表(GetAdChectCreativeListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/adcreative/check/list/?query_str=${query_str}&pass=${pass}&adv_id&${adv_id}&group_id=${group_id}&plan_id=${plan_id}&pid=${pid}&creativeStatus=${creativeStatus}&page=${page}&size=${size}

参数列表

参数 类型 必填 描述
query_str string N 创意名称
pass string N 审核状态以逗号分隔(0,1,2)
adv_id string N 推广主id
group_id string N 推广组id
plan_id string N 推广计划id
pid string N 推广位id
creativeStatus string N 审核状态(全部 null,未审核 0,已通过-启动 1,已通过-暂停 2,未通过 -2)
page int 当前页码,默认1
size int 一页展现条数,默认10

请求样例

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

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 创意id
gmt_modified 创意修改时间
creative_desc 创意描述
ad_plan_name 推广计划名称
ad_group_name 推广组名称
ad_plan_id 推广计划ID
ad_group_id 推广组ID
category 创意类目id
creative_name 创意名称
creative_status 创意状态(0:未审核;1:启动;2:通过暂停;-2:不通过)
dest_url 目标链接地址
group_type 推广组类型( 1:移动;0:PC)
img_path 图片地址
img_size 图片大小
wechat_url 目标微信地址
animation_type 动画类型(1:图片;2:flash.swf;3:flash.flv;4:mp4)
animation_url 动画素材上传地址
animation_width 动画素材宽度
animation_height 动画素材高度
animation_monitor_url 动画曝光监控地址
monitor_url 监控地址,默认null
click_monitor_url 点击监控地址,默认null
ot_id 绑定人群id,默认null
user_define 自定义字段(带自定义格式),默认null
user_content 自定义字段(仅自定义内容),默认null
is_download 是否默认下载(0:不下载;1:下载)
download_url 下载url,默认null
creative_score 创意静态分
advertiser_id 推广主id
ad_source_type 流量来源(1:阿里妈妈;2:百度BES;3:腾讯AdExchange;4:谷歌DoubleClick;5:网易YEX;6:灵集;7:硬核;8:佳投;9:Smaato;10:AdView)

返回样例

JSON返回

  1. {
  2. "data": {
  3. "total": 1,
  4. "list": [{
  5. "creative_name": "abc",
  6. "gmtModified": "2017-01-04 15:08:15",
  7. "check_reason": "",
  8. "dest_url": "http://www.aliyun.com",
  9. "img_size": "200*200",
  10. "is_default": 0,
  11. "img_path": "http://i_1_200x200.jpg",
  12. "id": 10000002,
  13. "ad_group_id": 10000003,
  14. "category": 90653,
  15. "creative_status": 0
  16. }]
  17. },
  18. "result": "SUCCESS"
  19. }

审核创意(CheckAdCreativeRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/adcreative/dsp/check/

参数列表

参数 类型 必填 描述
ids string Y 创意id
pass string Y 是否通过(通过:true;不通过:false)
reason string N 不通过原因

请求样例

  1. http://xxxxxx.aliyuncs.com/adcreative/dsp/check/
  2. { "ids": "10000002", "pass": "false", "reason": "test" }
  1. public void check(@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/dsp/check/";
  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 }