本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法，以及一或多種方法。
資源類型
AchievementDefinitions
如要進一步瞭解 AchievementDefinitions 資源，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| 清單 |
GET /achievements
|
列出應用程式的所有成就定義。 |
成就
如要進一步瞭解成就資源，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| 增量 |
POST /achievements/achievementId/increment
|
使用目前驗證玩家的指定 ID 增加成就的步驟。
必要查詢參數： |
| 清單 |
GET /players/playerId/achievements
|
列出目前已驗證玩家在應用程式中的所有成就的進度。 |
| 揭露 |
POST /achievements/achievementId/reveal
|
針對目前已驗證的玩家，將具有指定 ID 的成就的狀態設為 REVEALED。 |
| setStepsAtLeast |
POST /achievements/achievementId/setStepsAtLeast
|
設定目前驗證的玩家解鎖關卡的步驟。如果步數參數小於玩家目前針對成就取得的步數，就不會修改成就。
必要查詢參數： |
| 解鎖 |
POST /achievements/achievementId/unlock
|
為目前已驗證的玩家解鎖這個成就。 |
| updateMultiple |
POST /achievements/updateMultiple
|
針對目前已驗證的玩家更新多個成就。 |
應用程式
如需應用程式資源的詳細資料，請參閱資源表示法。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| get |
GET /applications/applicationId
|
使用指定 ID 擷取應用程式的中繼資料。如果指定的應用程式無法使用指定的 platformType，則傳回的回應中不會包含任何執行個體資料。 |
| 已播放 |
POST /applications/played
|
表示目前驗證的使用者正在播放您的應用程式。 |
| 驗證 |
GET /applications/applicationId/verify
|
驗證此要求提供的驗證權杖適用於指定 ID 的應用程式，並傳回其所授權玩家的 ID。 |
事件
如需活動資源詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| listByPlayer |
GET /events
|
傳回此清單，針對目前驗證的使用者，顯示此應用程式中事件目前的進度。 |
| listDefinitions |
GET /eventDefinitions
|
傳回此應用程式的事件定義清單。 |
| 記錄 |
POST /events
|
針對此應用程式目前通過驗證的使用者，記錄大量事件的發生次數。 |
排行榜
如要進一步瞭解排行榜資源，請參閱資源表示法。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| get |
GET /leaderboards/leaderboardId
|
擷取具有指定 ID 的排行榜中繼資料。 |
| 清單 |
GET /leaderboards
|
列出應用程式的所有排行榜中繼資料。 |
Metagame
如需 Metagame 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| getMetagameConfig |
GET /metagameConfig
|
傳回呼叫應用程式的中繼遊戲設定資料。 |
| listCategoriesByPlayer |
GET /players/playerId/categories/collection
|
列出對應於 playerId 的玩家類別的各類別遊戲資料。
|
玩家
如需玩家資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| get |
GET /players/playerId
|
擷取具有指定 ID 的 Player 資源。如要擷取目前已驗證使用者的玩家，請將 playerId 設為 me。 |
| 清單 |
GET /players/me/players/collection
|
取得目前已驗證使用者的玩家集合。 |
Pushtoken
如需 Pushtokens 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| 移除 |
POST /pushtokens/remove
|
移除目前使用者和應用程式的推送憑證。移除不存在的推送憑證將回報成功。 |
| update |
PUT /pushtokens
|
註冊目前使用者和應用程式的推送憑證。 |
修訂版本
如需修訂版本資源的詳細資料，請參閱資源表示法頁面。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| 勾選 |
GET /revisions/check
|
檢查遊戲用戶端是否過時。
必要查詢參數： |
會議室
如需 Room 資源的詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| create |
POST /rooms/create
|
建立聊天室。僅供遊戲 SDK 進行內部使用。不支援直接呼叫此方法。 |
| 拒絕 |
POST /rooms/roomId/decline
|
拒絕加入聊天室的邀請。僅供遊戲 SDK 進行內部使用。不支援直接呼叫此方法。 |
| 關閉 |
POST /rooms/roomId/dismiss
|
關閉加入聊天室的邀請。僅供遊戲 SDK 進行內部使用。不支援直接呼叫此方法。 |
| get |
GET /rooms/roomId
|
取得聊天室的資料。 |
| 彙整 |
POST /rooms/roomId/join
|
加入聊天室。僅供遊戲 SDK 進行內部使用。不支援直接呼叫此方法。 |
| 留下 |
POST /rooms/roomId/leave
|
離開聊天室。僅供遊戲 SDK 進行內部使用。不支援直接呼叫此方法。 |
| 清單 |
GET /rooms
|
傳回加入聊天室的邀請。 |
| reportStatus |
POST /rooms/roomId/reportstatus
|
客戶回報聊天室中同類應用程式的更新。僅供遊戲 SDK 進行內部使用。不支援直接呼叫此方法。 |
分數
如需分數資源詳細資料，請參閱資源表示法頁面。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| get |
GET /players/playerId/leaderboards/leaderboardId/scores/timeSpan
|
在目前驗證玩家的排行榜中取得最高分和排名。您可以將特定時間範圍內的 leaderboardId 設為 ALL，以擷取特定時間範圍內所有排行榜的資料。注意：您無法在同一個請求中請求「ALL」排行榜和「ALL」timeSpans；只能有一個參數設為「ALL」。 |
| 清單 |
GET /leaderboards/leaderboardId/scores/collection
|
從頂端開始列出排行榜的分數。
必要查詢參數： |
| listWindow |
GET /leaderboards/leaderboardId/window/collection
|
在排行榜中列出玩家得分 (包括) 得分。
必要查詢參數： |
| 提交 |
POST /leaderboards/leaderboardId/scores
|
將分數提交到指定的排行榜。
必要查詢參數： |
| submitMultiple 屬性 |
POST /leaderboards/scores
|
提交多個排行榜分數。 |
快照
如需快照資源的詳細資料，請參閱資源表示法頁面。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| get |
GET /snapshots/snapshotId
|
擷取指定快照 ID 的中繼資料。 |
| 清單 |
GET /players/playerId/snapshots
|
擷取您的應用程式針對玩家 ID 所對應的播放器建立快照清單。 |
統計資料
如要進一步瞭解「統計資料資源」，請參閱資源表示法。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| get |
GET /stats
|
傳回此應用程式中目前已驗證使用者的參與度和支出統計資料。 |
Turn-Match
如需 TurnBasedMatch 資源詳細資料，請參閱資源表示法網頁。
| 方法 | HTTP 要求 | 說明 |
|---|---|---|
| 相對於 https://www.googleapis.com/games/v1 的 URI，除非另有說明 | ||
| 取消 |
PUT /turnbasedmatches/matchId/cancel
|
取消回合製比對。 |
| create |
POST /turnbasedmatches/create
|
建立回合製比對。 |
| 拒絕 |
PUT /turnbasedmatches/matchId/decline
|
拒絕加入回合製的邀請。 |
| 關閉 |
PUT /turnbasedmatches/matchId/dismiss
|
關閉比對清單中的回合製比對。此項目不會再顯示於清單中，也不會產生通知。 |
| 完成 |
PUT /turnbasedmatches/matchId/finish
|
完成回合製比對。所有結果均打開後，每位玩家都要發出一次呼叫。只有會輪流的玩家才能呼叫 Finish，並且可以進入最終比賽狀態。 |
| get |
GET /turnbasedmatches/matchId
|
取得回合製比對資料。 |
| 彙整 |
PUT /turnbasedmatches/matchId/join
|
加入回合製比對。 |
| 留下 |
PUT /turnbasedmatches/matchId/leave
|
在非目前輪流下轉輪時，回合輪數比對，不會取消配對。 |
| turnturn |
PUT /turnbasedmatches/matchId/leaveTurn
|
在目前玩家輪流轉出時，輪流完成回合比對，而不取消配對。
必要查詢參數： |
| 清單 |
GET /turnbasedmatches
|
傳回回合製球員參與或回合製的比賽。 |
| 重新比對 |
POST /turnbasedmatches/matchId/rematch
|
將先前完成的相符項目重新配對，並使用相同的參與者。但只能由玩家在清單中符合比對條件的玩家呼叫；玩家必須先呼叫 Finish。傳回新建立的相符項目，其為來電者的轉彎。 |
| sync |
GET /turnbasedmatches/sync
|
傳回自上次同步呼叫以來，參與或參與該回合製的回合比對，且最近的變更最少。需要從本機快取中移除的相符項目會處於 MATCH_DELETED 的狀態。
|
| taketurn |
PUT /turnbasedmatches/matchId/turn
|
修訂玩家輪轉結果。 |