Google Play Games Services API

開發人員可透過 Google Play 遊戲服務,在遊戲中加入社交排行榜、成就、遊戲狀態、使用 Google 帳戶登入等功能。

服務:games.googleapis.com

如要呼叫這項服務,建議您使用 Google 提供的用戶端程式庫。如果您的應用程式需要使用自己的程式庫呼叫這項服務,請在發出 API 要求時使用下列資訊。

導覽文件

探索文件是一種機器可解讀的規格,用於說明和使用 REST API。此文件用於建構用戶端程式庫、IDE 外掛程式,以及與 Google API 互動的其他工具。一項服務可能會提供多個探索文件。這項服務提供下列探索文件:

服務端點

服務端點是能指定 API 服務網路位址的基準網址。一項服務可能有多個服務端點,這項服務有以下服務端點,且下方的 URI 皆以此服務端點為基準:

  • https://games.googleapis.com

REST 資源:accesstokens

方法
generatePlayGroupingApiToken POST /games/v1/accesstokens/generatePlayGroupingApiToken
為附加憑證所識別的 PGS 使用者產生 Play Grouping API 權杖。
generateRecallPlayGroupingApiToken POST /games/v1/accesstokens/generateRecallPlayGroupingApiToken
為要求中提供的 Recall 工作階段 ID 所識別的 PGS 使用者產生 Play Grouping API 權杖。

REST 資源:achievementDefinitions

方法
list GET /games/v1/achievements
列出應用程式的所有成就定義。

REST 資源:achievements

方法
increment POST /games/v1/achievements/{achievementId}/increment
針對目前已通過驗證的玩家,增加指定 ID 成就的步數。
list GET /games/v1/players/{playerId}/achievements
列出目前已驗證玩家的所有應用程式成就進度。
reveal POST /games/v1/achievements/{achievementId}/reveal
將目前已通過驗證玩家的指定 ID 成就狀態設為 REVEALED
setStepsAtLeast POST /games/v1/achievements/{achievementId}/setStepsAtLeast
設定目前已通過驗證的玩家解鎖成就的步驟。
unlock POST /games/v1/achievements/{achievementId}/unlock
為目前已驗證的玩家解鎖這項成就。
updateMultiple POST /games/v1/achievements/updateMultiple
更新目前已驗證玩家的多項成就。

REST 資源:applications

方法
get GET /games/v1/applications/{applicationId}
擷取具有指定 ID 的應用程式中繼資料。
getEndPoint POST /games/v1/applications/getEndPoint
傳回所要求端點類型的網址。
played POST /games/v1/applications/played
指出目前通過驗證的使用者正在玩您的應用程式。
verify GET /games/v1/applications/{applicationId}/verify
驗證這項要求提供的授權權杖是否適用於具有指定 ID 的應用程式,並傳回權杖授予的玩家 ID。

REST 資源:events

方法
listByPlayer GET /games/v1/events
Returns a list showing the current progress on events in this application for the currently authenticated user.
listDefinitions GET /games/v1/eventDefinitions
傳回這個應用程式中的事件定義清單。
record POST /games/v1/events
記錄目前已驗證的應用程式使用者,事件發生次數的一批變更。

REST 資源:leaderboards

方法
get GET /games/v1/leaderboards/{leaderboardId}
擷取具有指定 ID 的排行榜中繼資料。
list GET /games/v1/leaderboards
列出應用程式的所有排行榜中繼資料。

REST 資源:metagame

方法
getMetagameConfig GET /games/v1/metagameConfig
傳回呼叫應用程式的元遊戲設定資料。
listCategoriesByPlayer GET /games/v1/players/{playerId}/categories/{collection}
列出與 playerId 相對應的玩家,依類別匯總的播放資料。

REST 資源:playerGameEvents

方法
batchRecordEvents POST /games/v1/players/{playerId}/gameEvents:batchRecordEvents
為特定玩家記錄一批玩家遊戲事件。

REST 資源:players

方法
get GET /games/v1/players/{playerId}
擷取具有指定 ID 的 Player 資源。
getMultipleApplicationPlayerIds GET /games/v1/players/me/multipleApplicationPlayerIds
針對呼叫應用程式的同一位開發人員,取得目前已驗證玩家在所有要求遊戲中的應用程式玩家 ID。
getScopedPlayerIds GET /games/v1/players/me/scopedIds
擷取目前已驗證使用者的範圍限定玩家 ID。
list GET /games/v1/players/me/players/{collection}
取得目前已驗證使用者的玩家集合。

REST 資源:recall

方法
gamesPlayerTokens GET /games/v1/recall/gamesPlayerTokens/{sessionId}
從與提供的喚回工作階段 ID 中編碼的 PGS 玩家相關聯的所有要求遊戲,擷取喚回符記。
lastTokenFromAllDeveloperGames GET /games/v1/recall/developerGamesLastPlayerToken/{sessionId}
從與提供的喚回工作階段 ID 中編碼的 PGS 玩家相關聯的所有開發人員遊戲,擷取最後一個喚回符記。
linkPersona POST /games/v1/recall:linkPersona
將提供的回想工作階段 ID 中編碼的 PGS 玩家主體,與遊戲內帳戶建立關聯
resetPersona POST /games/v1/recall:resetPersona
刪除將指定角色連結至任何玩家 (無論是否有設定檔) 的所有召回權杖。
retrieveTokens GET /games/v1/recall/tokens/{sessionId}
擷取與提供的喚回工作階段 ID 中編碼的 PGS 玩家相關聯的所有喚回符記。
unlinkPersona POST /games/v1/recall:unlinkPersona
刪除連結 PGS 玩家主體 (由 Recall 工作階段識別) 和遊戲內帳戶 (由「身分 ID」或喚回符記值識別) 的喚回符記。

REST 資源:revisions

方法
check GET /games/v1/revisions/check
檢查遊戲用戶端是否過舊。

REST 資源:scores

方法
get GET /games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}
取得目前已通過驗證玩家的排行榜最高分,以及 (選用) 排名。
list GET /games/v1/leaderboards/{leaderboardId}/scores/{collection}
從最高分開始,列出排行榜上的分數。
listWindow GET /games/v1/leaderboards/{leaderboardId}/window/{collection}
列出排行榜中與玩家分數相近的分數 (包括玩家分數)。
submit POST /games/v1/leaderboards/{leaderboardId}/scores
將分數提交至指定排行榜。
submitMultiple POST /games/v1/leaderboards/scores
將多個分數提交至排行榜。

REST 資源:snapshots

方法
get GET /games/v1/snapshots/{snapshotId}
擷取指定快照 ID 的中繼資料。
list GET /games/v1/players/{playerId}/snapshots
擷取應用程式為與玩家 ID 相對應的玩家建立的快照清單。

REST 資源:stats

方法
get GET /games/v1/stats
傳回目前已驗證使用者在這個應用程式中的參與度和支出統計資料。