获取排行榜中当前已认证玩家的高分,以及可选排名。对于特定时间段,leaderboardId
可以设置为 ALL
以检索给定时间段内所有排行榜的数据。`注意:您不能在同一请求中同时请求“所有”排行榜和“所有”时间段;只能将一个参数设置为“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 |
检索朋友列表中的排名。 |