Method: achievements.list

現在認証されているプレーヤーについて、アプリケーションのすべての実績の進捗状況を一覧表示します。

HTTP リクエスト

GET https://games.googleapis.com/games/v1/players/{playerId}/achievements

パスパラメータ

パラメータ
playerId

string

プレーヤー ID。認証されたプレーヤーの ID の代わりに値 me を使用できます。

クエリ パラメータ

パラメータ
language

string

このメソッドによって返される文字列に使用する優先言語。

maxResults

integer

レスポンスで返す実績リソースの最大数。ページングに使用されます。どのようなレスポンスでも、実際に返される実績リソースの件数は、指定した maxResults 未満になることがあります。

pageToken

string

前のリクエストによって返されたトークン。

state

enum (State)

指定された状態の実績のみを返すようサーバーに指示します。このパラメータを指定しない場合、すべての実績が返されます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

実績オブジェクトのリスト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (PlayerAchievement)
    }
  ]
}
フィールド
kind

string

このリソースのタイプを一意に識別します。値は常に固定文字列 games#playerAchievementListResponse です。

nextPageToken

string

結果の次のページに対応するトークン。

items[]

object (PlayerAchievement)

実績。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

詳細については、OAuth 2.0 の概要をご覧ください。

状態

列挙型
ALL すべての実績を一覧表示します。これがデフォルトです。
HIDDEN 非表示の実績のみを一覧表示します。
REVEALED 明らかにされた実績のみを一覧表示します。
UNLOCKED 達成された実績のみを一覧表示します。

PlayerAchievement

実績オブジェクト。

JSON 表現
{
  "kind": string,
  "id": string,
  "currentSteps": integer,
  "formattedCurrentStepsString": string,
  "achievementState": enum (State),
  "lastUpdatedTimestamp": string,
  "experiencePoints": string
}
フィールド
kind

string

このリソースのタイプを一意に識別します。値は常に固定文字列 games#playerAchievement です。

id

string

実績の ID。

currentSteps

integer

増分実績の現在のステップ。

formattedCurrentStepsString

string

増分実績の現行のステップ(文字列)。

achievementState

enum (State)

実績の状態。

lastUpdatedTimestamp

string (int64 format)

この実績の状態が最後に変更されたときのタイムスタンプ。

experiencePoints

string (int64 format)

実績で獲得した経験値。まだロック解除されていない実績の場合、このフィールドは存在しません。テスターによってロック解除された実績が未公開の場合は 0 になります。

状態

実績の取り得る状態を定義します。

列挙型
HIDDEN 実績が非表示になっています。
REVEALED 実績が発表されます。
UNLOCKED 実績がロック解除されました。