2.标准协议接口

Cloud-SSP内置了两类服务于不同场景的接口,分别是/ps/std/ps/page。其中/ps/std接口需要开发者主动发起请求;而/ps/page会在业务系统的广告位导出投放代码中通过JS自行完成调用。两类接口的请求url分别为:

http://cloudssp.com/ps/std
http://cloudssp.com/ps/page

2.1.1 /ps/std类接口

/ps/std为通过url调用的标准检索入口,此接口将会返回标准协议,具体协议内容可以参见StandardResponse。为了方便开发者的使用,CloudSSP内置支持了三种请求格式,分别为protobuf、json、form表单,对应的请求路径是:

http://cloudssp.com/ps/std
http://cloudssp.com/ps/std_pb
http://cloudssp.com/ps/std_json

三种接口分别对应

  1. url参数请求
  2. protobuf结构体请求
  3. json结构体请求

在请求体某些参数(如ip)不完全的情况下,CloudSSP会使用从Http请求中解析出的信息,此时解析出的信息将会覆盖原有请求体中所携带信息(如IP,UserAgent,地域信息等)。然而有时Http请求的发起方可能为中转服务器,导致所有的请求中自带的Http信息会完全一致。为解决这一问题,新增专为中转服务器准备的三种接口ps/std_proxy, ps/std_pb_proxy , ps/std_json_proxy。标准协议的请求url为:

http://cloudssp.com/ps/std_proxy
http://cloudssp.com/ps/std_pb_proxy
http://cloudssp.com/ps/std_json_proxy

具体接口格式见 3. 标准请求 及 4. 标准响应

2.1.2 /ps/page

/ps/page接口为通过代码投放的标准入口,通过我们提供的投放代码,将会下载一份JS文件,在JS文件中会通过ps/page接口检索广告。

2.1.2.1 /ps/page

当浏览器为Chrome,Firefox,Edge等支持XMLHttpRequest组件的浏览器时,检索请求就会使用page标准接口。此接口将会返回一段JSON代码,其格式为

{
    "html":"<html></html>",
    "cache":"http://cache_ad.com",
    "style":{
        ……
    }
}

当接收到JSON格式的返回后,JS代码会根据接收到的返回进行广告的渲染。

2.1.2.2 /ps/jsonp

/ps/jsonp接口与/ps/page类似,都是在js文件中提供检索广告的接口。与/ps/page是为Chrome等非IE内核的浏览器提供的接口不同,/ps/jsonp是为不支持XMLHttpRequest组件但支持ActiveXObject组件的浏览器提供的接口。