百度opencard提供单个左图右文的开放样式卡片。用户在搜索结果页查看该工具的图文说明,例如:文档模板,用户可以看到文档模板的示意图以及该文档的说明。点击图文结构,标题,tag或者子链跳转至对应的智能小程序落地页,使用或查看详细的功能。
如果你有优质的智能小程序适合接入这个类目,可立即申请接入
示意图
如果你有优质的智能小程序适合接入,可立即申请接入
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
tool_name | string | 服务类型 | 可选,提供的服务类型。如:“文档模板” |
需要注意:提交的intent必须与返回的数据及智能小程序提供的服务相吻合
通过平台上传 txt 文件
txt 文件的具体要求参见接入流程-上传 Intent 数据
当前资源分类 txt 上传文件内容示例如下:
1 | {"tool_name":"文档模板"} |
通过开放 API 上传
详细接入方式参见API上传方式
Webhook API
发送给 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中指定的县、区 | “海淀”/“兰考”,不含行政区划单位,例如”县、区”,可能为空 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48163 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
用户进行搜索时,百度会对开发者提交的intent和用户需求进行匹配,然后将能和用户需求匹配的intent发给开发者,开发者需要根据每个intent代表的用户意图来返回相应的卡片数据以及智能小程序落地页
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的data
object字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
adjective | string | 必选 | 类目名称,最多十个字,类目名称即所提供的工具服务的名称,名称应直接了当地指明工具的主要功能和服务,不可带有品牌词等其他多余信息,可以适当带有在线、免费等吸引用户的字样。如:名片设计,名片在线设计 |
jump_url | string | 必选 | 点击卡片标题的跳转链接地址,跳转至能够提供该工具服务的落地页,落地页内容必须与结果页卡片保持高度一致,不得有与所提供的工具服务无关的信息。该字段需返回 H5 或智能小程序页面路径,如果收到的 surface 请求是 mobile,请返回小程序路径,如果收到的 surface 请求是 web_h5,请返回 H5 路径,例如:“/page/of/target”(以/开头,不含域名),若跳转至 H5 或智能小程序首页(无路径),则需要返回“/?from=baidu”。 |
tag | array | 可选 | 横滑Tag 列表,tag是对工具内容的分类,tag下的内容应默认和第一个tag对应,而第一个tag必须和intent(即用户搜索意图)相对应,最少2个,最多10个 |
tag.text | string | 可选 | Tag文案,最长6个字符 |
tag.tag_url | string | 可选 | tag链接地址。如:“/page/of/target” |
item | array | 必选 | 左图右文列表数据,此类目固定为1组 |
item.title | string | 必选 | 标题文案,最长200个字符 |
item.image | string | 必选 | 图片链接,以“https”开头的图片链接 |
item.ratio | number | 必选 | 图片宽高比,三种样式:1:1、3:4、3:2,需要是海报或者影视书籍才能使用3:4 ; 1:1需要图片质量很好 且图片尺寸等于1:1。一般工具产品使用1:1的图片 字段输入值为数值,如,选择的图片宽高比为3:4则,输入值为0.75 |
item.text1 | string | 可选 | 一行截断 简短几个字的属性说明或描述,例如:属性名称属性值 |
item.text2 | string | 必选 | 对工具的描述,45—80个字。卡片能显示50个字左右,所以文案设计时应该先优先将重要信息写在前面。工具描述介绍工具的主要功能、特色及优势,用有限的字数尽可能向用户传达清楚工具的相关信息,并尽可能地有吸引力。例如:民事起诉状,是指公民、法人或其他组织,在认为自己的合法权益收到侵害或者与他人发生争议时需要确权时用。 |
item.labels | array | 可选 | 卡片右侧展现的标签,用来展现工具的主要特色,比如免费、在线、极速、海量模版等,字符串数组,最多3个 |
item.item_url | string | 必选 | 点击图文结构的跳转链接地址,跳转页内容应与图文内容呼应。url字段需返回H5或智能小程序页面路径。如:“/page/of/target“ |
slink | array | 可选 | 子链列表,最少2个,最多3个。子链可以用来为工具的附加功能或者其他相关工具导流,要注意子链所导向的工具需要与用户诉求的工具有关联,比如名片设计卡片下的子链可以是门头设计和logo设计,逻辑上这个三个工具都是企业视觉设计相关的需求 |
slink.text | string | 可选 | 子链文案,最长10个字符,例如:子链 |
slink.slink_url | string | 可选 | 子链跳转链接,如:“/page/of/target” |
statement | string | 可选 | 底部声明文案,最长100个字符 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |