API Reference

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

この API リファレンスは、リソースタイプ別にまとめられています。各リソースタイプには、1 つ以上のデータ表現と 1 つ以上のメソッドがあります。

リソースタイプ

  1. AchievementDefinitions
  2. 実績
  3. アプリケーション
  4. イベント
  5. リーダーボード
  6. Metagame
  7. プレーヤー
  8. プッシュトークン
  9. リビジョン
  10. 会議室
  11. スコア
  12. スナップショット
  13. Stats
  14. TurnBasedMatch

AchievementDefinitions

AchievementDefinitions リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
list GET  /achievements アプリの実績のすべての定義を一覧表示します。

実績

実績リソースの詳細については、リソース表現ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
increment POST  /achievements/achievementId/increment 現在認証されているプレーヤーの指定された ID で実績のステップをインクリメントします。

必要なクエリ パラメータ: stepsToIncrement

list GET  /players/playerId/achievements 現在認証されているプレーヤーのアプリケーションのすべての実績の進行状況を一覧表示します。
表示 POST  /achievements/achievementId/reveal 指定された ID の実績の状態を、現在認証されているプレーヤーの REVEALED に設定します。
setStepsAtLeast POST  /achievements/achievementId/setStepsAtLeast 現在認証されているプレーヤーが実績のロックを解除する手順を設定します。steps パラメータが、プレーヤーがすでに実績で獲得したステップ数より少ない場合、実績は変更されません。

必要なクエリ パラメータ: steps

ロック解除 POST  /achievements/achievementId/unlock 現在認証されているプレーヤーのこの実績のロックを解除します。
updateMultiple POST  /achievements/updateMultiple 現在認証されているプレーヤーの複数の実績を更新します。

アプリケーション

アプリケーション リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
get GET  /applications/applicationId 指定した ID でアプリケーションのメタデータを取得します。要求されたアプリケーションが指定の platformType で使用できない場合、返されるレスポンスにインスタンス データは含まれません。
再生 POST  /applications/played 現在認証されているユーザーがアプリケーションを再生していることを示します。
verify GET  /applications/applicationId/verify このリクエストで指定された認証トークンが、指定された ID のアプリケーション用であることを確認し、付与されたプレーヤーの ID を返します。

イベント

イベント リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
listByPlayer GET  /events 現在認証されているユーザーについて、このアプリケーションのイベントの現在の進捗状況を示すリストを返します。
listDefinitions GET  /eventDefinitions このアプリのイベント定義のリストを返します。
record(記録) POST  /events このアプリケーションの現在認証されているユーザーに対して、イベントが発生した回数の変更バッチを記録します。

リーダーボード

Leaderboards リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
get GET  /leaderboards/leaderboardId 指定された ID でリーダーボードのメタデータを取得します。
list GET  /leaderboards アプリのすべてのリーダーボード メタデータを一覧表示します。

メタゲーム

Metagame リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
getMetagameConfig GET  /metagameConfig 呼び出し元アプリのメタゲーム構成データを返します。
listCategoriesByPlayer GET  /players/playerId/categories/collection playerId に対応するプレーヤーのカテゴリごとに集計された再生データを一覧表示します。

プレーヤー

プレーヤー リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
get GET  /players/playerId 指定された ID の Player リソースを取得します。現在認証されているユーザーのプレーヤーを取得するには、playerIdme に設定します。
list GET  /players/me/players/collection 現在認証されているユーザーのプレーヤー コレクションを取得します。

プッシュトークン

Pushtokens のリソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
削除 POST  /pushtokens/remove 現在のユーザーとアプリケーションのプッシュ トークンを削除します。存在しない push トークンを削除すると、成功が報告されます。
update PUT  /pushtokens 現在のユーザーとアプリケーションのプッシュ トークンを登録します。

リビジョン

リビジョン リソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
check GET  /revisions/check ゲーム クライアントが最新かどうかを確認します。

必要なクエリ パラメータ: clientRevision

客室

