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 実績のロックが解除されました。