获取抖音视频排行榜

我的收藏

一、能力概况

开发者可使用此能力，在自己的小游戏内获取公开视频的排行榜信息，在分享视频时可以通过添加 videoTag，用于筛选指定视频的排行榜信息。

排行榜时效性说明：发布时间范围在一个月以内的视频信息每一个小时到两个小时更新一次；

发布时间范围在一个月到三个月的的视频信息每六小时更新一次；

发布时间范围在三个月到一年之内的的视频信息每一周更新一次。

二、最热最新榜单示例

拉取当前游戏的最新和最热的视频，在游戏中进行展示

三、榜单标签功能示例

标签功能可供开发者筛选自己标记的视频，将自己打了标记的视频，定向拉取下来进行展示，从而实现诸如万圣节视频榜单之类的游戏活动

四、接入方法

分享视频

开发者要使用获取抖音视频排行榜功能，需要在 tt.shareAppMessage 中将 extra.withVideoId 传为 true。

videoTag 字段需要基础库 1.83+支持。videoId 在tt.shareAppMessage的 success 中获取，开发者可以在分享的 extra 里面加入 videoTag 字段，后续可以用这个字段筛选想要的视频排行榜信息。需要传入 withVideoId 才能在后续接口中获取抖音视频信息。

tt.shareAppMessage({
  channel: "video",
  title: "测试分享视频",
  desc: "测试描述",
  extra: {
    videoPath: "/common/videotest.mp4", // 视频地址
    withVideoId: true, // 设置withVideoID为true才能在success中获取videoId
    videoTag: "testTag1", //这里添加VideoTag用于筛选
  },
  success(res) {
    tt.showToast({
      title: "分享成功",
    })
    videoId = res.videoId
    console.log(videoId)
  },
  fail(e) {
    tt.showToast({
      title: "分享失败",
    })
    console.log(e)
  },
})

获取分享后的视频排行榜

说明：获取视频分享后的排行榜

请求地址

// 该地址返回按照点赞数递减排列的结果
 POST https://gate.snssdk.com/developer/api/get_top_video_ids_by_like
 // 该地址返回按照发布时间最新排列在前的结果
 POST https://gate.snssdk.com/developer/api/get_top_video_ids_by_time

请求示例

tt.request({
  url: "https://gate.snssdk.com/developer/api/get_top_video_ids_by_time",
  method: "POST",
  data: {
    app_id: "your AppId",
    number_of_top: 100,
    tag: "testTag1", //分享视频时传入videoTag情况下，用于筛选指定tag视频
    access_token: "your access_token",
    rank_type: "month", //只有  get_top_video_ids_by_like 接口支持
  },
  success: (res) => {
    console.log("排行榜信息")
    console.log(res)
    // 从res中获取所需视频信息（videoId数组索引与返回数据数组索引一一对应）
  },
})

请求参数

名称	数据类型	是否必填	描述
app_id	string	是	小游戏的 AppID
number_of_top	number	是	取值最小为 1，最大为 100，如果当前小游戏 appID 下的视频不足用户想要获取的数量，则按正常数量返回
tag	string	否	视频标记 tag，仅支持全英文和数字文
access_token	string	是	小游戏开发者的 token，用于鉴权，通过getAccessToken方法获取
rank_type	string	否	获取视频榜单获取周榜或月榜。支持填写 month（月排行）或者 week（˙ 周排行），目前只有点赞接口（get_top_video_ids_by_like）支持该字段。

返回值

名称	数据类型	描述
err_no	number	状态码：0 表示正常返回，其他为失败
message	string	状态信息：success 表示成功，其他为失败的报错信息
data	Array[Object]	排行榜信息

err_no 和 message 说明

err_no	message	说明
0	success	正常返回
-1	请求的数量不能小于 1	请求数量小于 1 导致获取排行榜失败
-16000	params missing	分享时未获取到 videoID，导致获取排行榜失败
-15003	authentication fail	用户的 access_token 无效，导致获取排行榜失败
1	KE.KITE/2 - Remote or network err/119: Internal error processing GetTopVideoIDsByLike: KE.UNREGISTERED/0 - ?/0: tag 排行榜未找到!	该 tag 指定的排行榜不存在
其他	其他	请求失败

data 对象说明

名称	数据类型	描述
video_id	string	视频 id
digg_count	string	点赞数
cover_url	string	视频封面图链接地址
source	number	宿主端标识符，1128(抖音)，1112（抖音火山），13（头条）
user_name	string	作者昵称
rank	number	视频排行榜排名，从 1 开始累加
video_tag	string	视频的 videoTag 值

五、Bug & Tip

Tip：分享视频时添加的 videoTag 字段是可选的，仅支持全英文。
Tip：正式环境访问时，请求地址需要配置白名单。
Tip：使用此功能要确保分享时 withVideoId 标志为 true
Tip：请求带有 Tag 标签的排行榜时，需要确保分享时候带上 videoTag ，以及分享客户端基础库版本支持 videoTag 字段。

下一篇：常见问题