ADX SSP API对外产品文档v1.0.1

SSP平台是连尚广告对外接入联盟的开放平台。 致力于帮助媒体方实现变现。
媒体方使用API方式接入连尚广告的步骤如下:

  1. 审核资质:请在SSP平台申请注册成为媒体方,审核通过后,会分配app_id。该app_id作为后续请求广告的参数之一。
  2. 申请广告位:用户可根据自己媒体内部的样式,选择合适的广告类型,广告样式。每个app_id可申请多个广告位,每个广告位会分配一个src_id,该src_id作为后续请求广告的参数之一。
  3. 测试环境调试:请在测试环境下调试通过后,切换到生产环境。测试环境相关参数详见下文。
  4. 切换生产环境:经我方技术(或我方提供的自助化接入工具)确认测试环境已经调试通过后,可切换到生产环境。
  5. 验证生产环境:验证生产环境广告是否成功展示,核对广告数据是否正确,验证通过后,可自行开放流量,完成流量变现

API目前支持的广告样式

已上线样式

  1. AST_TABLE_PLAQUE = 2; /* 插屏广告位 */
  2. AST_FEEDS = 3; /* feeds流广告位,目前支持单图,三图 */

未来可有样式

所有可在SSP平台申请的样式,均可通过API的方式获取


测试环境下需要使用到的参数

app_id: test_app
channel_id: 填app当前的渠道号,渠道号列表详见下方 channels list
src_id:

  • 插屏:chap(600:300样式)
  • 信息流:feeds(三图样式)、test_image_text(单图样式)

API接口文档v1.0.1

说明:

  1. API请求和响应参数均使用ProtoBuf格式
  2. 当前接口版本 1.0.1

API请求字段

message ApiRequest
{  
  enum AdSlotType
  {
    AST_BANNER = 0; /* banner广告位 */  
    AST_OPEN_SCREEN = 1; /* 开屏广告位 */  
    AST_TABLE_PLAQUE = 2; /* 插屏广告位 */  
    AST_FEEDS = 3; /* feeds流广告位 */  
    AST_INTEGRAL_WALL = 4; /* 积分墙广告位 */  
    AST_QUIT = 5; /* 退出广告位 */  
    AST_PUSH = 6; /* Push广告位 */
  }
  enum NetType
  {
    NT_UnKnown = 0;
    NT_Ethernet = 1;
    NT_Wifi = 2;
    NT_Cellular = 3;
    NT_Cellular_2G = 4;
    NT_Cellular_3G = 5;
    NT_Cellular_4G = 6;
  }
  enum DeviceType
  {
    DT_UnKnown = 0;
    DT_Phone = 1;
    DT_Pad = 2;
    DT_PC = 3;
    DT_TV = 4;
    DT_Wap = 5;
  }
  required string src_id = 1; /* 必填,广告位id,注册申请 */
  required string app_id = 2; /* 必填,应用id ,注册申请*/
  required AdSlotType src_type = 3; /* 必填 */
  required string client_ip = 4; /* 必填,用户ip 地址*/
  optional string user_agent = 5; /* 必填 */
  optional string os = 6; /* 必填, android/ios */
  optional string os_version = 7; /* 必填 系统版本*/
  optional string api_level = 8;  /* android api level */
  optional string mac = 9; /* 必填 */
  optional string imei = 10; /* android 必填 */
  optional string android_id = 11; 
  optional string android_adid = 12;
  optional string idfa = 13; /* ios 必填 */
  optional string openUDID = 14;
  optional NetType net_type = 15; /* 必填 */
  optional DeviceType dev_type = 16;
  optional uint32 operator = 17; /* 必填, 运营商, unknown(0), 移动(1), 电信(2), 联通(3) */
  optional uint32 lalo_type = 18; /* gsp坐标类型:高德(0) 百度(1) 腾讯(2) 谷歌(3) 其他(4) */
  optional double longitude = 19; /* 必填 */
  optional double latitude = 20; /* 必填 */
  optional string wifi_ssid = 21;
  optional string wifi_bssid = 22;
  repeated string ssid_list = 23; /* 用户当前扫描到的wifi ssid列表 */
  repeated string bssid_list = 24; /* 用户当前扫描到的wifi bssid列表 */
  optional string dedup_key = 25; /* 用于同页面内广告去重的uniq_key,一个页面的同一session内只会生成唯一的一个uniq_key */
  optional string language = 26;
  optional uint32 screen_width = 27; /* 必填 */
  optional uint32 screen_height = 28; /* 必填 */
  optional uint32 screen_density = 29;
  optional uint32 horizontal = 30; /* 横屏(1)  */
  optional string vendor = 31; /* 手机品牌 */
  optional string model = 32; /* 手机型号 */
  optional string pkg_name = 33; /* 必填, 包名 */
  optional string app_version = 34; /* app版本 */
  optional string app_market = 35; /* 必填, 渠道 */
  optional string api_version = 36 [default = "1.0.0"]; /* 默认1.0.0, 当1.0.0时,返回结果protobuf使用Response;当1.0.1及以后,使用ApiResponse; 本版本为1.0.1,请在请求时加上版本参数 */
}

