Adlib广告库管理相关接口
所有文档

          Cloud DSP

          Adlib广告库管理相关接口

          接口说明

          广告库基本概念

          名次 说明
          User 广告主
          Plan 广告投放计划,一个广告主可以有多个投放计划
          Unit 广告投放单元,一个计划可以有多个投放单元
          Unit Targeting 单元定向条件,控制参与竞价的条件,每个单元可有多个定向条件
          Idea 广告创意,一个单元下面包含多个创意

          广告库相关错误码

          code message
          GetUserFailed Get user failed, the user id not exist.
          CreateUserFailed Create user failed, the userName is null.
          Create or update user failed User name is repeated.
          GetPlanFailed Get plan failed, the plan id not exist.
          UpdatePlanFailed Update plan failed, the plan name not exist.
          UpdatePlanFailed Update plan failed, the plan budget not exist.
          UpdatePlanFailed Update plan failed, the plan cycle not exist.
          UpdatePlanFailed Update plan failed, the plan start time not exist.
          UpdatePlanFailed Update plan failed, the plan end time not exist.
          Parse plan cycle error The plan cycle format is not right.
          Create or update plan failed Plan name is repeated.
          Update plan failed User id is changed.
          GetUnitFailed Get unit failed, the unit id not exist.
          CreateUnitFailed Create unit failed, the user id is null.
          CreateUnitFailed Create unit failed, the plan id is null.
          CreateUnitFailed Create unit failed, the unit name is null.
          CreateUnitFailed Create unit failed, the bid is null.
          CreateUnitFailed Create unit failed, the bid type is null.
          CreateUnitFailed Create unit failed, the adview type is null.
          Create or update unit failed Unit name is repeated.
          Update unit failed User id is changed.
          Update unit failed Plan id is changed.
          GetIdeaFailed Get idea failed, the idea id not exist.
          CreateIdeaFailed Create idea failed, the user id is null.
          CreateIdeaFailed Create idea failed, the plan id is null.
          CreateIdeaFailed Create idea failed, the unit id is null.
          CreateIdeaFailed Create idea failed, the ideaType is null.
          CreateIdeaFailed Create idea failed, the assets is null.
          CreateIdeaFailed Create idea failed, the name is null.
          CreateIdeaFailed Create idea failed, the landing page is null.
          UpdateAuditFailed Update audit failed, the audit status is null.
          Create or update idea failed Idea name is repeated.
          Update idea failed User id is changed.
          Update idea failed Plan id is changed.
          Update idea failed Unit id is changed.

          对象定义

          User对象

          名称 类型 说明
          userId long 广告主ID
          userName string 广告主名称
          trade string 行业分类
          profit_rate long 利润率*10000
          qualificationName string 资质名 (用于广告主审核)
          siteName string 广告主站点名 (用于审核)
          siteUrl string 广告主站点url (用于审核)
          balance long 账户余额, 单位分,创建时默认为0,请通过财务接口修改该值。
          contact string 联系人
          phone string 联系电话
          license string 营业执照
          icp string ICP证书
          orgCodeCert string 组织机构代码证
          additionalCerts string 其他资质
          status UserStatus 广告主状态(Enabled(0):投放中,Disabled(1):不投放,DELETED(-1):删除状态,默认状态为投放中。

          Plan对象

          名称 类型 说明
          planId long 广告计划id
          userId long 所属广告主id
          planName string 计划名称 (同广告主下需唯一)
          budget int 每日预算 (单位:分)
          planCycle String[] 一天24小时用24个字符表示,如果某小时投放则为1,反之为0。
          比如:110000000000000000000000,代表在当日00:00:00~01:59:59点投放。
          一周7(天) ,用7个长度为24字符串表示,顺序是周一到周日。
          startTime timestamp 计划开启时间
          endTime timestamp 计划停止时间
          status PlanStatus 广告主状态 (ENABLED(0):启用状态,DISABLED(1):不启用状态,DELETED(-1):删除状态,默认为ENABLED)

          Unit对象

          名称 类型 说明
          unitId long 广告单元id
          planId long 所属计划id
          userId long 所属广告主id
          unitName string 单元名称(同一计划下需唯一)
          bid long 出价 (单位:分)
          bidType int 出价类型 (UNKNOWN(-1),CPM(0),CPC(1),CPD(2), CPT(3))
          adviewType int 投放的流量类型(UNKNOWN(-1), WEB(0), WAP(1), APP(2))
          status UnitStatus 单元状态 (ENABLED(0):启用, DISABLED(1):不启用,DELETED(-1):不启用,默认ENABLED)

          UnitTargeting对象

          名称 类型 说明
          id long 单元定向id
          unitId long 广告单元id
          planId long 所属计划id
          userId long 所属广告主id
          type UnitConfigType 定向类型(详见下表)
          content string 定向内容(详见下表),默认为空。当content有内容时,enabled必须为true。当content为空,enabled必须为false。
          status UnitConfigStatus 单元的状态 (ENABLED(0):启用该定向,DISABLED(1):不限制,DELETED(-1):删除状态,默认为ENABLED)

          UnitConfigType对象(定向类型)

          type值 类型缩写 定向内容
          0 VALID_ADXS(1) 投放的adx(各adx之间以逗号分隔):
          0 – 百度bes
          1 – 百度百川
          2 – 待增加的其他adx
          e.g."0,1" 表示投放到bes和百川
          1 VALID_REGION(3) 投放的地域(各地域之间以逗号分隔)
          2 RESTRICT_REGION(4) 地域黑名单
          3 VALID_KEYWORD(5) BCE广告优选定向(逗号分隔)
          e.g."欧莱雅,兰蔻"
          表示只对这两个词感兴趣的人群投放广告。

          使用广告优选定向,需要开通"BCE广告优选"服务,请咨询你的客户经理。
          4 CYCLE(6) 一天24小时用24个字符表示,如果某小时投放则为1,反之为0。
          比如:110000000000000000000000,代表在当日00:00:00~01:59:59点投放。
          一周7(天) ,用7个长度为24字符串表示,顺序是周一到周日,逗号分隔。默认7*24小时都投放。
          5 TAR_USER_ID(24) 用户id定向(逗号分隔)
          e.g.
          "905D83D761B,905D83D761A"
          表示只对这两个cookie代表的人群投放广告。

          这里的用户id可以填写:1.ADX发送给DSP的userid
          2.DSP域下的用户cookie
          3.移动设备imei
          4.移动设备imei-md5
          5.移动设备imei-sha1
          6.ios设备idfa
          7.ios设备idfa-md5
          8.ios设备idfa-sha1
          9.android设备android-id
          10.android设备android-id-md5
          11.android设备android-id-sha1
          6 TAR_BLOCKED_USER_ID(25) 用户id黑名单(逗号分隔)
          e.g. 同上
          7 VALID_SITE(9) 站点定向(多个站点之间以逗号分隔),支持URL,站点,主域三种定向
          e.g.
          http://www.baidu.com (URL匹配),
          www.baidu.com(站点匹配),
          baidu.com(主域匹配)
          8 RESTRICT_SITE(10) 站点黑名单(逗号分隔)
          e.g. 同上。
          9 OS_TYPE(11) 操作系统定向(多个操作系统之间以逗号分隔)默认支持项:
          0 – WINDOWS
          1 – MAC
          2 – LINUX
          3 – IOS
          4 – ANDROID
          5 – WINDOWS PHONE
          e.g.
          0,1 表示定向Windows和MAC操作系统;
          3,4 表示定向移动IOS和安卓系统
          10 CARRIER_TYPE(12) 运营商定向(多个运营商之间以逗号分隔)默认支持项:
          0 – 电信
          1 – 移动
          2 – 联通
          3 – 网通
          e.g.
          0,1 表示定向电信和移动客户;
          2,3 表示定向联通和网通客户。
          11 NET_TYPE(13) 连网类型定向(多个连网类型之间以逗号分隔)默认支持项:
          0 – WIFI
          1 – 2G
          2 – 3G
          3 – 4G
          4 - Earthnet
          e.g.
          0,1 表示定向WIFI和2G客户
          12 VALID_START_TIME(14) 开始投放时间, 格式为int64类型时间戳。
          13 VALID_END_TIME(15) 结束投放时间, 格式为int64类型时间戳。
          14 VALID_POSITION(16) 广告位定向(多个广告位之间以逗号分隔)
          e.g.
          "2135" 表示定向广告位 id=2135 的广告位。
          15 FREQ_IMP_DAILY(17) 每日展现频次控制
          比如3,代表每个人每日最多看见该单元的广告3次。
          16 FREQ_CLICK_DAILY(18) 每日点击频次控制
          比如3,代表每个人每日最多点击该单元的广告3次。
          17 BROWSER(19) 浏览器定向,多个浏览器之间以逗号分隔
          0 - 微软IE
          1 - Chrome
          2 - Firefox
          3 - Safari
          4 - Opera
          5 - 微软Edge
          6 - 微信浏览器
          7 - QQ浏览器
          8 - 360浏览器
          9 - UC浏览器
          10 - 搜狗浏览器
          11 - 傲游浏览器
          18 CROWD(20) 人群定向,多个人群ID之间以逗号分隔
          19 VALID_IP(21) IP定向,多个IP之间以逗号分隔
          20 RESTRICT_IP(22) IP黑名单(逗号分隔)
          e.g. 同上
          21 EXP(23) 实验定向,多个实验ID之间以逗号分隔
          22-999 保留值 客户自定义定向请从1000开始定义

          Idea对象

          名称 类型 说明
          ideaId long 广告创意id
          unitId long 广告单元id
          planId long 所属计划id
          userId long 所属广告主id
          ideaName string 创意名称,(同一单元下创意名唯一)
          ideaSlots IdeaSlot[] 可投放的广告位类型,取值范围:
          BANNER(1):横幅 - 固定型横幅
          OPEN_SCREEN(2):开屏
          INNER_SCREEN(3):插屏
          VIDEO(4):视频
          MESSAGE_FLOW(5):信息流
          ideaType IdeaType 创意类型
          UNKNOWN(-1): 未知类型
          IMAGE(1): 图片
          FLASH(2): flash
          VIDEO(3): 视频
          NATIVE(4): Native
          landingPage string 点击登陆页面 (或下载链接)
          assets object 物料格式(见下文)
          adviewType AdviewType 投放的流量类型
          UNKNOWN(-1): 未知类型
          WEB(0)
          WAP(1)
          APP(2),与单元的流量类型一致,只读字段。
          ideaTrade string 创意所属行业 (用于创意审核), 参见附录
          ideaStatus IdeaStatus (ENABLED(0): 启用
          DISABLED(1):不启用
          DELETED(-1):删除状态)
          默认为启用
          impMonitorUrls string[] 展现监控链接,可填充多个
          clickMonitorUrls string[] 点击监控链接,可填充多个
          signature string 签名设置,用于审核
          auditStatus AuditStatus 审核状态
          PASSED(0)
          IN_PROGRESS(1)
          FAILED(2)
          DELETED(-1)
          failureMessage string 人工审核的错误信息

          物料格式

          图片

          {
          "mainImage" : {
           "url" : "http://img",     // 图片url,string, 必须
           "w": 100,                 // 宽,int, 必须
           "h": 100                  // 高,int, 必须
           }
          }

          Flash

          {
          "flash" : {
           "url" : "http://swf",     // flash url,string, 必须
           "w": 100,                 // 宽,int, 必须
           "h": 100                  // 高,int, 必须
           }
          }

          视频

          {
          "video" : {
           "url" : "http://vedio",   // 视频 url,string, 必须
           "duration": 15,           // 视频时长,int, 必须,单位:秒
           "w": 100,                 // 宽,int, 必须
           "h": 100,                 // 高,int, 必须
           "bitrate": 100            // 比特率,int, 可选
           }
          }

          Native

          {
          "title": "xxx",           // 标题,string, 可选
          "iconImage": {            // icon图片, 可选
              "url": "http://icon", // icon url, string,必须
              "w": 100,             // 宽,int,必须
              "h": 100              // 高,int, 必须
          },
          "logoImage": {            // logo图片, 可选
              "url": "http://logo", // logo url, string,必须
              "w": 100,             // 宽,int,必须
              "h": 100              // 高,int, 必须
          },
          "mainImage": {            // 广告主图片,可选
            "url": "http://main",   // main url, string,必须
            "w": 100,               // 宽,int,必须
            "h": 100                // 高,int, 必须
          },
          "desc": "best game",      // 描述,string,可选
          "rating": "4",            // app rating,string,可选
          "likes":"4",              // 点赞数,String,可选
          "downloads": "1000",      // app下载量, 可选
          "callToAction": "xx",     // CallToAction按钮显示文字,可选
          "sponsored": "营销云",     // 赞助商,可选
          "price": "100",           // 商品的原始价格
          "salePrice": "80",        // 商品打折后的价格
          "phone": "138xxxxxxxx",     // 联系电话
          "address": "上海市浦东新区",  // 联系地址
          "desc2": "这里再补充下",      // 对desc的补充说明,显示在第二行
          "displayUrl": "www.bcebaidu.com", // 显示在广告中的链接
          "source": "source",   // 应用下载 描述
          "appType": "ios",     // app类型,ios或Android
          "appName": "joke",    // app名字
          "downloadUrl": "downloadUrl", // 下载链接
          "isInapp": 1,   // 点击后行为,是否在webview打开,1代表是
          "itunesId": "44",             // itunes ID
          "openUrl": "openUrl",         // 打开应用URL
          "ipaUrl": "someUrl",          // iOS越狱链接
          "packageName": "com.baidu"    // 安卓APP包名
          }

          GetUser接口

          请求

          方法 URI 说明
          GET /adlib/v1/cluster/{clusterId}/user/{userId} 获取指定集群的广告主信息

          请求参数

          响应

          返回值为一个User对象

          示例

          请求示例

          GET /adlib/v1/cluster/0/user/1 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          响应示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          {
           "userId": 1,
           "userName": "test1",
           "trade": "IAB24",
           "profitRate": 1234,
           "balance": 1000,
           "qualificationName": "xxxx",
           "siteName": "baidu",
           "siteUrl": "https://www.bid.com/",
           "contact": "xxx",
           "phone": "110",
           "license": "http://dsp.xxx.cn/upload/f689e32e-8c8b-4940.JPG",
           "icp": "http://dsp.xxx.cn/upload/f689e32e-8c8b-4940.JPG",
           "orgCodeCert": "http://dsp.xxx.cn/upload/f689e32e-8c8b-4940.JPG",
           "additionalCerts": "http://dsp.xxx.cn/upload/f689e32e-8c8b.JPG",
           "status": "ENABLED"
          }

          AddUser接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/user 新增广告主信息

          请求参数

          参数名称 参数类型 是否必须 说明
          userId long 可选 用户id,若指明则按照指定id创建用户,否则数据库自动生成一个id来创建用户
          userName string 必选 广告主名称
          trade string 可选 行业分类
          profitRate long 可选 利润率
          qualificationName string 可选 资质名 (用于广告主审核)
          siteName string 可选 广告主站点名 (用于审核)
          siteUrl string 可选 广告主站点url (用于审核)
          contact string 可选 联系人
          phone string 可选 手机号
          license string 可选 营业执照
          icp string 可选 ICP证书
          orgCodeCert string 可选 组织机构代码
          additionalCerts string 可选 其他资质

          响应

          返回新创建的User对象ID。

          示例

          请求示例

          POST /adlib/v1/cluster/0/user HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "userName" : "张三",
           "qualificationName": "智能营销有限公司",
           "siteName": "数字营销解决方案",
           "siteUrl": "https://cloud.baidu.com/product/adn.html"
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
           "userId": 81
           ...
          }

          UpdateUser接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/user/{userId} 修改广告主信息

          请求参数

          参数名称 参数类型 是否必须 说明
          userName string 可选 广告主名称
          trade string 可选 行业分类
          profitRate long 可选 利润率
          qualificationName string 可选 资质名 (用于广告主审核)
          siteName string 可选 广告主站点名 (用于审核)
          siteUrl string 可选 广告主站点url (用于审核)
          contact string 可选 联系人
          phone string 可选 手机号
          license string 可选 营业执照
          icp string 可选 ICP证书
          orgCodeCert string 可选 组织机构代码
          additionalCerts string 可选 其他资质

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/user/80 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "userName" : "李四"
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          EnableUser接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/user/{userId}?enable 启用该广告主

          响应

          示例

          请求示例

          PUT /v1/cluster/0/user/80?enable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DisableUser接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/user/{userId}?disable 停用该广告主

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/user/80?disable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DeleteUser接口

          请求

          方法 URI 说明
          DELETE /adlib/v1/cluster/{clusterId}/user/{userId} 删除广告主信息

          响应

          示例

          请求示例

          DELETE /adlib/v1/cluster/0/user/80 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          ListUser接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/user/list 查找广告主信息,所有查询条件求交集

          请求参数

          参数名称 参数类型 是否必须 说明
          minUserId long 可选 最小ID
          userName string 可选 广告主名称,模糊匹配
          qualificationName string 可选 资质名,模糊匹配
          siteName string 可选 广告主站点名,模糊匹配
          siteUrl string 可选 广告主站点url ,模糊匹配
          statuses int[] 可选 状态集合,默认查询所有状态(只能取值0或1)
          minBalance long 可选 最小余额
          maxBalance long 可选 最大余额
          userIds long[] 可选 广告主id集合,默认查询所有广告主
          orderBy string 可选 排序字段。
          可用字段:userId
          默认字段:userId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20

          响应

          符合查询条件的User对象列表,pageNo,pageSize,totalCount。

          示例

          请求示例

          POST /adlib/v1/cluster/0/user/list HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "userName":"张三",
           "orderBy": "userId",
           "order": "asc",
           "statuses":[0, 1],
           "minBalance": 1000
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              totalCount: 2,
              pageNo: 1,
              pageSize: 20,
              "orderBy": "user_id",
              "order": "desc",
              result: [
               {
                 "userId": 2,
                 "userName": "test1",
                 "trade":"trade",
                 "profitRate":1000,
                 "balance": 1001,
                 "qualificationName": "xxxx",
                 "siteName": "baidu",
                 "siteUrl": "https://www.baidu.com/",
                 "contact": "xxx",
                 "phone": "110",
                 "license": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "icp": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "orgCodeCert": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "additionalCerts": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "status": "ENABLED"
               },
               {
                 "userId": 1,
                 "userName": "test1",
                 "balance": 1000,
                 "qualificationName": "xxxx",
                 "siteName": "baidu",
                 "siteUrl": "https://www.baidu.com/",
                 "contact": "xxx",
                 "phone": "119",
                 "license": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "icp": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "status": "DISABLED"
               }
              ]
          }

          GetAllUser接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/user/all 查找广告主信息,所有查询条件求交集。
          可以查询DELETED状态的广告主

          请求参数

          参数名称 参数类型 是否必须 说明
          minUserId long 可选 最小ID
          userName string 可选 广告主名称,模糊匹配
          qualificationName string 可选 资质名,模糊匹配
          siteName string 可选 广告主站点名,模糊匹配
          siteUrl string 可选 广告主站点url ,模糊匹配
          statuses int[] 可选 状态集合,默认查询所有状态(取值可为0,1或2)
          minBalance long 可选 最小余额
          maxBalance long 可选 最大余额
          userIds long[] 可选 广告主id集合,默认查询所有广告主
          orderBy string 可选 排序字段。
          可用字段:userId
          默认字段:userId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20

          响应

          符合查询条件的User对象列表,pageNo,pageSize,totalCount。

          示例

          请求示例

          POST /adlib/v1/cluster/0/user/all HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "userName":"张三",
           "orderBy": "userId",
           "order": "desc",
           "statuses":[0, 1, 2],
           "minBalance": 1000
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              totalCount: 3,
              pageNo: 1,
              pageSize: 20,
              "orderBy": "user_id",
              "order": "desc",
              result: [
               {
                 "userId": 10,
                 "userName": "test10",
                 "trade": "IAB24",
                 "profitRate": 1234,
                 "balance": 1001,
                 "qualificationName": "xxxx",
                 "siteName": "baidu",
                 "siteUrl": "https://www.baidu.com/",
                 "contact": "xxx",
                 "phone": "110",
                 "license": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "icp": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "orgCodeCert": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "additionalCerts": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "status": "ENABLED"
               },
               {
                 "userId": 9,
                 "userName": "test9",
                 "balance": 1000,
                 "qualificationName": "xxxx",
                 "siteName": "baidu",
                 "siteUrl": "https://www.baidu.com/",
                 "contact": "xxx",
                 "phone": "119",
                 "license": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "icp": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "status": "DISABLED"
               },
               {
                 "userId": 8,
                 "userName": "test8",
                 "trade": "IAB24",
                 "profitRate": 1234,
                 "balance": 999,
                 "qualificationName": "xxxx",
                 "siteName": "baidu",
                 "siteUrl": "https://www.baidu.com/",
                 "contact": "xxx",
                 "phone": "120",
                 "license": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "icp": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.JPG",
                 "status": "DELETED"
               }
              ]
          }

          GetPlan接口

          请求

          方法 URI 说明
          GET /adlib/v1/cluster/{clusterId}/plan/{planId} 获取指定计划信息

          响应

          返回值为一个Plan对象

          示例

          请求示例

          GET /adlib/v1/cluster/0/plan/80 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "planId": 80,
              "userId": 1,
              "planName": "投放计划",
              "budget": 10000,
              "planCycle": [
                  "110000000000000000000000",
                  "000000000000000000000000",
                  "000000000000000000000000",
                  "000000000000000000000000",
                  "000000000000000000000000",
                  "000000000000000000000000",
                  "000000000000000000000000"
              ],
              "startTime": "2017-02-28T00:00:00",
              "endTime": "2017-03-22T00:00:00",
              "status": "ENABLED"
          }

          AddPlan接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/plan 新增广告投放计划

          请求参数

          参数名称 参数类型 是否必须 说明
          userId long 必选 广告主ID
          planName string 必选 计划名称(同一个广告主下需唯一)
          budget int 必选 每日预算 (单位:分)
          planCycle string[] 可选 一天24小时用24个字符表示,如果某小时投放则为1,反之为0。
          比如:110000000000000000000000,代表在当日00:00:00~01:59:59点投放。
          一周7(天) ,用7个长度为24字符串表示,顺序是周一到周日。默认7*24小时都投放。
          startTime timestamp 必选 计划开启时间
          endTime timestamp 必选 计划停止时间

          响应

          返回新创建的Plan对象ID。

          示例

          请求示例

          POST /adlib/v1/cluster/0/plan HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "userId" : "1",
           "planName": "投放计划Test",
           "budget": 10000,
           "planCycle": [
                 "110000000000000000000000",
                 "000000000000000000000000",
                 "000000000000000000000000",
                 "000000000000000000000000",
                 "000000000000000000000000",
                 "000000000000000000000000",
                 "000000000000000000000000"
             ],
           "startTime": "2017-02-28 00:00:00",
           "endTime": "2017-03-22 00:00:00"
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
           "planId": 1
          }

          UpdatePlan接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/plan/{planId} 修改广告投放计划

          请求参数

          参数名称 参数类型 是否必须 说明
          userId long 必选 广告主ID
          planName string 可选 计划名称(同一个广告主下需唯一)
          budget int 可选 每日预算 (单位:分)
          planCycle string[] 可选 一天24小时用24个字符表示,如果某小时投放则为1,反之为0。
          比如:110000000000000000000000,代表在当日00:00:00~01:59:59点投放。
          一周7(天) ,用7个长度为24字符串表示,顺序是周一到周日。默认7*24小时都投放。
          startTime timestamp 可选 计划开启时间
          endTime timestamp 可选 计划停止时间

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/plan/80 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "userId" : 1,
           "planName" : "新投放计划"
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          EnablePlan接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/plan/{planId}?enable 启用计划

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/plan/80?enable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DisablePlan接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/plan/{planId}?disable 停用计划

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/plan/80?disable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DeletePlan接口

          请求

          方法 URI 说明
          DELETE /adlib/v1/cluster/{clusterId}/plan/{planId} 删除广告投放计划

          响应

          示例

          请求示例

          DELETE /adlib/v1/cluster/0/plan/1 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          ListPlan接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/plan/list 查找投放计划,所有查询条件求交集

          请求参数

          参数名称 参数类型 是否必须 说明
          userIds long[] 可选 所属广告主id,默认查询所有广告主
          planIds long[] 可选 广告计划id集合,默认查询所有广告计划
          minPlanId long 可选 最小广告计划id
          planName string 可选 计划名称,模糊匹配
          minBudget int 可选 最小每日预算
          maxBudge int 可选 最大每日预算
          minStartTime timestamp 可选 最小的开始时间
          maxStartTime timestamp 可选 最大的开始时间
          minEndTime timestamp 可选 最小的结束时间
          maxEndTime timestamp 可选 最大的结束时间
          planStatuses int[] 可选 状态集合,默认查询所有状态(只能取值0或1)
          orderBy string 可选 排序字段。
          可用字段:planId, userId
          默认字段:planId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20

          响应

          符合查询条件的Plan对象列表,pageNo,pageSize,totalNum。

          示例

          请求示例

          POST /adlib/v1/cluster/0/plan/list HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
          	"userId":[1],
          	"orderBy": "planId",
          	"order": "asc",
          	"planStatuses":[0,1]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "totalNum": 100,
              "pageNo": 1,
              "pageSize": 20,
              "orderBy": "plan_id",
              "order": "desc",
              "data": [
                  {
                      "planId": 2,
                      "userId": 1,
                      "planName": "投放计划1",
                      "budget": 10000,
                      "planCycle": [
                          "110000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000"
                      ],
                      "startTime": "2017-02-28T00:00:00",
                      "endTime": "2017-03-22T00:00:00",
                      "status": "ENABLED"
                  },
                  {
                      "planId": 3,
                      "userId": 1,
                      "planName": "投放计划2",
                      "budget": 20000,
                      "planCycle": [
                          "110000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000"
                      ],
                      "startTime": "2017-01-28T00:00:00",
                      "endTime": "2017-02-22T00:00:00",
                      "status": "DISABLED"
                  }
              ]
          }

          GetAllPlan接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/plan/all 查找投放计划,所有查询条件求交集。
          可查询DELETED状态的广告计划

          请求参数

          参数名称 参数类型 是否必须 说明
          userIds long[] 可选 所属广告主id,默认查询所有广告主
          planIds long[] 可选 广告计划id集合,默认查询所有广告计划
          minPlanId long 可选 最小广告计划id
          planName string 可选 计划名称,模糊匹配
          minBudget int 可选 最小每日预算
          maxBudge int 可选 最大每日预算
          minStartTime timestamp 可选 最小的开始时间
          maxStartTime timestamp 可选 最大的开始时间
          minEndTime timestamp 可选 最小的结束时间
          maxEndTime timestamp 可选 最大的结束时间
          planStatuses int[] 可选 状态集合,默认查询所有状态(取值为0、1或2)
          orderBy string 可选 排序字段。
          可用字段:planId, userId
          默认字段:planId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20

          响应

          符合查询条件的Plan对象列表,pageNo,pageSize,totalNum。

          示例

          请求示例

          POST /adlib/v1/cluster/0/plan/all HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
          	"userId":[1],
          	"orderBy": "planId",
          	"order": "asc",
          	"planStatuses":[0,1,2]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "totalNum": 100,
              "pageNo": 1,
              "pageSize": 20,
              "orderBy": "plan_id",
              "order": "desc",
              "data": [
                  {
                      "planId": 2,
                      "userId": 1,
                      "planName": "投放计划1",
                      "budget": 10000,
                      "planCycle": [
                          "110000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000"
                      ],
                      "startTime": "2017-02-28T00:00:00",
                      "endTime": "2017-03-22T00:00:00",
                      "status": "ENABLED"
                  },
                  {
                      "planId": 3,
                      "userId": 1,
                      "planName": "投放计划2",
                      "budget": 20000,
                      "planCycle": [
                          "110000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000"
                      ],
                      "startTime": "2017-01-28T00:00:00",
                      "endTime": "2017-02-22T00:00:00",
                      "status": "DISABLED"
                  },
                  {
                      "planId": 4,
                      "userId": 1,
                      "planName": "投放计划3",
                      "budget": 20000,
                      "planCycle": [
                          "110000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000",
                          "000000000000000000000000"
                      ],
                      "startTime": "2017-01-28T00:00:00",
                      "endTime": "2017-02-22T00:00:00",
                      "status": "DELETED"
                  }
              ]
          }

          GetUnit接口

          请求

          方法 URI 说明
          GET /adlib/v1/cluster/{clusterId}/unit/{unitId} 获取指定单元信息

          响应

          返回值为一个Unit对象

          示例

          请求示例

          GET /adlib/v1/cluster/0/unit/1 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
           "unitId": 1,
           "planId": 1,
           "userId" : 1,
           "unitName":"广告单元",
           "bid":100,
           "bidType": "CPM",
           "adviewType": "WEB",
           "status": "ENABLED"
          }

          AddUnit接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/unit 新增广告单元

          请求参数

          参数名称 参数类型 是否必须 说明
          planId long 必选 所属计划id
          userId long 必选 广告主ID
          unitName string 必选 单元名称(同一计划下需唯一)
          bid long 必选 出价 (单位:分)
          bidType int/BidType 必选 出价类型 (0 - UNKNOWN(-1),1 - CPM(0),2 - CPC(1),3 - CPD(2), 4 - CPT(3))
          adviewType int/AdviewType 必选 投放的流量类型(0 – UNKNOWN(-1), 1 – WEB(0), 2 - WAP(1), 3 - APP(2))

          响应

          返回新创建的Unit对象ID。

          示例

          请求示例

          POST /adlib/v1/cluster/0/unit HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "planId":1
           "userId" : "1",
           "unitName": "投放单元",
           "bid": 100,
           "bidType": 1,
           "adviewType": 1
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
           "unitId": 1,
          }

          UpdateUnit接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/unit/{unitId} 修改广告单元

          请求参数

          参数名称 参数类型 是否必须 说明
          planId long 必选 所属计划id
          userId long 必选 广告主ID
          unitName string 可选 单元名称(同一计划下需唯一)
          bid int 可选 出价 (单位:分)
          bidType int/BidType 可选 出价类型 (0 - UNKNOWN(-1),1 - CPM(0),2 - CPC(1),3 - CPD(2), 4 - CPT(3))
          adviewType int/AdviewType 可选 投放的流量类型(0 – UNKNOWN(-1), 1 – WEB(0), 2 - WAP(1), 3 - APP(2))

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/unit/80 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "planId":1
           "userId" : "1",
           "unitName" : "新广告单元"
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          EnableUnit接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/unit/{unitId}?enable 启用广告投放单元

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/unit/1?enable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DisableUnit接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/unit/{unitId}?disable 暂停广告投放单元

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/unit/1?disable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DeleteUnit接口

          请求

          方法 URI 说明
          DELETE /adlib/v1/cluster/{clusterId}/unit/{unitId} 删除广告投放单元

          响应

          示例

          请求示例

          DELETE /adlib/v1/cluster/0/unit/1 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          ListUnit接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/unit/list 查看广告单元,所有查询条件求交集

          请求参数

          参数名称 参数类型 是否必须 说明
          planIds long[] 可选 所属计划id,默认查询所有计划
          userIds long[] 可选 所属广告主id,默认查询所有广告主
          unitIds long[] 可选 广告单元id,默认查询所有广告单元
          minUnitId long 可选 广告单元id,查询所有大于此id的广告单元
          unitName string 可选 单元名称,模糊匹配
          minBid long 可选 最小出价
          maxBid long 可选 最大出价
          bidTypes int[] 可选 出价类型, 默认查询所有出价类型
          adviewTypes int[] 可选 流量类型,默认查询所有流量类型
          unitStatuses int[] 可选 状态集合,默认查询所有状态(取值只能为0或1)。
          orderBy string 可选 排序字段。
          可用字段:unitId, planId, userId
          默认字段:unitId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20

          响应

          符合查询条件的Unit对象列表,pageNo,pageSize,totalNum。

          示例

          请求示例

          POST /adlib/v1/cluster/0/unit/list HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "planId":[1],
           "userIds":[1],
           "unitStatuses":[0, 1],
           "bidTypes":[0,1,2]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "totalNum": 2,
              "pageNo": 1,
              "pageSize": 20,
              "orderBy": "unit_id",
              "order": "desc",
              "data": [
                  {
                      "unitId": 2",
                      "planId": 1,
                      "userId": 1,
                      "unitName": "广告单元1",
                      "bid": 100,
                      "bidType": "CPM",
                      "adviewType": "WAP",
                      "status": "ENABLED"
                  },
                  {
                      "unitId": 1,
                      "planId": 1,
                      "userId": 1,
                      "unitName": "广告单元2",
                      "bid": 100,
                      "bidType": "CPC",
                      "adviewType": "WEB",
                      "status": "DISABLED"
                  }
              ]
          }

          GetAllUnit接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/unit/all 查看广告单元,所有查询条件求交集。
          可以查询DELETED状态的广告单元

          请求参数

          参数名称 参数类型 是否必须 说明
          planIds long[] 可选 所属计划id,默认查询所有计划
          userIds long[] 可选 所属广告主id,默认查询所有广告主
          unitIds long[] 可选 广告单元id,默认查询所有广告单元
          minUnitId long 可选 广告单元id,查询所有大于此id的广告单元
          unitName string 可选 单元名称,模糊匹配
          minBid long 可选 最小出价
          maxBid long 可选 最大出价
          bidTypes int[] 可选 出价类型, 默认查询所有出价类型
          adviewTypes int[] 可选 流量类型,默认查询所有流量类型
          unitStatuses int[] 可选 状态集合,默认查询所有状态(取值为0、1或2)。
          orderBy string 可选 排序字段。
          可用字段:unitId, planId, userId
          默认字段:unitId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20

          响应

          符合查询条件的Unit对象列表,pageNo,pageSize,totalNum。

          示例

          请求示例

          POST /adlib/v1/cluster/0/unit/all HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "planId":[1],
           "userIds":[1],
           "unitStatuses":[0,1,2],
           "bidTypes":[0,1,2]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "totalNum": 2,
              "pageNo": 1,
              "pageSize": 20,
              "orderBy": "unit_id",
              "order": "desc",
              "data": [
                  {
                      "unitId": 10",
                      "planId": 1,
                      "userId": 1,
                      "unitName": "广告单元10",
                      "bid": 100,
                      "bidType": "CPM",
                      "adviewType": "WAP",
                      "status": "ENABLED"
                  },
                  {
                      "unitId": 9,
                      "planId": 1,
                      "userId": 1,
                      "unitName": "广告单元9",
                      "bid": 100,
                      "bidType": "CPC",
                      "adviewType": "WEB",
                      "status": "DISABLED"
                  },
                  {
                      "unitId": 8,
                      "planId": 1,
                      "userId": 1,
                      "unitName": "广告单元8",
                      "bid": 100,
                      "bidType": "CPC",
                      "adviewType": "WEB",
                      "status": "DELETED"
                  }
              ]
          }

          GetUnitTargeting接口

          请求

          方法 URI 说明
          GET /adlib/v1/cluster/{clusterId}/unit/{unitId}/config 获取指定单元下所有定向

          响应

          返回值为 List<UnitTargeting>

          示例

          请求示例

          GET /adlib/v1/cluster/0/unit/3/config HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "unitId": 3,
              "planId":3,
              "userId": 3,
              "targetings": [
                  {
                    "id": 91,
          	      "unitId": 3,
          	      "planId": 3,
          	      "userId": 3,
          	      "type": "VALID_ADXS",
          	      "content": "",
          	      "status": "DISABLED"
                  },
          
                  ......
          
                  {
                    "id": 93,
          	      "unitId": 3,
          	      "planId": 3,
          	      "userId": 3,
          	      "type": "RESTRICT_REGION",
          	      "content": "",
          	      "status": "DISABLED"
                  },
                  {
                     "id": 94,
          	      "unitId": 3,
          	      "planId": 3,
          	      "userId": 3,
          	      "type": "VALID_KEYWORD",
          	      "content": "qwerty",
          	      "status": "ENABLED"
                  },
                  {
          	      "id": 96,
          	      "unitId": 3,
          	      "planId": 3,
          	      "userId": 3,
          	      "type": "VALID_COOKIE",
          	      "content": "123456",
          	      "status": "ENABLED"
                  },
          
                  ......
          
                  {
          	      "id": 112,
          	      "unitId": 3,
          	      "planId": 3,
          	      "userId": 3,
          	      "type": "EXP",
          	      "content": "",
          	      "status": "DISABLED"
                  }
              ]
          }

          UpdateUnitTargeting接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/unit/{unitId}/config 更新指定单元下的定向

          请求参数

          参数名称 参数类型 是否必须 说明
          targeting Container 可选 targeting的容器
          - type int/UnitConfigType 可选 定向类型
          - content string 可选 定向内容

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/unit/80/config HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          [
                  {
                      "type": 1,
                      "content": "1,2"
                  },
                  {
                      "type": "VALID_SITE",
                      "content": ""
                  }
          ]

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          ListTargeting接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/unit/config/list 查询满足条件的所有定向

          请求参数

          参数名称 参数类型 是否必须 说明
          minId long 可选 定向id,查询大于此id的所有定向
          lastTime LocalDateTime 可选 最早更新时间,查询大于等于此更新时间的所有定向
          unitIds int[] 可选 广告单元id集合,查询此集合内的所有定向。默认查询所有定向
          unitConfigTypes int/UnitConfigType [] 可选 定向类型集合,查询此集合内的所有定向。默认查询所有定向
          unitConfigStatuses int/UnitConfigStatus [] 可选 广告单元状态集合,查询此集合内的所有定向。默认查询所有定向(取值只能为1或1)
          startIndex long 可选 定向内容捞取下标(遵循数据库要求,最小下标为1)。默认为null,捞取所有定向内容。
          length long 可选 定向内容捞取字符数量(遵循数据库要求,最小值为1)。默认为null,捞取所有定向内容。

          响应

          返回值为UnitTargeting对象列表

          示例

          请求示例

          POST /adlib/v1/cluster/0/unit/config/list HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
          	"minId": 300,
          	"unitIds":[41],
          	"unitConfigStatuses":[0,1]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
            "totalCount": 22,
            "pageNo": 1,
            "pageSize": 20,
            "orderBy": "unit_id",
            "order": "desc",
            "result": [
              {
                "id": 301,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "VALID_ADXS",
                "content": "",
                "status": "DISABLED"
              },
          
             ......
          
              {
                "id": 303,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "RESTRICT_REGION",
                "content": "",
                "status": "DISABLED"
              },
              {
                "id": 304,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "VALID_KEYWORD",
                "content": "",
                "status": "DISABLED"
              },
              {
                "id": 305,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "CYCLE",
                "content": "",
                "status": "DISABLED"
              },
          
          .......
          
              {
                "id": 320,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "VALID_IP",
                "content": "",
                "status": "ENABLED"
              }
            ]
          }

          GetAllTargeting接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/unit/config/all 查询满足条件的所有定向。
          可查询DELETED状态的定向

          请求参数

          参数名称 参数类型 是否必须 说明
          minId long 可选 定向id,查询大于此id的所有定向
          lastTime LocalDateTime 可选 最早更新时间,查询大于等于此更新时间的所有定向
          unitIds int[] 可选 广告单元id集合,查询此集合内的所有定向。默认查询所有定向
          unitConfigTypes int/UnitConfigType [] 可选 定向类型集合,查询此集合内的所有定向。默认查询所有定向
          unitConfigStatuses int/UnitConfigStatus [] 可选 广告单元状态集合,查询此集合内的所有定向。默认查询所有定向(取值可为0,1或2)
          startIndex long 可选 定向内容捞取下标(遵循数据库要求,最小下标为1)。默认为null,捞取所有定向内容。
          length long 可选 定向内容捞取字符数量(遵循数据库要求,最小值为1)。默认为null,捞取所有定向内容。

          响应

          返回值为UnitTargeting对象列表

          示例

          请求示例

          POST /adlib/v1/cluster/0/unit/config/list HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
          	"minId": 300,
          	"unitIds":[41],
          	"unitConfigStatuses":[0,1,2]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
            "totalCount": 22,
            "pageNo": 1,
            "pageSize": 20,
            "orderBy": "unit_id",
            "order": "desc",
            "result": [
              {
                "id": 301,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "VALID_ADXS",
                "content": "",
                "status": "DISABLED"
              },
          
             ......
          
              {
                "id": 303,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "RESTRICT_REGION",
                "content": "",
                "status": "DELETED"
              },
              {
                "id": 304,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "VALID_KEYWORD",
                "content": "",
                "status": "DISABLED"
              },
              {
                "id": 305,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "CYCLE",
                "content": "",
                "status": "DISABLED"
              },
          
          .......
          
              {
                "id": 320,
                "unitId": 41,
                "planId": 29,
                "userId": 1005,
                "type": "VALID_IP",
                "content": "",
                "status": "ENABLED"
              }
            ]
          }

          注:在创建和删除单元时,会默认对应创建和删除其关联定向,故定向层面没有Add和Delete操作。

          GetIdea接口

          请求

          方法 URI 说明
          GET /adlib/v1/cluster/{clusterId}/idea/{ideaId} 获取指定广告创意信息

          响应

          返回值为一个Idea对象

          示例

          请求示例

          GET /adlib/v1/cluster/0/idea/20143 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "ideaId": 20143,
              "ideaName": "960*90",
              "unitId": 15,
              "planId": 11,
              "userId": 24,
              "ideaStatus": "ENABLED",
              "adviewType": "WEB",
              "ideaType": "IMAGE",
              "landingPage": "https://cloud.baidu.com/product/adn.html",
              "ideaSlots": [
          	    "BANNER",
          	    "OPEN_SCREEN",
          	    "INNER_SCREEN",
          	    "VIDEO",
          	    "MESSAGE_FLOW"
          	    ],
              "ideaTrade": "IAB9-25",
              "assets": "{
                  "mainImage": {
                      "url": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.jpg",
                      "w": 960,
                      "h": 90
                  }
              }",
              "impMonitorUrls": [],
              "clickMonitorUrls": [],
          	"signature": "7781f21d6bb6b56085ee69af4b3def51",
          	"auditStatus": "IN_PROGRESS",
          	"failureMessage": ""
          }

          AddIdea接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/idea 新增广告单元

          请求参数

          参数名称 参数类型 是否必须 说明
          unitId long 必选 广告单元id
          planId long 必选 所属计划id
          userId long 必选 广告主ID
          ideaName string 必选 创意名称
          ideaSlots int/IdeaSlot [] 可选 可投放的广告位类型,取值范围:
          0-BANNER(1):横幅 - 固定型横幅
          1-OPEN_SCREEN(2):开屏
          2-INNER_SCREEN(3):插屏
          3-VIDEO(4):视频
          4-MESSAGE_FLOW(5):信息流,默认为空
          ideaType int/IdeaType 必选 创意类型
          0-UNKNOWN(-1): 未知类型
          1-IMAGE(1): 图片
          2-FLASH(2): flash
          3-VIDEO(3): 视频
          4-NATIVE(4): Native
          landingPage string 必选 点击登陆页面 (或下载链接)
          assets object 必选 物料格式,不同创意类型,物料格式不同。新建时,无需填w和h字段,系统会根据url中的物料动态解析出w和h。
          ideaTrade string 可选 创意所属行业 (用于创意审核)
          adviewType int/AdviewType 可选 投放的流量类型
          0-UNKNOWN(-1): 未知类型
          1 – WEB(0)
          2 – WAP(1)
          3 – APP(2),与单元的流量类型一致,只读字段。
          impMonitorUrls string[] 可选 展现监控链接,可填充多个
          clickMonitorUrls string[] 可选 点击监控链接,可填充多个
          auditStatus int/AuditStatus 可选 审核状态
          0-PASSED(0)
          1-IN_PROGRESS(1)
          2-FAILED(2)
          3-DELETED(-1)
          failureMessage string 可选 人工审核的错误信息

          响应

          返回新创建的Idea对象ID。

          示例

          请求示例

          POST /adlib/v1/cluster/0/idea HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
              "ideaName": "960*90",
              "unitId": 15,
              "planId": 11,
              "userId": 24,
              "adviewType": "WAP",
              "ideaType": "1",
              "landingPage": "https://cloud.baidu.com/product/adn.html",
              "ideaSlots": [1,2,3,4,5],
              "ideaTrade": "IAB9-25",
              "assets": {
                  "mainImage": {
                      "url": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.jpg"
                  }
              },
              "impMonitorUrls":["1","2"],
          	"clickMonitorUrls":[],
          	"auditStatus":2,
          	"failureMessage":"no failure message"
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
             "ideaId": 20143
          }

          UpdateIdea接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/idea/{ideaId} 修改广告创意

          请求参数

          参数名称 参数类型 是否必须 说明
          unitId long 必选 广告单元id
          planId long 必选 所属计划id
          userId long 必选 广告主ID
          ideaName string 可选 创意名称
          ideaSlots int/IdeaSlot [] 可选 可投放的广告位类型,取值范围:
          0-BANNER(1):横幅 - 固定型横幅
          1-OPEN_SCREEN(2):开屏
          2-INNER_SCREEN(3):插屏
          3-VIDEO(4):视频
          4-MESSAGE_FLOW(5):信息流,默认为空
          ideaType int/IdeaType 可选 创意类型
          0-UNKNOWN(-1): 未知类型
          1-IMAGE(1): 图片
          2-FLASH(2): flash
          3-VIDEO(3): 视频
          4-NATIVE(4): Native
          landingPage string 可选 点击登陆页面 (或下载链接)
          assets object 可选 物料格式,不同创意类型,物料格式不同。新建时,无需填w和h字段,系统会根据url中的物料动态解析出w和h。
          ideaTrade string 可选 创意所属行业 (用于创意审核)
          adviewType int/AdviewType 可选 投放的流量类型
          0-UNKNOWN(-1): 未知类型
          1 – WEB(0)
          2 – WAP(1)
          3 – APP(2),与单元的流量类型一致,只读字段。
          impMonitorUrls string[] 可选 展现监控链接,可填充多个
          clickMonitorUrls string[] 可选 点击监控链接,可填充多个
          auditStatus int/AuditStatus 可选 审核状态
          0-PASSED(0)
          1-IN_PROGRESS(1)
          2-FAILED(2)
          3-DELETED(-1)
          failureMessage string 可选 人工审核的错误信息

          响应

          空。

          示例

          请求示例

          PUT /adlib/v1/cluster/0/idea/80 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "unitId": 15,
           "planId": 11,
           "userId": 24,
           "ideaName" : "新广告创意"
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          EnableIdea接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/idea/{ideaId}?enable 启用创意

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/idea/1?enable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DisableIdea接口

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/idea/{ideaId}?disable 暂停创意

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/idea/1?disable HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          DeleteIdea接口

          请求

          方法 URI 说明
          DELETE /adlib/v1/cluster/{clusterId}/idea/{ideaId} 删除广告创意

          响应

          示例

          请求示例

          DELETE /adlib/v1/cluster/0/idea/1 HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8

          ListIdea接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/idea/list 查看广告创意,所有查询条件求交集

          请求参数

          参数名称 参数类型 是否必须 说明
          ideaIds long[] 可选 广告创意id,默认查询所有创意
          unitIds long[] 可选 所属单元id,默认查询所有单元
          planIds long[] 可选 所属计划id,默认查询所有计划
          userIds long[] 可选 所属广告主id,默认查询所有广告主
          minIdeaId long 可选 广告创意id,查询大于此id的广告创意
          ideaName string 可选 创意名称,模糊匹配
          ideaType int/IdeaType [] 可选 创意类型
          0-UNKNOWN(-1): 未知类型
          1-IMAGE(1): 图片
          2-FLASH(2): flash
          3-VIDEO(3): 视频
          4-NATIVE(4): Native
          默认查询所有创意类型
          adviewType int/AdviewType [] 可选 流量类型
          0-UNKNOWN(-1): 未知类型
          1-WEB(0): Web
          2-WAP(1): WAP
          3-APP(2): App
          默认查询所有创意类型
          landingPage string 可选 落地页,模糊匹配
          ideaStatuses int/IdeaStatus [] 可选 状态集合,默认查询所有状态(取值只能为0或1)
          auditStatuses int/AuditStatus [] 可选 审核状态集合,默认查询所有审核状态
          orderBy string[] 可选 排序字段。
          可用字段:idealId, unitId, planId, userId
          默认字段:idealId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20,最大100

          响应

          符合查询条件的Idea对象列表,pageNo,pageSize,totalNum。

          示例

          请求示例

          POST /adlib/v1/cluster/0/idea/list HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "unitIds": [15],
           "orderBy": "unitId",
           "order": "asc",
           "ideaStatuses ":[0,1]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "totalNum": 100,
              "pageNo": 1,
              "pageSize": 20,
              "orderBy": "unit_id",
              "order": "asc",
              "data": [
                  {
                      "ideaId": 20143,
                      "ideaName": "960*90",
                      "unitId": 15,
                      "planId": 11,
                      "userId": 24,
                      "ideaStatus": "ENABLED",
                      "adviewType": "WEB",
                      "ideaType": "IMAGE",
                      "landingPage": "https://cloud.baidu.com/product/adn.html",
                      "ideaSlots": ["BANNER", "VIDEO"],
                      "ideaTrade": "IAB9-25",
                      "assets": {
                          "mainImage": {
                              "url": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.jpg",
                              "w": 960,
                              "h": 90
                          }
                      },
                      "impMonitorUrls": [],
                      "clickMonitorUrls": [],
                      "signature":"7781f21d6bb6b56085ee69af4b3def51",
                      "auditStatus": "IN_PROGRESS",
          	        "failureMessage": ""
                  },
                  {
                      "ideaId": 20144,
                      "ideaName": "336*280",
                      "unitId": 15,
                      "planId": 11,
                      "userId": 24,
                      "ideaStatus": "DISABLED",
                      "adviewType": "WAP",
                      "ideaType": "IMAGE",
                      "landingPage": "https://cloud.baidu.com/product/adn.html",
                      "ideaSlots": ["BANNER"],
                      "ideaTrade": "IAB9-26",
                      "assets": {
                          "mainImage": {
                              "url": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.jpg",
                              "w": 960,
                              "h": 90
                          }
                      },
                      "impMonitorUrls": [],
                      "clickMonitorUrls": [],
                      "signature":"7781f21d6bb6b56085ee69af4b3def51",
                      "auditStatus": "PASSED",
          	        "failureMessage": ""
                  }
              ]
          }

          GetAllIdea接口

          请求

          方法 URI 说明
          POST /adlib/v1/cluster/{clusterId}/idea/all 查看广告创意,所有查询条件求交集。
          可查询DELETED状态的广告创意

          请求参数

          参数名称 参数类型 是否必须 说明
          ideaIds long[] 可选 广告创意id,默认查询所有创意
          unitIds long[] 可选 所属单元id,默认查询所有单元
          planIds long[] 可选 所属计划id,默认查询所有计划
          userIds long[] 可选 所属广告主id,默认查询所有广告主
          minIdeaId long 可选 广告创意id,查询大于此id的广告创意
          ideaName string 可选 创意名称,模糊匹配
          ideaType int/IdeaType [] 可选 创意类型
          0-UNKNOWN(-1): 未知类型
          1-IMAGE(1): 图片
          2-FLASH(2): flash
          3-VIDEO(3): 视频
          4-NATIVE(4): Native
          默认查询所有创意类型
          landingPage string 可选 落地页,模糊匹配
          ideaStatuses int/IdeaStatus [] 可选 状态集合,默认查询所有状态(取值为:0,1或2)
          auditStatuses int/AuditStatus [] 可选 审核状态集合,默认查询所有审核状态
          orderBy string[] 可选 排序字段。
          可用字段:idealId, unitId, planId, userId
          默认字段:idealId
          order string 可选 排序方式:desc(默认)、asc
          pageNo int 可选 页面编号,默认为1
          pageSize int 可选 页面展示元素个数,默认20,最大100

          响应

          符合查询条件的Idea对象列表,pageNo,pageSize,totalNum。

          示例

          请求示例

          POST /adlib/v1/cluster/0/idea/list HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8
          
          {
           "unitIds": [15],
           "orderBy": "unitId",
           "order": "asc",
           "ideaStatuses ":[0,1,2]
          }

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          
          {
              "totalNum": 100,
              "pageNo": 1,
              "pageSize": 20,
              "orderBy": "unit_id",
              "order": "asc",
              "data": [
                  {
                      "ideaId": 20143,
                      "ideaName": "960*90",
                      "unitId": 15,
                      "planId": 11,
                      "userId": 24,
                      "ideaStatus": "ENABLED",
                      "adviewType": "WEB",
                      "ideaType": "IMAGE",
                      "landingPage": "https://cloud.baidu.com/product/adn.html",
                      "ideaSlots": ["BANNER", "VIDEO"],
                      "ideaTrade": "IAB9-25",
                      "assets": {
                          "mainImage": {
                              "url": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.jpg",
                              "w": 960,
                              "h": 90
                          }
                      },
                      "impMonitorUrls": [],
                      "clickMonitorUrls": [],
                      "signature":"7781f21d6bb6b56085ee69af4b3def51",
                      "auditStatus": "IN_PROGRESS",
          	        "failureMessage": ""
                  },
                  {
                      "ideaId": 20144,
                      "ideaName": "336*280",
                      "unitId": 15,
                      "planId": 11,
                      "userId": 24,
                      "ideaStatus": "DISABLED",
                      "adviewType": "WAP",
                      "ideaType": "IMAGE",
                      "landingPage": "https://cloud.baidu.com/product/adn.html",
                      "ideaSlots": ["BANNER"],
                      "ideaTrade": "IAB9-26",
                      "assets": {
                          "mainImage": {
                              "url": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.jpg",
                              "w": 960,
                              "h": 90
                          }
                      },
                      "impMonitorUrls": [],
                      "clickMonitorUrls": [],
                      "signature":"7781f21d6bb6b56085ee69af4b3def51",
                      "auditStatus": "PASSED",
          	        "failureMessage": ""
                  },
                  {
                      "ideaId": 20145,
                      "ideaName": "336*280",
                      "unitId": 15,
                      "planId": 11,
                      "userId": 24,
                      "ideaStatus": "DELETED",
                      "adviewType": "WAP",
                      "ideaType": "IMAGE",
                      "landingPage": "https://cloud.baidu.com/product/adn.html",
                      "ideaSlots": ["BANNER"],
                      "ideaTrade": "IAB9-26",
                      "assets": {
                          "mainImage": {
                              "url": "http://dsp.mumamu.cn/upload/f689e32e-8c8b-4940-beb7-edaf2da17e04.jpg",
                              "w": 960,
                              "h": 90
                          }
                      },
                      "impMonitorUrls": [],
                      "clickMonitorUrls": [],
                      "signature":"7781f21d6bb6b56085ee69af4b3def51",
                      "auditStatus": "PASSED",
          	        "failureMessage": ""
                  }
              ]
          }

          UpdateAudit接口

          描述

          开启人工审核时, 可以审核广告主提交的广告创意,通过后再送ADX审核。 如果免人工审,则默认通过, 自动送审到开通的adx。

          请求

          方法 URI 说明
          PUT /adlib/v1/cluster/{clusterId}/idea/{ideaId}?status={status}&message={message} 更新审核状态

          响应

          示例

          请求示例

          PUT /adlib/v1/cluster/0/idea/1?status=PASSED&message=pass HTTP/1.1
          HOST: clouddsp.bj.baidubce.com
          Authorization: {authorization}
          Content-Type: application/json; charset=utf-8

          返回示例

          HTTP/1.1 200 OK
          Content-Type: application/json; charset=utf-8
          上一篇
          接口规范
          下一篇
          Finance财务相关接口