修改广告
Last updated
Last updated
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
表单参数:
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
系统全局错误说明详见全局错误说明
成功示例
异常示例
参数名 | 类型 | 说明 |
---|---|---|
响应代码 | message | 说明 |
---|---|---|
userid
true
String
保利威点播账户id,可以参考【获取密钥】获取,获取路径:官网->登录->点播(API接口)
ptime
true
Long
当前时间的毫秒级时间戳,3分钟内有效
sign
true
String
签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见签名生成规则】
adid
true
String
广告id,该值可以参考【查询广告列表】获取
startDate
false
String
广告开始日期,格式为:yyyy-MM-dd,例如:2021-04-07
endDate
false
String
广告结束日期,格式为:yyyy-MM-dd,例如:2021-04-10
title
false
String
广告标题
file
false
File
广告素材 片头、片尾广告支持:JPEG,GIF,PNG,FLV,MP4 暂停广告支持:SWF,PNG,JPEG,GIF 弹窗广告支持:PNG,JPEG,GIF
size
false
Integer
广告时长,除请求参数location为暂停广告外,其他广告类型都为必填参数,单位秒
cataids
false
String
分类id,关联多分类时,以英文逗号分隔,默认值为1,1是默认分类
location
false
Integer
广告类型,默认为片头 1:片头 2:暂停 3:片尾 4:弹窗
popLocation
false
Integer
广告弹窗位置,当请求参数location为弹窗时必填 1:右下角 2:右上角 3:左下角 4:左上角
popUpTime
false
Integer
弹窗出现的时间,单位秒,当请求参数location为弹窗时必填
status
false
Integer
广告状态,默认为已上线 10:已上线 1:待上线 0:已下线
upTime
false
String
广告开始时间,格式为:HH:mm:ss,默认为:00:00:00
offTime
false
String
广告结束时间,格式为:HH:mm:ss,默认为:23:59:59
note
false
String
广告描述
skipAd
false
String
是否开启跳过广告,仅当请求参数location为片头广告有效,默认值为N Y:开启 N:关闭
skipOffset
false
String
多少秒后允许跳过,当请求参数skipAd为Y时,该字段为必填参数
skipButtonLabel
false
String
跳过按钮标签,默认为跳过
code
Integer
响应状态码,200为成功返回,非200为失败【详见全局错误说明】
status
String
响应状态文本信息
message
String
响应描述信息,当code为400或者500的时候,辅助描述错误原因
data
Object
响应成功时返回true,响应失败时返回空
400
sign can not be empty.
加密串为空
400
ptime is too old.
时间戳过期
400
ptime is illegal.
时间戳参数格式不对或者超过当前时间3分钟
400
Could not find user by userid.
userid不存在
400
the sign is not right.
加密串不正确
400
file is empty.
没上传文件或为空文件
400
illegal file type.
非法的文件类型
400
upload file failed.
上传文件失败
400
startDate or endDate error.
日期格式不正确或开始日期大于结束日期
400
upTime or offTime error.
时间格式不正确或开始时间大于结束时间
400
param status can not be empty.
广告状态不能为空
400
title can not be empty.
广告标题不能为空
400
cataids length is not right.
分类数量不正确
400
exist the same cataid.
存在相同的cataid
400
cataid type error.
cataid类型错误
400
cata not exist.
分类不存在
400
cata conflict.
不能同时存在父分类和子分类
400
param location error.
广告类型错误
400
param addrurl error.
链接地址错误
400
pop location error.
弹窗位置错误
400
pop up time error.
弹窗出现时间错误
400
admatter is not exist.
广告不存在
400
illegal skipOffset.
开启了跳过广告,但skipOffset参数不正确(不得小于0或大于广告时长)
400
location type not supported to skipAd.
广告类型不支持开启跳过广告
400
save fail.
服务器异常导致失败