API返回字段

message ApiResponse
{
  message Ad
  {
    optional string dsp_name = 1;
    optional uint32 cpm = 2;
    optional string type_id = 3; /* 广告的样式id */
    optional string landing_url = 4; /* 跳转url */
    repeated string show_urls = 5; /* 展现上报 */
    repeated string click_urls = 6; /* 点击上报 */
    repeated string inview_urls = 7; /* inview上报 */
    optional string download_url = 8; /* apk url, 下载广告才有*/
    repeated string download_urls = 9; /* 开始下载上报 */
    repeated string downloaded_urls = 10; /* 下载完成上报 */
    repeated string installed_urls = 11; /* 安装完成上报 */
    optional string deeplink_url = 12; /* deeplink url */
    repeated string deeplink_click_urls = 13; /* deeplink 点击上报*/
    required string ad_type = 14; /* 广告类型:redirect/跳转,download/下载; */
    repeated string image_urls = 15; /* 图片地址 */
    optional string title = 16; /* 标题 */
    optional string content = 17; /* 正文 */
    optional string desc = 18; /* 预留 */
    optional string app_name = 19; /* 下载类型:应用名称 */
    optional string pkg_name = 20; /* 下载类型:应用包名 */
    optional string app_icon = 21; /* 下载类型:应用图标 */
    optional string app_size = 22; /* 下载类型:应用包大小 */
    optional string button_text = 23; /* 下载类型广告按钮文字 */
    optional string distance = 24; /* 文字: 距您xx米 */
    message OpenScreenParams {  /* 开屏广告相关参数 */
      optional uint32 start_time = 1; /* 开始时间 */
      optional uint32 end_time = 2; /* 结束时间 */
      optional string show_mode = 3; /* show_mode=“1" 应用启动展示  show_mode=“0" 应用从后台进入前台展示*/
      optional uint32 duration = 4; /* 持续时长,单位秒 */
      optional bool can_skip = 5; /* 是否可以跳过 */
    }
    optional OpenScreenParams open_screen_params = 25; /* 开屏的参数, 开屏允许预加载,所以会有开始时间和结束时间,展现时间必须要在有效时间内 */
  };

    repeated Ad ads = 1;  
    optional bool allowed_reuse = 2 [default = false]; /*广告是否支持重复使用*/                                                                                                    
}

channels list

渠道代码 渠道名称
“huawei” 华为
“nearme” OPPO
“baidu” 百度
“91” 91助手
“hiapk” 安卓网
“360” 360
“aliyun” 阿里云
“wandoujia” 豌豆荚
“guanwang” 官网
“pp” PP助手
“kupai” 酷派
“tencent” 腾讯
“test” 测试
“xiaomi” 小米
“meizu” 魅族
“mm” 陌陌
“jinli” 金立
“lianxiang” 联想
“zol” 中关村在线
“goapk” 安智市场
“letv” 乐视
“samsung” 三星
“sougousjzs” 搜狗
“push” PUSH渠道
“appchina” 应用汇
“feng” 威锋网
“mopin” 魔品助手
“liantong” 联通
“cheyouhui” 车友汇
“zhidian1” 智店云app安卓手机
“aqiyi” 爱奇艺
“10086” 10086
“2345” 2345
“weipinhui01” 唯品会
“gozm” GO桌面
“baofeng” 暴风
“update” 更新
“jnritoutiao” 今日头条
“snda” 盛大
“gfan” 机锋网
“nduo” N多市场
“mumayi” 木蚂蚁
“nubia” 努比亚
“Others” 其他
0 条评论
发表一条评论