API Reference

Tài liệu tham khảo API này được sắp xếp theo loại tài nguyên. Mỗi loại tài nguyên có một hoặc nhiều bản trình bày dữ liệu và một hoặc nhiều phương thức.

Loại tài nguyên

  1. Định nghĩa thành tích
  2. Thành tích
  3. Ứng dụng
  4. Sự kiện
  5. Bảng xếp hạng
  6. Metagame
  7. Người chơi
  8. Pushtoken
  9. Bản sửa đổi
  10. Phòng
  11. Điểm số
  12. Ảnh chụp nhanh
  13. Số liệu thống kê
  14. TurnBasedMatch

Định nghĩa thành tích

Để biết thêm thông tin về tài nguyên AchievementDefinitions, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
list GET  /achievements Liệt kê tất cả định nghĩa thành tích cho ứng dụng của bạn.

Thành tích

Để biết thêm thông tin về tài nguyên Thành tích, hãy xem trang trình bày tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tăng dần POST  /achievements/achievementId/increment Tăng số bước của thành tích với ID đã cho cho người chơi hiện được xác thực.

Các tham số truy vấn bắt buộc: stepsToIncrement

list GET  /players/playerId/achievements Liệt kê tiến trình của tất cả thành tích trong ứng dụng của bạn cho người chơi hiện được xác thực.
hiển thị POST  /achievements/achievementId/reveal Đặt trạng thái của thành tích với mã nhận dạng đã cho thành REVEALED cho người chơi hiện được xác thực.
setStepAtLeast POST  /achievements/achievementId/setStepsAtLeast Đặt các bước cho người chơi hiện được xác thực để mở khóa thành tích. Nếu thông số bước ít hơn số bước hiện tại mà người chơi đã đạt được, thì thành tích sẽ không được sửa đổi.

Các tham số truy vấn bắt buộc: steps

mở khoá POST  /achievements/achievementId/unlock Mở khóa thành tích này cho người chơi hiện đã được xác thực.
updateMultiple POST  /achievements/updateMultiple Cập nhật nhiều thành tích cho người chơi hiện được xác thực.

Ứng dụng

Để biết thông tin chi tiết về Tài nguyên ứng dụng, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tải GET  /applications/applicationId Truy xuất siêu dữ liệu của ứng dụng bằng ID đã cho. Nếu ứng dụng đã yêu cầu không có sẵn cho platformType được chỉ định, thì phản hồi được trả về sẽ không bao gồm bất kỳ dữ liệu thực thể nào.
đã phát POST  /applications/played Cho biết người dùng hiện đã xác thực đang phát ứng dụng của bạn.
xác minh GET  /applications/applicationId/verify Xác minh mã thông báo xác thực được cung cấp cùng với yêu cầu này là dành cho ứng dụng có mã nhận dạng được chỉ định và trả về mã nhận dạng của người chơi được cấp quyền.

Sự kiện

Để biết thông tin chi tiết về Tài nguyên sự kiện, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
listByPlayer GET  /events Trả về danh sách hiển thị tiến trình hiện tại trên các sự kiện trong ứng dụng này cho người dùng hiện được xác thực.
listĐịnh nghĩa GET  /eventDefinitions Trả về danh sách các định nghĩa sự kiện trong ứng dụng này.
ghi POST  /events Ghi lại một loạt các thay đổi đối với số lần sự kiện đã xảy ra cho người dùng hiện đã được xác thực của ứng dụng này.

Bảng xếp hạng

Để biết thông tin chi tiết về Tài nguyên bảng xếp hạng, vui lòng xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tải GET  /leaderboards/leaderboardId Truy xuất siêu dữ liệu của bảng xếp hạng với ID đã cho.
list GET  /leaderboards Liệt kê tất cả siêu dữ liệu của bảng xếp hạng cho ứng dụng của bạn.

Siêu trò chơi

Để biết thông tin chi tiết về Tài nguyên Metagame, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
getMetagameConfig GET  /metagameConfig Trả về dữ liệu cấu hình metagame cho ứng dụng gọi.
listCategoryByPlayer GET  /players/playerId/categories/collection Liệt kê dữ liệu chơi tổng hợp theo danh mục cho người chơi tương ứng với playerId.

Người chơi

Để biết thông tin chi tiết về Tài nguyên dành cho người chơi, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tải GET  /players/playerId Truy xuất tài nguyên trên Player bằng mã nhận dạng đã cung cấp. Để truy xuất trình phát cho người dùng hiện đã được xác thực, hãy đặt playerId thành me.
list GET  /players/me/players/collection Lấy tập hợp người chơi cho người dùng hiện đã được xác thực.

Xe đẩy

Để biết thông tin chi tiết về Tài nguyên Pushtokens, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
xoá POST  /pushtokens/remove Xóa mã thông báo đẩy cho người dùng và ứng dụng hiện tại. Việc xoá một mã thông báo đẩy không tồn tại sẽ báo cáo thành công.
cập nhật PUT  /pushtokens Đăng ký một mã thông báo đẩy cho người dùng và ứng dụng hiện tại.

Bản sửa đổi

Để biết thông tin chi tiết về Tài nguyên sửa đổi, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
kiểm tra GET  /revisions/check Kiểm tra xem ứng dụng trò chơi đã cập nhật hay chưa.

Các tham số truy vấn bắt buộc: clientRevision

Rooms

Để biết thông tin chi tiết về Tài nguyên phòng, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tạo POST  /rooms/create Tạo một phòng. Chỉ dành cho mục đích sử dụng nội bộ của SDK trò chơi. Phương thức gọi trực tiếp này không được hỗ trợ.
từ chối POST  /rooms/roomId/decline Từ chối lời mời tham gia một phòng. Chỉ dành cho mục đích sử dụng nội bộ của SDK trò chơi. Phương thức gọi trực tiếp này không được hỗ trợ.
loại bỏ POST  /rooms/roomId/dismiss Đóng lời mời tham gia một phòng. Chỉ dành cho mục đích sử dụng nội bộ của SDK trò chơi. Phương thức gọi trực tiếp này không được hỗ trợ.
tải GET  /rooms/roomId Lấy dữ liệu của một phòng.
tham gia POST  /rooms/roomId/join Tham gia một phòng. Chỉ dành cho mục đích sử dụng nội bộ của SDK trò chơi. Phương thức gọi trực tiếp này không được hỗ trợ.
rời khỏi POST  /rooms/roomId/leave Rời khỏi phòng. Chỉ dành cho mục đích sử dụng nội bộ của SDK trò chơi. Phương thức gọi trực tiếp này không được hỗ trợ.
list GET  /rooms Trả về lời mời tham gia phòng.
reportStatus POST  /rooms/roomId/reportstatus Nội dung cập nhật do khách hàng gửi để báo cáo trạng thái của các ứng dụng ngang hàng trong một phòng. Chỉ dành cho mục đích sử dụng nội bộ của SDK trò chơi. Phương thức gọi trực tiếp này không được hỗ trợ.

Tỷ số

Để biết thông tin chi tiết về Tài nguyên điểm, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tải GET  /players/playerId/leaderboards/leaderboardId/scores/timeSpan Nhận điểm cao và xếp hạng tùy chọn, trong bảng xếp hạng cho người chơi hiện được xác thực. Trong một khoảng thời gian cụ thể, bạn có thể đặt leaderboardId thành ALL để truy xuất dữ liệu cho tất cả các bảng xếp hạng trong một khoảng thời gian nhất định.
LƯU Ý: Bạn không thể yêu cầu bảng xếp hạng "ALL" và "ALL" trong cùng một yêu cầu; chỉ có thể đặt một tham số thành "ALL".
list GET  /leaderboards/leaderboardId/scores/collection Liệt kê điểm số trong một bảng xếp hạng, bắt đầu từ trên xuống.

Các tham số truy vấn bắt buộc: timeSpan

listWindow GET  /leaderboards/leaderboardId/window/collection 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.

Các tham số truy vấn bắt buộc: timeSpan

