Method: scores.get

在当前已经过身份验证的玩家的排行榜中取得高分,并视需要争取相应的排名。对于特定时间范围,可将 leaderboardId 设置为 ALL,以检索给定时间范围内所有排行榜的数据。注意:您不能在同一请求中请求“ALL”排行榜和“ALL” timeSpan;只能将一个参数设置为“ALL”。

HTTP 请求

GET https://games.googleapis.com/games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}

路径参数

参数
playerId

string

玩家 ID。可以使用值 me 来代替经过身份验证的玩家的 ID。

leaderboardId

string

排行榜的 ID。可设置为“ALL”以检索此应用的所有排行榜的数据。

timeSpan

enum (ScoreTimeSpan)

您请求的得分和排名的时间跨度。

查询参数

参数
language

string

此方法返回的字符串使用的首选语言。

includeRankType

enum (IncludeRankType)

要返回的排名类型。如果省略该参数,则不会返回任何排名。

maxResults

integer

响应中要返回的排行榜得分数量上限。对于任何响应,返回的实际排行榜得分可能小于指定的 maxResults

pageToken

string

上一个请求返回的令牌。

请求正文

请求正文必须为空。

响应正文

如果成功,则响应正文包含一个 GetLeaderboardScoresResponse 实例。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

有关详情,请参阅 OAuth 2.0 概览

ScoreTimeSpan

定义得分的可能时间范围。

枚举
ALL 获得所有时间段的高分。如果使用此参数,系统将忽略 maxResults 值。
ALL_TIME 获得历史最高得分。
WEEKLY 列出当天的最高分数。
DAILY 列出本周最高分数。

IncludeRankType

排名类型的可能值。

枚举
ALL 检索所有支持的排名。在 HTTP 中,此参数值也可以指定为 ALL
PUBLIC 如果玩家公开分享了自己的游戏活动,则检索公开排名。
SOCIAL

(过时)检索社交排名。

FRIENDS 检索在好友集合中的排名。