接口描述:

  • 获取广告列表。

请求 URL:

  • http|https://host/api/v1/ads/method/get.ads.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
ads_position_id integer gt:0 1 广告位置编号
code string max:16 index_1 广告编码
platform integer between:-128,127 0 广告平台(自定义)
name string max:100 五一促销 广告名称
type integer in:0,1 1 广告类型 0=图片 1=代码
status integer in:0,1 1 是否可见 0=禁用 1=启用
begin_time datetiem beforeTime:end_time 2018-05-01 00:00:00 开始投放时间
end_time datetiem afterTime:begin_time 2018-05-30 23:59:59 投放结束时间
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc desc asc 排序方式
order_field string 见附属 A ads_id status 排序字段

附属 A:
in:ads_id,ads_position_id,name,begin_time,end_time,sort,status

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 5 合计计数
items 类型 是否返回 示例值 描述
ads_id integer 5 广告编号
code string index_1 广告编码
platform integer 0 广告平台(自定义)
name string 五一促销 广告名称
url string # 链接地址
target string _self 打开方式
color string #ffffff 广告背景色
type integer 1 广告类型 0=图片 1=代码
begin_time string 2018-05-01 00:00:00 开始投放时间
end_time string 2018-05-03 23:59:59 投放结束时间
sort integer 50 广告排序值
status integer 1 是否可见 0=禁用 1=启用
get_ads_position object [] 广告位对象
get_ads_position 类型 是否返回 示例值 描述
ads_position_id integer 1 广告位编号
name string PC首页 广告位名称

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "ads_id": 1,
  8. "code": "",
  9. "platform": 0,
  10. "name": "广告A",
  11. "url": "#",
  12. "target": "_self",
  13. "color": "#ffffff",
  14. "type": 1,
  15. "begin_time": "2018-05-08 11:10:00",
  16. "end_time": "2018-05-09 11:30:00",
  17. "sort": 20,
  18. "status": 1,
  19. "get_ads_position": {
  20. "ads_position_id": 1,
  21. "name": "PC首页"
  22. }
  23. },
  24. {
  25. "ads_id": 5,
  26. "code": "index_1",
  27. "platform": 0,
  28. "name": "五一促销",
  29. "url": "#",
  30. "target": "_self",
  31. "color": "#ffffff",
  32. "type": 1,
  33. "begin_time": "2018-05-01 00:00:00",
  34. "end_time": "2018-05-30 23:59:59",
  35. "sort": 50,
  36. "status": 1,
  37. "get_ads_position": {
  38. "ads_position_id": 1,
  39. "name": "PC首页"
  40. }
  41. }
  42. ],
  43. "total_result": 5
  44. }
  45. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2019-02-18 15:55