书架内容查询接口说明
解释:百度 APP-书架发送给小程序的查询请求,接入百度 APP-书架同步能力的开发者,需要参照本文档开发书架内容查询接口,并在“开发者平台-产品试验室- 百度 APP 书架同步”页面填写提交接口路径,以供百度 APP-书架服务查询并展示对应内容详情。
百度 APP-书架发送给小程序的查询请求,为以下形式
请求方式:POST
请求参数:
参数 | 数据类型 | 说明 |
---|---|---|
content_ids | Array.<String> | 内容 id ,由开发者调用 swan.insertBookshelf 向百度 APP-书架同步小程序内容时定义。批量最多 100 条,重复的 contentId 只取一个 |
请求示例:
{
"content_ids": [
"comic-20",
"123456"
]
}
小程序返回给百度 APP-书架的参数,需遵照以下形式
返回参数:
参数 | 数据类型 | 必填 | 说明 |
---|---|---|---|
errno | String | 是 | 错误码,0-表示成功,1-表示失败 |
msg | String | 是 | 错误描述信息,由开发者自定义 |
data | Object | 是 | 返回的内容详情列表,详见下方列表 |
data 包含参数:
参数 | 数据类型 | 必传 | 说明 | 示例 |
---|---|---|---|---|
path | String | 是 | 小程序内容落地页链接,用户从书架点击回访小程序内容时,会跳转到此页面。(包含中文时需要 encode) | /pages/detail/detail?type=5&id=7401883 |
category | String | 是 | 内容所属分类:article-专栏,doc-文档,cartoon-动漫,av-影音 | cartoon |
chapter_num | String | 否 | 内容所包含章节的总数,当内容分类为影音时必填。专辑型内容填写真实章节数量,单篇内容填 1 | 1200 |
status | String | 是 | 内容的基本状态,0 - 默认、1- 资源有更新、2 - 资源已下线 | 0 |
resource_free | String | 是 | 内容的付费状态,0 - 免费、1 - VIP 可看、2 - 付费、3 - 活动中、4 - 限时免费、5 - 按章节付费、6 - 有折扣 | 0 |
coupon_info | String | 否 | 优惠信息,当‘付费状态’为 4-限时免费时,coupon_info 和 pay_info 至少一个不为空 | “限时七折,还剩 23 小时 59 分钟” |
pay_info | String | 否 | 用于优惠信息计算,json 字符串,详见下方 pay_info 参数列表 | {\”pay_money\”:1000,\”discount_money\”:700,\”discount_starttime\”:\”2020-03-05 00:00:00\”,\”discount_endtime\”:\”2020-03-24 00:00:00\”} |
cover | String | 是 | 内容封面图链接,建议尺寸:专栏模板 - 316x316px、文档/漫画模板 - 316x421px、视频模板 - 558x419px | www.baidu.com |
title | String | 是 | 内容的标题 | 斗罗大陆 |
author | String | 是 | 内容原作者 | 穆逢春 |
last_chapter | String | 否 | 连载专辑型内容的最新章节,结构: 最新章节数 . 最新章节 title | 248.勤奋的凤凰(1) |
create_time | String | 否 | 内容发布时间,十位时间戳格式 | 1553529600 |
modify_time | String | 否 | 最近更新时间,十位时间戳格式 | 1553529600 |
duration | String | 否 | 视频时长,当资源类型为单个影音时必填,格式 HH:MM:SS | 01:22:57 |
pay_info 参数:
参数 | 数据类型 | 必填 | 说明 | 示例 |
---|---|---|---|---|
pay_money | Int64 | 否 | 内容原价 | 1000 ,¥10.00 |
discount_money | Int64 | 否 | 优惠价格 | 0:限时免费;500:限时折扣价¥5.00 |
discount_starttime | String | 是 | 优惠开始时间 | 2020-03-05 00:00:00 |
discount_endtime | String | 是 | 优惠结束时间 | 2020-03-24 00:00:00 |
返回成功示例:
{
"errno":0,
"errmsg":"succ",
"data":{
"comic-20":{
"path": "/pages/detail/detail?type=5&id=7401883",
"create_time":"1569311652",
"modify_time":"1582082781",
"chapter_num":"11",
"status":"0",
"resource_free":"1",
"coupon_info":"限时折扣,还剩14天12小时54分钟结束",
"cover":"http://t11.baidu.com/it/JPEG?&s=50A5",
"title":"投资心理课——从错误中学习如何安全盈利",
"author":"叶檀",
"last_chapter":"11.如何安全盈利"
}
}
}
返回失败示例:
{
"errno":0,
"errmsg":"",
"data":{
}
}