最近更新时间:2023.11.21 14:58:44
首次发布时间:2023.11.21 14:58:44
本接口主要用于有搜索场景需求的客户,通过搜索词查询相关内容,目前支持搜索的内容体裁包括图文、横版短视频、竖版小视频。
若不指定返回条数count,则默认每次最多返回10条内容。返回的内容信息包括标题、封面图、发布时间、视频时长、作者名称与头像等,客户侧可使用这些数据,自定义实现搜索页UI。
请求方法
GET(Content-Type: application/x-www-form-urlencoded)
请求url
https://mercury.volcengineapi.com/?Action=SearchV2&Version=2021-01-01
请求header
ServiceName:content
参数 | 描述 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
Partner | 渠道号 | String | 是 | |
AccessToken | 用户唯一标识 | String | 是 | |
Keyword | 搜索字符串 | String | 是 | |
Offset | 分页起始 | int | 否 | 默认为0,用于翻页,当HasMore为true时,Offset=当前偏移量+Count |
Count | 每页数量 | int | 否 | 指定返回数据条数,最大不超过20,默认返回10条。 |
SearchId | 搜索ID | String | 否 | 客户侧搜索id,代表本次搜索的唯一ID |
Dt | 设备型号 | String | 否 | 如iphone5s、Galaxy。主要用于推荐分析,提升推荐效果 |
DeviceBrand | 设备厂商 | String | 否 | 如Apple、Samsung。主要用于推荐分析,提升推荐效果 |
Os | 操作系统 | String | 是 | 如 Android、IOS。主要用于推荐分析,提升推荐效果。注意:IOS系统如果没有正确传入此参数,返回的封面图可能为webp格式,导致图片解析失败。 |
OsVersion | 操作系统版本 | String | 否 | 如4.0.4。主要用于推荐分析,提升推荐效果。火山引擎侧内容详情页会根据此参数进行适配。 |
ClientVersion | 应用的版本号 | String | 是 | 比如1.0.1。主要用于数据排查,提升业务指标 |
参数 | 描述 | 类型 | 说明 |
---|---|---|---|
Result | 内容列表 | List<Result> | 搜索内容列表 |
public static void main(String[] args) { SearchService searchService = SearchServiceImpl.getInstance(); searchService.setAccessKey("ak"); searchService.setSecretKey("sk"); searchService.SetNeedMonitor(true); SearchRequest request = new SearchRequest(); request.setPartner("partner"); request.setAccessToken("accesstoken"); request.setKeyword("美食"); request.setNeedVideoDetail("1"); request.setOffset(0); request.setCount(10); try { SearchGroupResponseV2 response = searchService.searchGroupV2(request); System.out.println(JSON.toJSONString(response)); } catch (Exception e) { e.printStackTrace(); } }
{ "ResponseMetadata": { "RequestId": "20231116114828E802AEC4E763C142CB43", "Action": "SearchV2", "Version": "2021-01-01", "Service": "content", "Region": "cn-beijing", "Error": { "CodeN": 0, "Code": "", "Message": "" } }, "Result": { "SearchId": "ee9c257aea521c430ab6db9adaada5a9", "HasMore": true, "Data": [ { "Abstract": "", "ArticleType": "短视频", "ArticleUrl": "https://open.toutiao.com/a7280303591146193463/?***", "CommentUrl": "https://open.toutiao.com/a7280303591146193463/comment/?***", "CoverImages": [ { "Url": "https://p3-open-sign.onewsimg.com/***", "Height": 1080, "Width": 1920 } ], "CoverMode": 1, "DiggCount": 2, "GroupId": "7280303591146193463", "HasVideo": true, "PublishTime": 1695077771, "ShareUrl": "https://open.toutiao.com/a7280303591146193463/?***", "Title": "《健康》节目现场花絮", "UserInfo": { "AvatarUrl": "https://p6-open-sign.onewsimg.com/***", "Description": "", "Follow": false, "FollowerCount": 2354, "HomePage": "https://open.toutiao.com/u2307191414457355/?***", "Name": "月色江声神采张扬", "UserId": 2307191414457355, "UserVerified": false, "VerifiedContent": "" }, "VideoWatchCount": 203, "VideoDetail": { "VideoDuration": 24.637, "VideoList": [ { "Url": "http://open.toutiao.com/video/url/v1/?***", "Height": 720, "Width": 1280, "Definition": "720p" } ] } } ] } }