用户在搜索开学放假安排等信息,如:”清华大学开学时间”、“北京学校开学时间”时,在结果页展示开学安排卡片。该卡片三表格,展示学生所在地区,对应年级,开学时间。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
school | string | 可选,对应的学校名称。 | 如:“清华大学”,“北京大学附属中学” |
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"school":"清华大学"} |
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型(大部分开发者可不关心) | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景(大部分开发者可不关心) | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
location | object | 用户定位信息 | JSON 对象 |
location.province | string | 用户所在省份 | “北京”/“浙江”,不含行政区划单位,例如”市、省、自治区”,可能为空 |
location.city | string | 用户所在城市 | “北京”/“杭州”,不含行政区划单位,例如”市”,可能为空 |
query_info | object | 用户表达的地域、年级、学龄阶段、时间类型、年份信息,对于地域成份,应优先选用用户表达的位置信息进行检索 | JSON 对象 |
query_info.query_province | string | 用户 Query 中指定的省份 | “北京”/“河南”,不含行政区划单位,例如”市、省、自治区”,可能为空 |
query_info.query_city | string | 用户 Query 中指定的地级市 | “北京”/“开封”,不含行政区划单位,例如”市”,可能为空 |
query_info.query_county | string | 用户 Query 中指定的县、区 | “海淀”/“兰考”,不含行政区划单位,例如”县、区”,可能为空 |
query_info.grade | string | 用户 Query 中指定年级 | “三年级”,可能为空 |
query_info.stage | string | 用户 Query 中指定学龄段 | “高中”,可能为空 |
query_info.year | string | 用户 Query 中指定年份 | “2020 年”,可能为空 |
query_info.state | string | 用户 Query 中指定时间类型 | “开学”、“放假”,不能为空 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48087 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当 status 非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的 data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
jump_url | string | 必选 | 点击卡片标题的跳转链接地址,跳转至资源方落地页。该字段需返回 H5 或智能小程序页面路径,如果收到的 surface 请求是 mobile,请返回小程序路径,如果收到的 surface 请求是 web_h5,请返回 H5 路径,例如:“/page/of/target”,若跳转至 H5 或智能小程序首页(无路径),则需要返回“/?from=baidu”。 |
title1 | string | 必选 | 表头文案 1,需要根据 query_info 中的请求参数设置合理的表头,如 query_info.query_province 等代表地域的字段为空的:一般为“地区” |
title2 | string | 必选 | 表头文案 2,一般为“年级” |
title3 | string | 必选 | 表头文案 3,时间,如:“开学时间”,“寒假开始” |
table_rows | array | 必选 | 表格数据配置,最少 2 个,最多 25 个 |
table_rows.table_rows1 | string | 必选 | 表格第 1 列的文案,一般为学校所在地区。如;“北京” |
table_rows.table_rows2 | string | 必选 | 表格第 2 列的文案,一般为学生年级。如:“高三” |
table_rows.table_rows3 | string | 必选 | 表格第 3 列的文案,时间,如:“5 月 20 日” |
slink | array | 可选 | 子链列表,最少 2 个,最多 3 个 |
slink.text | string | 可选 | 子链文案,最短 1 个字符,最长 6 个字符。如:“详细开学信息”,“开学注意事项” |
slink.url | string | 可选 | 子链跳转链接,如:“/page/of/target” |
statement | string | 可选 | 底部声明文案,对卡片进行注释说明,也可以对信息时间进行说明。不超过 24 个字符 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |