Scores: listWindow

Liệt kê điểm số trong một bảng xếp hạng xung quanh (và bao gồm) điểm của người chơi. Thử ngay.

Yêu cầu

Yêu cầu HTTP

GET https://www.googleapis.com/games/v1/leaderboards/leaderboardId/window/collection

Các tham số

Tên thông số Giá trị Mô tả
Tham số đường dẫn
collection string Bộ sưu tập điểm số mà bạn đang yêu cầu.

Các giá trị được chấp nhận là:
  • "FRIENDS": Chỉ liệt kê điểm số của bạn bè.
  • "PUBLIC": Liệt kê tất cả điểm số trong bảng xếp hạng công khai.
  • "SOCIAL": (Obsolete) Điểm G trên mạng xã hội cũ. Sử dụng bộ sưu tập BẠN BÈ thay vào đó.
leaderboardId string Mã nhận dạng của bảng xếp hạng.
Tham số truy vấn bắt buộc
timeSpan string Khoảng thời gian tính điểm và xếp hạng mà bạn yêu cầu.

Các giá trị được chấp nhận là:
  • "ALL_TIME": Liệt kê các điểm số cao nhất từ trước đến nay.
  • "DAILY": Liệt kê các điểm số cao nhất cho ngày hiện tại.
  • "WEEKLY": Liệt kê các điểm số cao nhất trong tuần hiện tại.
Tham số truy vấn không bắt buộc
language string Ngôn ngữ ưu tiên để sử dụng cho các chuỗi được phương thức này trả về.
maxResults integer Số điểm tối đa của bảng xếp hạng cần trả về trong phản hồi. Đối với bất kỳ câu trả lời nào, số điểm thực tế của bảng xếp hạng có thể thấp hơn maxResults đã chỉ định. Giá trị được chấp nhận là từ 1 đến 30, bao gồm cả hai giá trị này.
pageToken string Mã thông báo được yêu cầu trước đó trả về.
resultsAbove integer Số điểm ưu tiên để trả về trên điểm của người chơi. Có thể trả về nhiều điểm hơn nếu người chơi ở cuối bảng xếp hạng; số điểm ít hơn có thể được trả về nếu người chơi ở vị trí hàng đầu. Phải nhỏ hơn hoặc bằng maxResult.
returnTopIfAbsent boolean Đúng nếu phải trả về điểm số cao nhất khi người chơi không có trong bảng xếp hạng. Giá trị mặc định là đúng.

Ủy quyền

Yêu cầu này cần được cho phép với phạm vi sau:

Phạm vi
https://www.googleapis.com/auth/games

Để biết thêm thông tin, hãy xem trang xác thực và uỷ quyền.

Nội dung yêu cầu

Đừng cung cấp nội dung yêu cầu bằng phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về nội dung phản hồi với cấu trúc sau:

{
  "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
    }
  ]
}
Tên tài sản Giá trị Mô tả Ghi chú
kind string Xác định duy nhất loại tài nguyên này. Giá trị luôn là chuỗi cố định games#leaderboardScores.
nextPageToken string Mã thông báo phân trang cho trang kết quả tiếp theo.
prevPageToken string Mã thông báo phân trang cho trang kết quả trước đó.
numScores long Tổng số điểm trong bảng xếp hạng.
playerScore nested object Điểm của người chơi yêu cầu trên bảng xếp hạng. Điểm của người chơi có thể xuất hiện cả ở đây và trong danh sách điểm số ở trên. Nếu bạn đang xem bảng xếp hạng công khai và người chơi không chia sẻ công khai thông tin về lối chơi của họ, thì giá trị scoreRankformattedScoreRank sẽ không xuất hiện.
playerScore.kind string Xác định duy nhất loại tài nguyên này. Giá trị luôn là chuỗi cố định games#leaderboardEntry.
playerScore.player nested object Người chơi đang giữ điểm số này.
playerScore.scoreRank long Thứ hạng của điểm số này trên bảng xếp hạng này.
playerScore.formattedScoreRank string Chuỗi đã được bản địa hoá cho thứ hạng của điểm số này cho bảng xếp hạng này.
playerScore.scoreValue long Giá trị số của điểm số này.
playerScore.formattedScore string Chuỗi đã được bản địa hoá cho giá trị số của điểm số này.
playerScore.timeSpan string Khoảng thời gian của điểm số cao này.
Các giá trị có thể là:
  • "ALL_TIME" – Điểm số cao nhất từ trước đến nay.
  • "WEEKLY" – Điểm số là điểm số cao nhất hằng tuần.
  • "DAILY" – Điểm số là điểm cao hằng ngày.


Các giá trị được chấp nhận là:
  • "ALL_TIME"
  • "DAILY"
  • "WEEKLY"
playerScore.writeTimestampMillis long Dấu thời gian mà điểm số này được ghi lại, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống theo giờ UTC.
playerScore.scoreTag string Thông tin bổ sung về điểm số. Các giá trị không được chứa nhiều hơn 64 ký tự an toàn với URI như đã định nghĩa trong mục 2.3 của RFC 3986.
items[] list Điểm số trong bảng xếp hạng.
items[].kind string Xác định duy nhất loại tài nguyên này. Giá trị luôn là chuỗi cố định games#leaderboardEntry.
items[].player nested object Người chơi đang giữ điểm số này.
items[].scoreRank long Thứ hạng của điểm số này trên bảng xếp hạng này.
items[].formattedScoreRank string Chuỗi đã được bản địa hoá cho thứ hạng của điểm số này cho bảng xếp hạng này.
items[].scoreValue long Giá trị số của điểm số này.
items[].formattedScore string Chuỗi đã được bản địa hoá cho giá trị số của điểm số này.
items[].timeSpan string Khoảng thời gian của điểm số cao này.
Các giá trị có thể là:
  • "ALL_TIME" – Điểm số cao nhất từ trước đến nay.
  • "WEEKLY" – Điểm số là điểm số cao nhất hằng tuần.
  • "DAILY" – Điểm số là điểm cao hằng ngày.


Các giá trị được chấp nhận là:
  • "ALL_TIME"
  • "DAILY"
  • "WEEKLY"
items[].writeTimestampMillis long Dấu thời gian mà điểm số này được ghi lại, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống theo giờ UTC.
items[].scoreTag string Thông tin bổ sung về điểm số. Các giá trị không được chứa nhiều hơn 64 ký tự an toàn với URI như đã định nghĩa trong mục 2.3 của RFC 3986.

Hãy dùng thử!

Hãy dùng API Explorer bên dưới để gọi phương thức này trên dữ liệu trực tiếp và xem phản hồi.