用户在移动端搜索某款游戏的精准游戏名时,搜索结果页会展现该卡片,提供相关直播信息。
示意图
intent 上传接口
当前资源 intent 意图参数
| key | 类型 | 含义 | 必选/可选 | 示例/说明 |
|---|---|---|---|---|
| game_name | string | 游戏名 | 必选 | 绝地求生 |
game_name 要求
请务必严格遵守,不仅会影响审核,还会影响线上召回。
① 三种填写结构:
a. 填写游戏名,如“英雄联盟”,
b. 游戏名+mode,如“英雄联盟云顶之奕”,
c. 著名 Mode,如“云顶之奕”;
② 准入范围:
a. 一定填精准游戏名,不能填写含义模糊、过于泛的名字,比如“三国”,因为三国对应了好多游戏,根本无法判断出哪个游戏;
b. 如果游戏有别名,单独填写一次;比如侠盗飞车 5,需要填两次, 一次是“侠盗飞车 5”,一次是“gta5”;
③ 文本规范:
a. 不要带标点符号,正确“遗迹灰烬重生”,错误“遗迹:灰烬重生”。如果填写标点符号,可能会导致线上不展现;
b. 大写字母都变小写,比如“gta5”, “lol”。
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"game_name":"英雄联盟"} |
通过开放 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 | 资源编号 | 48039 |
当前资源的 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 | 必选 | 卡片标题的跳转链接,跳至对应游戏的直播列表页。直播列表页需有与卡片对应的 tag。H5 的跳转链接要去掉域名,例如:/games/hzwwqfb/ ;小程序的跳转,使用“/page/of/target” |
| category_list | array | 可选 | 直播tag细分数据,最少2个,最多10个,支持横滑;第一个tag最好是能代表总体的,比如“全部”,“本月排行”; 第一个tag名称 一定要与下面的item_list有对应关系,eg,tag=本月排行,下面却出现直播人数<1万的,就给人感觉不是真实的排行。 |
| category_list.category_name | string | 必选 | 直播tag细分类名称,比如“全部、职业、美女、大神、决赛圈、…”,字数最多6个,英文字符算1个,中文汉字算1个。 |
| category_list.category_url | string | 必选 | 直播tag细分类对应的链接地址;H5的跳转链接要去掉域名,例如:/games/hzwwqfb/ ;小程序的跳转,使用“/page/of/target”。 |
| item_list | array | 必选 | 直播间数组,最少 3 个 |
| item_list.image | string | 必选 | 直播封面图,图片比例: 364*243; 图片地址必须是https开头。 |
| item_list.title | string | 必选 | 直播间标题,1 行截断,最多展现 13 个字 |
| item_list.audience_num | string | 必选 | 图片右下角直播间观众人数或热度,示例:36万、3784,如果超过万人,单位要使用万,整数。千位及以下显示全部数字。 |
| item_list.url | string | 必选 | 直播间跳转链接;H5的跳转链接要去掉域名,例如:/games/hzwwqfb/ ;小程序的跳转,使用“/page/of/target”。 |
| item_list.anchor_name | string | 必选 | 主播名,1 行截断,最多展现 13 个字 |
注意:
① 卡片展示的直播间为按照直播间观众人数或热度倒序排列的 top n(n≥3)。
② 该卡片时效性要求较高,提交的数据需每 10 分钟更新一次,以保证卡片展示的直播间多数都为在播状态。
举例:从 webhook 返回的 JSON (加密前)
1 | { |