gửi POST  /leaderboards/leaderboardId/scores Gửi điểm số đến bảng xếp hạng được chỉ định.

Các tham số truy vấn bắt buộc: score

gửi nhiều POST  /leaderboards/scores Gửi nhiều điểm số lên bảng xếp hạng.

Tổng quan nhanh

Để biết thông tin chi tiết về Tài nguyên ảnh chụp nhanh, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tải GET  /snapshots/snapshotId Truy xuất siêu dữ liệu cho một ID ảnh chụp nhanh nhất định.
list GET  /players/playerId/snapshots Truy xuất danh sách ảnh chụp nhanh do ứng dụng của bạn tạo cho trình phát tương ứng với mã nhận dạng người chơi.

Số liệu thống kê

Để biết thông tin chi tiết về Tài nguyên thống kê, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
tải GET  /stats Trả về số liệu thống kê mức chi tiêu và tương tác trong ứng dụng này cho người dùng hiện đã được xác thực.

Dựa trên lượt chơi

Để biết thông tin chi tiết về tài nguyên TurnBasedMatch, hãy xem trang đại diện tài nguyên.

Phương thức Yêu cầu HTTP Mô tả
URI liên quan đến https://www.googleapis.com/games/v1, trừ trường hợp có lưu ý khác
huỷ PUT  /turnbasedmatches/matchId/cancel Huỷ một trận đấu theo lượt.
tạo POST  /turnbasedmatches/create Tạo một trận đấu theo lượt.
từ chối PUT  /turnbasedmatches/matchId/decline Từ chối lời mời chơi một trận đấu theo lượt.
loại bỏ PUT  /turnbasedmatches/matchId/dismiss Loại bỏ trận đấu theo lượt khỏi danh sách trận đấu. Kết quả phù hợp sẽ không xuất hiện trong danh sách nữa và sẽ không tạo thông báo.
hoàn tất PUT  /turnbasedmatches/matchId/finish Hoàn thành một trận đấu theo lượt. Mỗi người chơi nên thực hiện lệnh gọi này một lần sau khi đã có tất cả kết quả. Chỉ người chơi có lượt chơi mới có thể thực hiện lệnh gọi đầu tiên để Kết thúc và có thể chuyển sang trạng thái khớp cuối cùng.
tải GET  /turnbasedmatches/matchId Lấy dữ liệu của trận đấu theo lượt.
tham gia PUT  /turnbasedmatches/matchId/join Hãy tham gia trận đấu theo lượt.
rời khỏi PUT  /turnbasedmatches/matchId/leave Rời khỏi trận đấu theo lượt khi đến lượt của người chơi hiện tại mà không hủy trận đấu.
bảo lãnh PUT  /turnbasedmatches/matchId/leaveTurn Rời khỏi một trận đấu theo lượt trong lượt của người chơi hiện tại mà không cần huỷ trận đấu.

Các tham số truy vấn bắt buộc: matchVersion

list GET  /turnbasedmatches Trả về kết quả trùng khớp theo lượt mà người chơi đã hoặc đang tham gia.
tái đấu POST  /turnbasedmatches/matchId/rematch Tạo ra một trận đấu lại đã hoàn thành trước đó, với cùng một người tham gia. Chỉ một người chơi có thể gọi phương thức này trong một trận đấu vẫn còn trong danh sách; người chơi phải gọi xong trước tiên. Trả về kết quả trùng khớp mới tạo; đây sẽ là lượt của người gọi.
đồng bộ hoá GET  /turnbasedmatches/sync Trả về kết quả trùng khớp theo lượt chơi mà người chơi đã hoặc đang tham gia thay đổi kể từ lệnh gọi đồng bộ hoá gần nhất, với những thay đổi ít gần đây nhất sẽ diễn ra trước. Các kết quả trùng khớp sẽ bị xóa khỏi bộ nhớ đệm cục bộ sẽ có trạng thái là MATCH_DELETED.
tham gia PUT  /turnbasedmatches/matchId/turn Cam kết kết quả của lượt chơi của người chơi.