权限认证
API 通过授权令牌(TOKEN),TOKEN需要在每次请求时通过请求头传入,由运营接口人提供,注册后方能正常使用。
编码方式
若无特殊说明或响应头中的Content-Type未指定编码,请求和响应中的字节编码均使用UTF-8(无BOM 头)。
URI定义
实际对接时请于客服联系。
API请求
HTTP Method
调用方应设置HTTP Method为POST。
HTTP Header
调用方应遵循HTTP协议设置相应的Header,目前支持的Header有:authorization-key、Content-Type;
authorization-key用于传递授权令牌(TOKEN),Content-Type用于指定数据格式;
本章节中Content-Type应为application/json。
HTTP Header示例:
Content-Type: application/json
authorization-key: Bearer TOKEN
请求JSON 格式
名称 | 类型 | 必填 | 限制 | 描述 |
---|---|---|---|---|
data | JSONArray of RequestData | 是 | 具体请求数据, RequestData数组,目前不支持批量请求广告,数组长度一般为1 |
RequestData 对象格式
名称 | 类型 | 必填 | 限制 | 描述 |
---|---|---|---|---|
adspaceId | string | 是 | 由自动化运营产品方为媒体方创建的广告位Id | |
isMobile | String | 是 | 是否移动流量:(1:移动流量,0:PC),默认=1 | |
deviceType | String | 是 | 设备类型:设 备 类 型 (-1: 未 知 , 0:phone, 1:pad, 2:pc, 3:tv ,4:wap,5:户外广告屏) | |
src | String | 是 | 当前页(PC流量时必填,移动流量不用填) | |
deviceBrand | String | 否 | 设备品牌、生产厂商(“HUAWEI”、”Apple”、”Xiaomi”) | |
deviceModel | String | 否 | 手机型号(”SM-G9280”、”iPhone8”、”MIX 2S”等) | |
deviceId | string | 是 | 设备唯一标识 ,android系统下是IMEI或者IMEI MD5,或者OAID或者OAID MD5;IOS系统下是IDFA或者IDFA_MD5 | |
androidId | string | 是 | Android 系统下必填 | |
deviceImei | String | 是 | IMEI明文(IOS不填,与deviceImeiMd5 任意一个) | |
deviceImeiMd5 | String | 是 | IMEI MD5编码(IOS不填,与deviceImei任意一个) | |
deviceOaid | String | 是 | OAID:Android Q系统不能再获取IMEI作为唯一标识,移动联盟推出OAID作为唯一ID,只能用于广告投放 | |
deviceIdfa | String | 是 | IOS系统IDFA 明文 | |
deviceIdfaMd5 | String | 是 | IOS系统IDFA MD5编码 | |
mac | string | 是 | 设备Mac地址 | |
screenWidth | Integer | 否 | 设备屏幕宽(像素) | |
screenHeight | Integer | 否 | 设备屏幕高(像素) | |
densityDpi | Integer | 否 | 设备屏幕密度:每英寸像素 | |
density | String | 否 | 屏幕分辨率值如:3.0. Android 平台参考:DisplayMetrics.density, iOS 平台参考:UIScreen.scale | |
appName | string | 是 | APP名称 | |
appPackage | String | 是 | APP应用包名 | |
appVer | String | 否 | APP本身版本 | |
os | Integer | 是 | 设备系统1 android; 2 ios; 3 windows; 4 symbuan; 5 java; 6 其他。 | |
osVersion | String | 否 | 操作系统版本 | |
simOperatorName | Integer | 是 | 运营商:1 移动 2联通 3 电信 4 其他 | |
deviceUa | String | 是 | 是标准 Webview UA 而非自定义UA | |
ip | string | 否 | 设备IP地址,province,city,district 都不为空时候可不填,否则必填 | |
province | string | 否 | 省行政区划编码 | |
city | string | 否 | 市行政区划编码 | |
district | string | 否 | 区行政区划编码 | |
networkType | Integer | 否 | 设备网络类型:1 wifi; 2 2G; 3 3G; 4 4G; 5 5G。 | |
latitude | float | 否 | 至少精确到小数点后7位 | 纬度 WGS-84坐标系 |
longitude | float | 否 | 至少精确到小数点后7位 | 经度 WGS-84坐标系 |
industries | String [] | 否 | 禁投行业数组 | |
crowdTags | String[] | 否 | 人群标签 |
JSON数据示例
{
"data": [{
"adspaceId": "340-20191009110722805",
"appName": "XXX",
"district": "150901",
"city": "150900",
"province": "150000",
"densityDpi": 440,
"deviceId": "LINDAO_399031",
"networkType": 1,
"os": 1,
"screenHeight": 1080,
"screenWidth": 2248,
"simOperatorName": 3,
"premiseId": "123322306061233230606",
"tradeArea": "1232130203",
"industries": ["H01701"]
}]
}
API响应
HTTP状态码:支持HTTP标准状态码
状态码 | 名称 | 描述 |
---|---|---|
200 | 成功 | 当API 请求被正确处理,且能按设计获取结果时,返回该状态码;亦适用于批量接口返回部分结果 |
3xx | 跳转 | 在特定情况下,API 可能会返回这些状态码,建议调用方按照HTTP 标准来处理 |
4xx | 客户端错误 | 由客户端原因造成的错误 |
5xx | 服务器端错误 | API 或其下层服务发生内部错误 |
- 其中,4xx 和5xx 的状态码仅用于辅助调用方快速识别问题,不作为包含实际语义的错误码,若有调整也不另行通知,实际操作结果以API返回的数据为准。调用方也应能够识别和处理由于网络异常等因素导致的,由非API 服务返回的HTTP 状态码,如504 Gateway Timeout。
HTTP Header
响应会根据接口要求设置Content-Type。本章节中Content-Type均设置为application/json。
HTTP Body
响应的JSON数据中包含三部分内容,分别为返回码、返回信息和数据,如下表所示:
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
code | int | 是 | 返回码:1表示成功,2表示没有广告填充,此时,data 为空。 |
message | String | 否 | 返回信息: 如 成功 |
data | JsonArray of ResponseData | 否 | 返回结果:针对批量接口,若无特殊说明,结果将按请求数组顺序返回。如果自动化运营产品 没有返回data,表明没有合适的广告返回,在没有返回广告的情况下,请媒体方自行处理,比如加载一个默认广告 |
ResponseData 格式
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
action | Integer | 是 | 广告交互类型:(1普通连接 2下载广告) 默认值1 |
creativeId | String | 是 | 投放素材id |
creativeType | String | 是 | 创意素材类型(1:图片 2:视频 99:组合类型) |
industry | String | 是 | 行业 |
landpage | String | 否 | 落地页 |
deepLink | String | 否 | deepLink 地址, |
showUrl | String[] | 是 | 曝光监测地址数组 |
clickUrl | String[] | 否 | 点击监测地址数组 |
thridShowUrl | String[] | 否 | 第三方曝光监测地址数组 |
thridClickUrl | String[] | 否 | 第三方点击监测地址数组 |
creative_view | Integer | 是 | 素材模板,根据媒体方在自动化运营产品方创建媒体位时选择模板返回。现有模板请联系客服索取《现有媒体位接入模板规格表.xlsx》,如果现有模板不满足媒体方需求,请联系我们,我们将进行补充配置。模板的定义提供最多4个素材位 1个标题位 1个描述位。可根据媒体方实际广告位情况自行定义模板,如1图2文,1视频2图等。需要自动化运营产品方根据媒体方,情况约定,告知媒体方。 |
creative_spec | Integer | 是 | 素材规格,媒体方在与自动化运营产品接入时约定好自己媒体的模板,以及每个位置的素材文件类型,文件尺寸,播放时长等定义为一个规格。需要自动化运营产品方根据媒体方实际情况约定,告知媒体方。根据媒体方在自动化运营产品创建媒体位时选择规格返回响应的素材。 |
multimedia1_file_url | String | 否 | 模板规格种第一个素材的地址 |
multimedia2_file_url | String | 否 | 模板规格种第二个素材的地址 |
multimedia3_file_url | String | 否 | 模板规格种第三个素材的地址 |
multimedia4_file_url | String | 否 | 模板规格种第四个素材的地址 |
title | 否 | 标题 | |
description | 否 | 描述 | |
appName | String | 否 | 应用名称 |
packageName | String | 否 | 应用包名 |
appstoreId | String | 否 | AppStore 应用市的应用 ID |
dpStart | String[] | 否 | deepLink 字段非空时,直接唤起类(尝试唤起时上报) |
dpSucc | String[] | 否 | deepLink 字段非空时,直接唤起类(唤起成功时上报) |
dpFail | String[] | 否 | deepLink 字段非空时,直接唤起类(唤起失败时上报) |
dnStart | String[] | 否 | 下载类广告(下载开始时上报) |
dnSucc | String[] | 否 | 下载类广告(下载成功时上报) |
videoStart | String[] | 否 | 视频广告(播放开始时上报) |
videoOneQuarter | String[] | 否 | 视频广告(播放25%时上报) |
videoOneHalf | String[] | 否 | 视频广告(播放50%时上报) |
videoThreeQuarter | String[] | 否 | 视频广告(播放75%时上报) |
videoComplete | String[] | 否 | 视频广告(播放完成时上报) |
返回示例
{code:1,
message:"成功"
beginTime:"2019-12-03 00:00:00"
endTime:"2020-01-31 00:00:00"
data:[{
"action":1,
"landpage":" https://itunes.apple.com/cn/app/idXXXXXXXXXX",
"showUrl":"https://test.showXXXXX.com",
"clickUrl":"https://test.clickXXXXX.com ",
"thridShowUrl":"https://test.tdclickXXXXX.com ",
"creative_view":1,
"creative_spec":2,
"multimedia1_file_url":"http://tt.XXXXX.com/data/640-360.jpg",
"title":"",
"description":""
}]
}
作者:admin 创建时间:2022-07-19 17:27
最后编辑:admin 更新时间:2022-07-21 10:46
最后编辑:admin 更新时间:2022-07-21 10:46