媒体管理API

媒体管理API

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

创建媒体(CreateAdMediaRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/mediainfo?showId={$showId}

参数列表

参数 类型 必填 描述
showId bool Y 创建成功是否返回id (true:返回id)
media_name string Y 媒体名称
media_type_id int Y 媒体类别(1:pc;2:app;3:wap;4:o2o)
media_domain string N 媒体域名
media_pv long Y 媒体曝光量
ratio double N CPM/CPC比例,默认10
cpa_cpm_ratio double N CPM/CPA比例,默认100
cpi_cpm_ratio double N CPM/CPI比例,默认100
media_ address string N 门店地址
media_img_path string N 门店图片地址
third_party_id string Y 第三方定义的媒体id
third_party_type string Y 第三方类型(0-二方媒体, 1-tanx)

请求样例

  1. http://xxxxxx.aliyuncs.com/mediainfo?showId=true
  1. {
  2. "media_name":"新浪",
  3. "media_type_id":"1",
  4. "third_party_type":"7",
  5. "media_domain":"www.lcfhk.com",
  6. "ratio":1,
  7. "cpa_cpm_ratio":2,
  8. "cpi_cpm_ratio":3,
  9. "third_party_id":"1",
  10. "media_address":""
  11. }

返回字段

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

返回样例

JSON格式

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

修改媒体(UpdateAdMediaRequest)

请求方式

PUT

请求结构

http://xxxxxx.aliyuncs.com/mediainfo/{id}

参数列表

参数 类型 必填 描述
id long Y 媒体id
media_name string N 媒体名称
media_type_id int Y 媒体类别(1:pc;2:app;3:wap;4:O2O)
media_domain string N 媒体域名
media_pv long N 媒体曝光量
ratio double N CPM/CPC比例
cpa_cpm_ratio double N CPM/CPA比例
cpi_cpm_ratio double N CPM/CPI比例
media_ address string N 门店地址
media_img_path string N 门店图片地址
media_ address string N 门店地址
media_img_path string N 门店图片地址
third_party_id string Y 第三方定义的媒体id
third_party_type string Y 第三方类型(0-二方媒体, 1-tanx)

请求样例

  1. http://xxxxxx.aliyuncs.com/mediainfo/123
  1. {
  2. "media_name":"新浪",
  3. "media_type_id":"1",
  4. "third_party_type":"2",
  5. "media_domain":"www.lcfhk.com",
  6. "ratio":1,
  7. "cpa_cpm_ratio":2,
  8. "cpi_cpm_ratio":3,
  9. "third_party_id":"1",
  10. "media_address":"",
  11. "id":3010011
  12. }

返回字段

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

返回样例

JSON格式

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

删除媒体(DeleteAdMediaRequest)

请求方式

DELETE

请求结构

http://xxxxxx.aliyuncs.com/mediainfo/${media_id}

参数列表

参数 类型 必填 描述
media_id long Y 媒体id

请求样例

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

返回字段

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

返回样例

JSON格式

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

媒体列表(GetAdMediaListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/mediainfo/dsp/query/?page=${page}&size=${size}&query_str=${query_str}&media_type_id=${media_type_id}&dict=${dict}&media_ids=${media_ids}&third_party_types=${third_party_types}

参数列表

参数 类型 必填 描述
page int N 当前页码,默认1
size int N 一页展现条数,默认10
query_str string N 搜索关键词,默认null
media_type_id int N 媒体类别id(1:pc;2:app;3:wap;4:o2o),默认null
dict boolean N 是否是媒体字典,如果是,按pv排序(true:是;false:不是),默认false
site_cate_id int N 媒体类目ID(媒体类目字典),dict为true时生效
third_party_types string N 第三方类型(0-二方媒体, 1-tanx)
media_ids string N 媒体ids(1,2,3)用来查询包含此id的媒体

请求样例

  1. http://xxxxxx.aliyuncs.com/mediainfo/dsp/query/?page=1&size=10

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 媒体id
media_name 媒体名称
media_domain 媒体域名
third_party_type 第三方类型(1:阿里妈妈Tanx;2:二方媒体;3:百度流量交易服务(Baidu Exchange Service);4:腾讯广告实时交易平台(Tencent AdExchange);5:Google DoubleClick)
third_party_id 第三方定义的媒体ID
ad_site_count 推广位个数
media_type_id 媒体类别id(1:pc;2:app;3:wap;4:o2o)
media_pv 预计曝光量
ratio CPM/CPC比例
cpa_cpm_ratio CPM/CPA比例
cpi_cpm_ratio CPM/CPI比例
media_ address 门店地址
media_img_path 门店图片地址

返回样例

JSON格式

  1. {
  2. "data": {
  3. "total": 1,
  4. "list": [{
  5. "third_party_type": 2,
  6. "media_domain": "alibaba.com",
  7. "ad_site_count": 2,
  8. "id": 100010,
  9. "media_name": "abc",
  10. "media_type_id": 1,
  11. "third_party_id":"1",
  12. "cpi_cpm_ratio": 100,
  13. "media_pv": 5454121,
  14. "cpa_cpm_ratio": 100,
  15. "ratio": 10
  16. }]
  17. },
  18. "result": "SUCCESS"
  19. }

O2O创建推广位(CreateAdMediaSiteRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo?showId={$showId}

参数列表

参数 类型 必填 描述
showId bool Y 创建成功是否返回id (true:返回id)
media_id long Y 媒体id
name string Y 推广位名称
ad_site_size string Y 推 广位大小
ad_site_type_id string Y 推广位类型,见附录推广位展现类型字典表
site_cate_id long Y 类目id,见附录类目字典
is_cpt int Y 是否是cpt推广位(0:不是;1:是)
img_path string N 门店图片地址
bid_price string Y 推广位出价
daily_pv long Y 推广位日均pv
third_party_type int Y 第三方定义类型默认2
support_download int Y 0-不支持下载;1-不限;2-只支持下载
excluded_content string N 屏蔽的内容

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo?showId=true
  1. {
  2. "name": "zw测试",
  3. "ad_site_type_id": "302",
  4. "ad_site_size": "320*100",
  5. "site_cate_id": "43084",
  6. "excluded_content": "12",
  7. "daily_pv": 111,
  8. "support_download": 2,
  9. "is_cpt": 1,
  10. "img_path": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/MzI5MGNlNDgtOTlhNC00OTRlLWIxM2QtY2FiMjA5MWExZmMx_1_OTAwKjU2MA==.jpg",
  11. "media_id": 3010013,
  12. "third_party_type": 2,
  13. "bid_price": 0
  14. }

返回字段

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

返回样例

JSON格式

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

修改推广位(UpdateAdMediaSiteRequest)

请求方式

PUT

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/{id}

参数列表

参数 类型 必填 描述
id long Y 推广位id
showId bool Y 创建成功是否返回id (true:返回id)
media_id long Y 媒体id
name string Y 推广位名称
ad_site_size string Y 推 广位大小
ad_site_type_id string Y 推广位类型,见附录推广位展现类型字典表
site_cate_id long Y 类目id,见附录类目字典
is_cpt int Y 是否是cpt推广位(0:不是;1:是)
img_path string N 门店图片地址
bid_price string Y 推广位出价
daily_pv long Y 推广位日均pv
third_party_type int Y 第三方定义类型默认2
support_download int Y 0-不支持下载;1-不限;2-只支持下载
excluded_content string N 屏蔽的内容

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo/123
  1. {
  2. "name": "zw测试",
  3. "ad_site_type_id": "302",
  4. "ad_site_size": "320*100",
  5. "site_cate_id": "43084",
  6. "excluded_content": "12",
  7. "daily_pv": 111,
  8. "support_download": 2,
  9. "is_cpt": 1,
  10. "img_path": "http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/MzI5MGNlNDgtOTlhNC00OTRlLWIxM2QtY2FiMjA5MWExZmMx_1_OTAwKjU2MA==.jpg",
  11. "media_id": 3010013,
  12. "third_party_type": 2,
  13. "bid_price": 0
  14. }

返回字段

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

返回样例

JSON格式

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

删除推广位(DeleteAdMediaSiteRequest)

请求方式

DELETE

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/${site_id}/

参数列表

参数 类型 必填 描述
site_id long Y 推广位id

请求样例

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

返回字段

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

返回样例

JSON格式

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

推广位列表(GetAdMediaSiteListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/media_id/${meida_id}/?page=${page}&size=${size}

参数列表

参数 类型 必填 描述
media_id long Y 媒体id(如果不希望通过媒体id搜索,填0)
is_cpt long N 是否是cpt推广位
pids long N 推广位id多值列(例如:“1,2,555,646”)
media_type_id long N 媒体类型id(1:pc;2:app;3:wap;4:o2o),
ad_plan_id long N 计划id
third_party_types long N 2-二方媒体
page int N 当前页码,默认1
size int N 一页展现条数,默认10

请求样例

  1. http://xxxxxx.aliyuncs.com//mediaadsiteinfo/media_id/12/?page=1&size=10

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
id 推广位id
media_id 媒体id
name 推广位名称
ad_site_size 推广位大小
ad_site_type_id 推广位类型,见附录推广位类型字典表
site_cate_id 类目id,见附录类目字典
is_cpt 是否是cpt推广位(0:不是;1:是)
img_path 门店图片地址

返回样例

JSON格式

  1. {
  2. "data": {
  3. "total": 1,
  4. "list": [{
  5. "ad_site_size": "320*100",
  6. "site_cate_id": 43101,
  7. "daily_pv": 1,
  8. "third_party_type": 2,
  9. "support_download": 2,
  10. "name": "werw",
  11. "media_id": 2000010,
  12. "ad_site_type_id": "2",
  13. "id": 2000011,
  14. "is_cpt": 0,
  15. "bid_price": 0.0000
  16. }]
  17. },
  18. "result": "SUCCESS"
  19. }

创建CPT推广位排期(CreateAdMediaSiteCptPlanRequest)

请求方式

POST

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/create/schedule/

参数列表

参数 类型 必填 描述
advertiser_id long Y 推广主id
schedule_name string Y 排期名称
pid long Y 推广位id
start_time time Y 开始时间(yyyy-mm-dd)
end_time long Y 结束时间(yyyy-mm-dd)
delivery_hour string Y 排期时间小时,一周小时时间数组(0~167),多选使用多值列传输
cpt_price string Y 该cpt推广位收费价格(元)
media_type_id int Y 媒体类别(1:pc;2:app;3:wap;4:o2o)

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo/create/schedule/
  1. { "advertiser\_id": 100010, "schedule_name": "abc", "pid": 10000, "start\_time": "2017-01-01", "end\_time": "2017-01-08", "delivery\_hour": "0,1,2,3,4,156,166", "cpt\_price": 100, "media\_type\_id": 1 }

返回字段

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

返回样例

JSON格式

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

修改CPT推广位排期(UpdateAdMediaSiteCptPlanRequest)

请求方式

PUT

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/${id}/

参数列表

参数 类型 必填 描述
id long Y 排期id
schedule_name string N 排期名称
start_time time N 开始时间(yyyy-mm-dd)
end_time long N 结束时间(yyyy-mm-dd)
delivery_hour string N 排期时间小时,一周小时时间数组(0~167),多选使用多值列传输
cpt_price string N 该cpt推广位收费价格(元)

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/123/
  1. { "advertiser\_id": 100010, "schedule_name": "abc", "pid": 10000, "start\_time": "2017-01-01", "end\_time": "2017-01-08", "delivery\_hour": "0,1,2,3,4,156,166", "cpt\_price": 100 }

返回字段

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

返回样例

JSON格式

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

删除CPT推广位排期(DeleteAdMediaSiteCptPlanRequest)

请求方式

DELETE

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/${id}/

参数列表

参数 类型 必填 描述
id long Y 排期id

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/1/

返回字段

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

返回样例

JSON格式

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

查看CPT推广位排期(GetAdMediaSiteCptPlanRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/${cpt_plan_id}/

参数列表

参数 类型 必填 描述
cpt_plan_id long Y 排期id
advertiser_id long Y 推广主id
plan_name string Y 排期名称
pid long Y 推广位id
start_time time Y 开始时间(yyyy-mm-dd)
end_time long Y 结束时间(yyyy-mm-dd)
delivery_hour string Y 排期时间小时,一周小时时间数组(0~167),多选使用多值列传输
cpt_price string Y 该cpt推广位收费价格(元)

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/100/?advertiser\_id=10&start\_time=2017-10-01&end\_time=2018-01-10

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回true/false
errorCode 错误码
message 错误提示信息
id 排期id
advertiser_id 推广主id
plan_name 排期名称
pid 推广位id
start_time 开始时间(yyyy-mm-dd)
end_time 结束时间(yyyy-mm-dd)
delivery_hour 排期时间小时,一周小时时间数组(0~167),多选使用多值列传输
cpt_price 该cpt推广位收费价格(元)

返回样例

返回结果会以JSON的格式返回

JSON格式

  1. {
  2. "data": {
  3. "total": 1,
  4. "list": [{
  5. "id": 100010,
  6. "advertiser_id": 231312,
  7. "plan_name": "9月份排期",
  8. "pid": 1,
  9. "start_time": "2017-01-01",
  10. "end_time": "2017-01-09",
  11. "delivery_hour": "1,11,24,55,76,166",
  12. "cpt_price": "5454121"
  13. }, {
  14. "id": 100010,
  15. "advertiser_id": 231312,
  16. "plan_name": "9月份排期B",
  17. "pid": 1,
  18. "start_time": "2017-01-01",
  19. "end_time": "2017-01-09",
  20. "delivery_hour": "1,11,24,55,76,121,135,166",
  21. "cpt_price": "5454121"
  22. }]
  23. },
  24. "result": "SUCCESS"
  25. }

查看CPT推广位排期列表(GetAdMediaSiteCptPlanListRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/pid/${pid}/

参数列表

参数 类型 必填 描述
pid long N 推广位id
adv_id long N 推广主id
query_str string N 排期名称
media_id time N 媒体id)

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo/schedule/pid/1/

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回true/false
errorCode 错误码
message 错误提示信息
id 排期id
advertiser_id 推广主id
plan_name 排期名称
pid 推广位id
start_time 开始时间(yyyy-mm-dd)
end_time 结束时间(yyyy-mm-dd)
delivery_hour 排期时间小时,一周小时时间数组(0~167),多选使用多值列传输
cpt_price 该cpt推广位收费价格(元)

返回样例

JSON格式

  1. {
  2. "data": [{
  3. third_party_type": 2,
  4. "ad_site_count": 1,
  5. "cpi_cpm_ratio": 3.0,
  6. "media_pv": 111,
  7. "media_os": 0,
  8. "media_address": "{\"address\":\"xxxxx\",\"region\":[\"中国\",\"北京市\",\"北京市市辖区\"]}",
  9. "id": 3010013,
  10. "media_name": "lcfhk",
  11. "media_type_id": 4,
  12. "media_img_path": "[\"http://107167.oss-cn-hangzhou-zmf.aliyuncs.com/ZTEzNzNmYTEtOTY3NS00MjY4LThkOWQtOWUwY2U4YTY0Njhm_1_OTAwKjU2MA==.jpg\"]",
  13. "cpa_cpm_ratio": 2.0,
  14. "ratio": 1.0
  15. }],
  16. "result": "SUCCESS"
  17. }

获取JS拼装参数(GetAdJsRequest)

请求方式

GET

请求结构

http://xxxxxx.aliyuncs.com/mediaadsiteinfo/js/{site_id}

参数列表

参数 类型 必填 描述
site_id long Y 推广位id

请求样例

  1. http://xxxxxx.aliyuncs.com/mediaadsiteinfo/js/1000

返回字段

字段名 说明
result 返回执行结果,取值:SUCCESS/FAILURE
data 返回查询数据
errorCode 错误码
message 错误提示信息
as 尺寸
c 推广位所属类目id,见附录类目字典
at 媒体类型
mid 媒体id
pid 推广位id
did dsp公司id
vt 展现形式

返回样例

JSON格式

  1. {
  2. "data": {
  3. "total": 1,
  4. "list": [{
  5. "ad_site_size": "320*50",
  6. "site_cate_id": 43008,
  7. "name": "abc",
  8. "media_id": 100010,
  9. "ad_site_type_id": "13",
  10. "id": 10004
  11. }]
  12. },
  13. "result": "SUCCESS"
  14. }