获取当前已通过身份验证的玩家在排行榜中的最高得分和排名(可选)。对于特定时间跨度,可以将 leaderboardId
设置为 ALL
,以检索给定时间跨度内所有排行榜的数据。`注意:您不能在同一请求中请求“所有”排行榜和“所有”时间跨度;只能将一个参数设置为“所有”。
HTTP 请求
GET https://games.googleapis.com/games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}
路径参数
参数 | |
---|---|
playerId |
玩家 ID。可以使用值 |
leaderboardId |
排行榜的 ID。可设置为“ALL”,以检索此应用的所有排行榜的数据。 |
timeSpan |
您请求的得分和排名所涵盖的时间范围。 |
查询参数
参数 | |
---|---|
language |
此方法返回的字符串的首选语言。 |
includeRankType |
要返回的排名类型。如果省略此参数,则不会返回任何排名。 |
maxResults |
响应中可返回的排行榜得分数量上限。对于任何响应,返回的排行榜得分实际数量可能少于指定的 |
pageToken |
上一个请求返回的令牌。 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含一个 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 |
检索好友集合的排名。 |