Rooms リソースの詳細については、リソース表現ページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
create POST  /rooms/create 部屋を作成するGames SDK による内部使用のみ。このメソッドを直接呼び出すことはできません。
拒否 POST  /rooms/roomId/decline チャットルームへの招待を辞退します。Games SDK による内部使用のみ。このメソッドを直接呼び出すことはできません。
閉じる POST  /rooms/roomId/dismiss チャットルームへの参加の招待を取り消します。Games SDK による内部使用のみ。このメソッドを直接呼び出すことはできません。
get GET  /rooms/roomId 会議室のデータを取得します。
join POST  /rooms/roomId/join チャットルームに参加します。Games SDK による内部使用のみ。このメソッドを直接呼び出すことはできません。
leave POST  /rooms/roomId/leave チャットルームから退出します。Games SDK による内部使用のみ。このメソッドを直接呼び出すことはできません。
list GET  /rooms チャットルームへの招待状を返します。
reportStatus POST  /rooms/roomId/reportstatus ルーム内のピアのステータスを報告しているクライアントから送信されたアップデート。Games SDK による内部使用のみ。このメソッドを直接呼び出すことはできません。

スコア

Scores リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
get GET  /players/playerId/leaderboards/leaderboardId/scores/timeSpan 現在認証されているプレーヤーのリーダーボードで、ハイスコアとランキング(任意)を取得する。特定の期間では、leaderboardIdALL に設定して、特定の期間のすべてのリーダーボードのデータを取得できます。
注: 同じリクエストで「ALL」リーダーボードと「ALL」timeSpans をリクエストすることはできません。「ALL」に設定できるのは 1 つのパラメータのみです。
list GET  /leaderboards/leaderboardId/scores/collection リーダーボードを上から順に表示します。

必要なクエリ パラメータ: timeSpan

listWindow GET  /leaderboards/leaderboardId/window/collection リーダーボード内のスコアをスコアとともに表示します。

必要なクエリ パラメータ: timeSpan

送信 POST  /leaderboards/leaderboardId/scores 指定したリーダーボードにスコアを送信します。

必要なクエリ パラメータ: score

submitMultiple POST  /leaderboards/scores リーダーボードに複数のスコアを送信します。

スナップショット

スナップショット リソースについて詳しくは、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
get GET  /snapshots/snapshotId 特定のスナップショット ID のメタデータを取得します。
list GET  /players/playerId/snapshots プレーヤー ID に対応するプレーヤー用にアプリケーションによって作成されたスナップショットのリストを取得します。

統計情報

Stats Resource の詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
get GET  /stats 現在認証されているユーザーのこのアプリケーションにおけるエンゲージメントと支出の統計情報を返します。

TurnBasedMatch

TurnBasedMatch のリソースの詳細については、リソース表現のページをご覧ください。

メソッド HTTP リクエスト 説明
特に明記されていない限り、URI は https://www.googleapis.com/games/v1 を基準とします。
キャンセル PUT  /turnbasedmatches/matchId/cancel ターンベース一致をキャンセルします。
create POST  /turnbasedmatches/create ターンベース一致を作成します。
拒否 PUT  /turnbasedmatches/matchId/decline ターン制対戦の招待を辞退する。
閉じる PUT  /turnbasedmatches/matchId/dismiss マッチリストからターンベースの一致を削除します。一致する連絡先はリストに表示されなくなり、通知も生成されません。
Finish PUT  /turnbasedmatches/matchId/finish ターンベース マッチングを終了します。すべての結果を取得したら、各プレーヤーがこの呼び出しを 1 回行う必要があります。そのターンのプレーヤーは、最初の Finish の呼び出しを行い、最終一致状態を渡すことができます。
get GET  /turnbasedmatches/matchId ターンベース一致のデータを取得します。
join PUT  /turnbasedmatches/matchId/join ターンベース対戦に参加します。
leave PUT  /turnbasedmatches/matchId/leave 現在のプレーヤーのターンでない場合は、対戦をキャンセルせずにターンベースの一致を残します。
leaveTurn PUT  /turnbasedmatches/matchId/leaveTurn 対戦をキャンセルすることなく、現在のプレーヤーのターン中にターンベースの対戦から退出する。

必要なクエリ パラメータ: matchVersion

list GET  /turnbasedmatches プレーヤーが関わった、または関わったターンベースの一致を返します。
再一致 POST  /turnbasedmatches/matchId/rematch 以前に完了した同じ参加者を含む再対戦を作成します。このメソッドは、リストに登録されている対戦で 1 人のプレーヤーだけが呼び出すことができます。プレーヤーは、最初にフィニッシュを呼び出す必要があります。新しく作成された一致を返します。これは呼び出し元の順番です。
sync GET  /turnbasedmatches/sync 最後の同期呼び出し以降にプレーヤーがその変更に関わっている、または関わっているターンベースの一致を返します。最も新しい変更が最初に来ます。ローカル キャッシュから削除する必要がある一致のステータスは MATCH_DELETED になります。
takeTurn PUT  /turnbasedmatches/matchId/turn プレーヤーのターンの結果を commit します。