用户在搜索知识需求时,搜索会展现对应的图文知识专栏卡片,提供图文专栏在线学习/浏览服务。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
album | string | 专辑名称 | “宏观经济课” |
author | string | 专辑作者名称 | “她理财” |
通过平台上传 txt 文件
资源方需要将自己小程序能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"album":"宏观经济课","author":"她理财"} |
通过开放 API 上传
详细接入方式参见 API上传方式。
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型(大部分开发者可不关心) | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景(大部分开发者可不关心) | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48126 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的 data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
jump_url | string | 必选 | 标题跳转链接,跳转至小程序专栏目录页(小程序样例数据:/path/to/page,h5样例数据:http://www.lottery.gov.cn/) |
item_list | array | 必选 | 专栏内容列表,固定为1个 |
item_list.album_title | string | 必选 | 专栏标题,最长200个字符 |
item_list.album_image | string | 必选 | 专栏图片链接,图片像素要求:364*486px |
item_list.author_name | string | 可选,选后不可为空 | 专栏作者名,最短1个字符,最长100个字符,例如:她理财 |
item_list.content_quantity | string | 必选 | 专栏内容数量,最短1个字符,最长100个字符,例如:11篇文章 |
item_list.number_of_views | string | 必选 | 专栏浏览次数,最短1个字符,最长100个字符,例如:21.3w |
item_list.label_group | array | 可选 | 标签组,最多填写2个,免费资源不填。例如:正版资源可填写“正版”标签; 付费资源需根据专栏实际情况填写:“付费”、“限时优惠”、“VIP”(需为大写)。 |
item_list.url | string | 必选 | 专栏跳转地址,链接到小程序专栏目录页 |
item_list.current_price | string | 可选 | 专栏现价,免费资源不填,默认单位是分,例如:1990 |
item_list.price_info | string | 可选 | 补充文案,免费资源可不填,最长6个字符。例如:“原价¥120”、“会员免费”、“已售138” |
contents | array | 必选 | 章节目录,最少3个,最多3个 |
contents.chapter_no | string | 必选 | 章节号,最短1个字符,最长100个字符,例如:1 |
contents.chapter_title | string | 必选 | 章节标题,最短1个字符,最长100个字符,例如:GDP是什么?10分钟轻松读懂GDP |
activity_description | string | 可选,选后不可为空 | 活动说明文案,最短1个字符,最长80个字符,例如:智能小程序专享 知乎盐选会员年卡6折购买 |
activity_url | string | 可选 | 小程序活动页面地址 |
activity_tag | string | 可选,选后不可为空 | 活动标签文案,固定为“活动”,最短1个字符,最长5个字符 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |
审核常见问题
intent的编写
图文知识专栏intent中的album字段,提供的应该是图文知识专栏名称,开发者可以对其进行适当泛化,但是必须在卡片能提供的内容服务范围内。author字段,不支持泛化,应提交小程序内专栏作者名称。开发者应清晰了解intent泛化边界,举例如下:
类目 | intent | 卡片内容 | 是否通过 |
---|---|---|---|
图文知识专栏 | {“album”:“人人都能读懂的宏观经济课:把握经济大势,做好投资理财”,“author”:“她理财”} | 人人都能读懂的宏观经济课:把握经济大势,做好投资理财 | 通过 |
图文知识专栏 | {“album”:“人人都能读懂的宏观经济课”,“author”:“她理财”} | 人人都能读懂的宏观经济课:把握经济大势,做好投资理财 | 通过 |
图文知识专栏 | {“album”:“宏观经济课”,“author”:“她理财”} | 人人都能读懂的宏观经济课:把握经济大势,做好投资理财 | 通过 |
图文知识专栏 | {“album”:“宏观经济”,“author”:“她理财”} | 人人都能读懂的宏观经济课:把握经济大势,做好投资理财 | 不通过,intent过度泛化,不在卡片能提供的内容服务范围内 |