在排行榜中列出玩家得分 (包括) 得分。 立即試用。
要求
HTTP 要求
GET https://www.googleapis.com/games/v1/leaderboards/leaderboardId/window/collection
參數
參數名稱 | 值 | 說明 |
---|---|---|
路徑參數 | ||
collection |
string |
您要求的分數集合。
可接受的值如下:
|
leaderboardId |
string |
排行榜的 ID。 |
必要查詢參數 | ||
timeSpan |
string |
你要求分數和排名的時間範圍。
可接受的值如下:
|
選用查詢參數 | ||
language |
string |
此方法傳回的字串偏好語言。 |
maxResults |
integer |
回應中傳回的排行榜分數上限。無論此回應,傳回的實際排行榜分數可能少於指定的 maxResults 。可接受的值為 1 到 30 (含首尾)。
|
pageToken |
string |
先前要求傳回的符記。 |
resultsAbove |
integer |
要在玩家分數上方指定的偏好分數值。如果球員位於排行榜最下方,可能會傳回更多分數;如果球員位於排行榜最上方,則可能會傳回較少分數。必須小於或等於 maxResults。 |
returnTopIfAbsent |
boolean |
如果玩家不在排行榜中時,應傳回最高分。預設值為 true。 |
授權
此要求需要以下範圍的授權:
範圍 |
---|
https://www.googleapis.com/auth/games |
詳情請參閱驗證和授權頁面。
要求主體
請不要透過此方法提供請求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "games#leaderboardScores", "nextPageToken": string, "prevPageToken": string, "numScores": long, "playerScore": { "kind": "games#leaderboardEntry", "player": players Resource, "scoreRank": long, "formattedScoreRank": string, "scoreValue": long, "formattedScore": string, "timeSpan": string, "writeTimestampMillis": long, "scoreTag": string }, "items": [ { "kind": "games#leaderboardEntry", "player": players Resource, "scoreRank": long, "formattedScoreRank": string, "scoreValue": long, "formattedScore": string, "timeSpan": string, "writeTimestampMillis": long, "scoreTag": string } ] }
屬性名稱 | 值 | 說明 | Notes |
---|---|---|---|
kind |
string |
用於識別這項資源的類型。值一律為固定字串 games#leaderboardScores 。 |
|
nextPageToken |
string |
結果下一頁的分頁憑證。 | |
prevPageToken |
string |
上一頁結果分頁的分頁。 | |
numScores |
long |
排行榜上的分數總數。 | |
playerScore |
nested object |
要求玩家在排行榜上的分數。玩家的分數可能會顯示在此處,以及上方的分數清單中。如果您正在檢視公開排行榜,而玩家並未公開分享遊戲資訊,則不會顯示 scoreRank 和 formattedScoreRank 值。 |
|
playerScore.kind |
string |
用於識別這項資源的類型。值一律為固定字串 games#leaderboardEntry 。 |
|
playerScore.player |
nested object |
具有此分數的玩家。 | |
playerScore.scoreRank |
long |
這個排行榜的分數排名。 | |
playerScore.formattedScoreRank |
string |
此排行榜分數的本地化字串。 | |
playerScore.scoreValue |
long |
這項分數的數值。 | |
playerScore.formattedScore |
string |
此分數數值的本地化字串。 | |
playerScore.timeSpan |
string |
這項分數的時長。 可能的值包括:
可接受的值如下:
|
|
playerScore.writeTimestampMillis |
long |
記錄此分數的時間戳記 (以世界標準時間為單位,以毫秒為單位自 Epoch 紀元時間起算)。 | |
playerScore.scoreTag |
string |
分數的其他資訊。值由 RFC 3986 的第 2.3 部分定為的 最多 64 行 URI 安全字符。 | |
items[] |
list |
排行榜的分數。 | |
items[].kind |
string |
用於識別這項資源的類型。值一律為固定字串 games#leaderboardEntry 。 |
|
items[].player |
nested object |
具有此分數的玩家。 | |
items[].scoreRank |
long |
這個排行榜的分數排名。 | |
items[].formattedScoreRank |
string |
此排行榜分數的本地化字串。 | |
items[].scoreValue |
long |
這項分數的數值。 | |
items[].formattedScore |
string |
此分數數值的本地化字串。 | |
items[].timeSpan |
string |
這項分數的時長。 可能的值包括:
可接受的值如下:
|
|
items[].writeTimestampMillis |
long |
記錄此分數的時間戳記 (以世界標準時間為單位,以毫秒為單位自 Epoch 紀元時間起算)。 | |
items[].scoreTag |
string |
分數的其他資訊。值由 RFC 3986 的第 2.3 部分定為的 最多 64 行 URI 安全字符。 |
試試看!
使用 APIs Explorer 針對即時資料呼叫這個方法,並查看回應。