获取当前已通过身份验证的玩家在排行榜中的高分以及(可选)排名。对于特定时间跨度,leaderboardId
可设为 ALL
以检索给定时间跨度内所有排行榜的数据。注意:你不能在同一请求中同时请求“ALL”排行榜和“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 |
检索好友群组中的排名。 |