后端API接口文档

创建广告 /v2/activities/ads/create POST JSON

参数名 参数类型 参数描述 必选
place number 1：首页，顶部公告栏 2：首页，右侧浮窗 3：浏览页，右侧Banner 4：发现页，顶部Banner 是
title string 标题 是
startTime Date 开始时间 否
limitTime Date 结束时间 否
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间 是
cover string 封面 是
linkActivityId string 运营活动ID，若不为null，则忽略link字段，不会校验所填写的ID是否存在 否
link string 链接，当linkActivityId为空时生效 否
priority number 权重 是

编辑广告 /v2/activities/ads/update PUT JSON

参数名 参数类型 参数描述 必选
_id string _id 是
place number 1：首页，顶部公告栏 2：首页，右侧浮窗 3：浏览页，右侧Banner 4：发现页，顶部Banner 是
title string 标题 是
startTime Date 开始时间 否
limitTime Date 结束时间 否
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间 是
cover string 封面 是
linkActivityId string 运营活动ID，若不为null，则忽略link字段，不会校验所填写的ID是否存在 否
link string 链接，当linkActivityId为空时生效 否
priority number 权重 是

暂停/恢复 /v2/activities/ads/updateStatus PUT JSON

参数名 参数类型 参数描述 必选
_id string _id 是
status number 1：已排期 2：投放中 3：已结束 4：已停用 （传入4表示暂停，传入其他或不传，将自动纠正为1,2,3几种状态） 是

修改广告权重 /v2/activities/ads/updatePriority PUT JSON

参数名 参数类型 参数描述 必选
_id string _id 是
priority number 权重 是

列出广告 /v2/activities/ads/list GET QUERY

参数名 参数类型 参数描述 必选
skipSize number 略过的数目 是
pageSize number 页面大小 是
flag number 查询标记 0：全部 1：已排期 2：投放中 3：已停用 4：已结束 是
title string 标题，若不使用该条件，将其置为空字符串"" 是
place number 1：首页，顶部公告栏 2：首页，右侧浮窗 3：浏览页，右侧Banner 4：发现页，顶部Banner 是

返回结构：

{
  "ret": 0,
  "errCode": 0,
  "errcode": 0,
  "msg": "success",
  "data": {
    "num": 2,
    "ads": [
      {
        "_id": "6254f27fe1c88b10e40ac139",
        "place": 1,
        "title": "贪玩蓝月",
        "status": 2,
        "ev": 3,
        "pv": 1,
        "cvr": 0.3333333333333333,
        "cover": "123",
        "linkActivityId": "624fa25afc00a42be8d8f5a1",
        "linkActivityTitle": "十个亿八个亿谈笑间",
        "linkActivity": "https://mtc9ci.axshare.com/start.html#p=%E7%BF%BB%E8%AF%91%E7%AE%A1%E7%90%86&id=osbczx&g=1",
        "persist": true,
        "priority": 1
      },
      {
        "_id": "6254f2bfe1c88b10e40ac13c",
        "place": 1,
        "title": "末日争霸",
        "status": 2,
        "ev": 0,
        "pv": 0,
        "cover": "abc",
        "linkActivityId": "624fa25afc00a42be8d8f5a1",
        "linkActivityTitle": "十个亿八个亿谈笑间",
        "linkActivity": "https://mtc9ci.axshare.com/start.html#p=%E7%BF%BB%E8%AF%91%E7%AE%A1%E7%90%86&id=osbczx&g=1",
        "persist": true,
        "priority": 1
      }
    ]
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

结构参数：

参数名 参数类型 参数描述
_id number _id
place number 1：首页，顶部公告栏 2：首页，右侧浮窗 3：浏览页，右侧Banner 4：发现页，顶部Banner
title string 标题
status number 1：已排期 2：投放中 3：已结束 4：已停用 （传入4表示暂停，传入其他或不传，将自动纠正为1,2,3几种状态）
ev number 曝光量
pv number 点击量
cvr number 曝光率
startTime Date 开始时间
limitTime Date 结束时间
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间
cover string 封面
linkActivityId string 链接活动ID
linkActivityTitle string 链接活动标题
linkActivity string 链接活动
link string 链接
priority number 权重

查询广告 /v2/activities/ads/find GET QUERY

参数名 参数类型 参数描述 必选
_id number _id 是

返回结构：

{
  "ret": 0,
  "errCode": 0,
  "errcode": 0,
  "msg": "success",
  "data": {
    "_id": "6254f27fe1c88b10e40ac139",
    "place": 1,
    "title": "贪玩蓝月",
    "status": 2,
    "ev": 3,
    "pv": 1,
    "cvr": 0.3333333333333333,
    "cover": "123",
    "linkActivityId": "624fa25afc00a42be8d8f5a1",
    "linkActivityTitle": "十个亿八个亿谈笑间",
    "linkActivity": "https://mtc9ci.axshare.com/start.html#p=%E7%BF%BB%E8%AF%91%E7%AE%A1%E7%90%86&id=osbczx&g=1",
    "persist": true,
    "priority": 1
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

结构参数：

参数名 参数类型 参数描述
_id number _id
place number 1：首页，顶部公告栏 2：首页，右侧浮窗 3：浏览页，右侧Banner 4：发现页，顶部Banner
title string 标题
status number 1：已排期 2：投放中 3：已结束 4：已停用 （传入4表示暂停，传入其他或不传，将自动纠正为1,2,3几种状态）
ev number 曝光量
pv number 点击量
cvr number 曝光率
startTime Date 开始时间
limitTime Date 结束时间
persist boolean 是否永久，若此参数为true，将忽略掉开始、结束时间
cover string 封面
linkActivityId string 链接活动ID
linkActivityTitle string 链接活动标题
linkActivity string 链接活动
link string 链接
priority number 权重

访问广告（埋点） /v2/activities/ads/visit GET QUERY

参数名 参数类型 参数描述 必选
_id number _id 是

点击广告（埋点） /v2/activities/ads/click GET QUERY

参数名 参数类型 参数描述 必选
_id number _id 是

← 运营广告接口文档_客户端 →