用户在搜索公司股东需求时,搜索展现公司股权结构卡片,提供直观结构化的公司股东内容。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
company | string | 公司名/集团名/品牌名 | 公司名:”深圳市腾讯计算机系统有限公司” “北京百度网讯科技有限公司” 集团名:”腾讯” “百度” “字节跳动” 品牌名:”抖音” “uc浏览器” |
通过平台上传 txt 文件
资源方需要将自己小程序能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"company":"深圳市腾讯计算机系统有限公司"} |
通过开放 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 | 资源编号 | 48114 |
当前资源的 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 | 必选 | 点击卡⽚标题的跳转路径,应跳转资源方落地页,该落地页应含有公司股权结构信息。 如果收到的surface请求是moblie,请返回小程序路径,例如:/page/of/target; 如果收到的surface请求是web_h5,请返回H5路径,如/page/of/target(以/开头,不含域名) |
baseData | array | 必选 | 数据列表,最少1个,最多3个 |
baseData.titleS | string | 必选 | 公司名/品牌名/集团名,尽量<15字,否则会截断 例如: 公司名”深圳市腾讯计算机系统有限公司” 集团名”腾讯” “百度” “字节跳动” 品牌名:”抖音” “uc浏览器” |
baseData.titleP | string | 必选 | 股权结构信息标题,尽量<5字,否则会截断,例如:股东信息 |
instructionKey | string | 可选,选后不可为空 | 属性字段信息标题,字段内容固定为:公司属性: |
instructionValue | string | 可选,选后不可为空 | 描述公司是否上市,若为上市公司,则字段内容为A股(美股/港股)上市公司;若为非上市公司,则字段内容为非上市公司 |
table | array | 必选 | 数据列表,数据可传最少1个,最多10个; 但卡片最多支持展现8个,数据超过8个省略且展现查看更多 |
table.head | string | 必选 | 表格表头,尽量<6字; 若为上市公司,表格内容为上市公司披露大股东,具体表头字段需包含股东名称、持股数、持股比例、持股性质; 若为非上市公司,表格内容为公司股权结构信息,具体表头字段需为股东名称、持股比例、出资认缴额; |
table.body | array | 必选 | 各个表头字段对应具体内容,尽量<12个字符 |
showMore | integer | 可选 | 若股东数据超过8个,则为1,展示查看更多;否则为0 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |
审核常见问题
三类intent对应的数据问题
company有三类:公司名/品牌名/集团名,三者对应的数据格式一致,但具体内容要求不同
三类具体区分方法和对应的内容要求如下
- 公司名为具体某家公司,例如:需求为腾讯计算机系统有限公司股权结构;要求内容为该具体公司的股权结构信息
- 集团名为大众认知上集团名称,一般为多家公司集合,例如腾讯股权结构、百度股东;要求内容为集团的股权结构信息
- 品牌名为大众认知上品牌名称,例如:抖音股东、作业帮股东;要求内容为该品牌对应背后集团/公司的股权结构信息
上市公司与非上市公司,用户需求的股权结构信息不同,数据内容也需要依据公司上市与否调整。
若为上市公司/上市集团/上市品牌,表格内为公司披露大股东内容,具体字段包含:
1、股东名称:必选
2、持股数:必选,单位可变,最多展示小数点后三位
3、持股比例:必选,若持股占比少于0.01%,显示少于0.01%
4、持股性质:非必选
若为非上市公司/非上市集团/非上市品牌,表格内为公司股权结构信息,具体字段包含:
1、股东名称:必选
2、持股比例:必选,若持股占比少于0.01%,显示少于0.01%
3、认缴出资额:非必选
股东排序要求按照持股比例从大到小排列