Method: achievementDefinitions.list

アプリのすべての実績定義を一覧表示します。

HTTP リクエスト

GET https://games.googleapis.com/games/v1/achievements

クエリ パラメータ

パラメータ
language

string

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

integer

レスポンスで返される実績リソースの最大数。ページングに使用されます。レスポンスごとに、返される実績リソースの数が指定された maxResults より少なくなる場合があります。
pageToken

string

前のリクエストで返されたトークン。

リクエストの本文

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

レスポンスの本文

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

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

string

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

string

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

object (AchievementDefinition)

実績の定義。

認可スコープ

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。

AchievementDefinition

実績の定義オブジェクト。

JSON 表現 
{
  "kind": string,
  "id": string,
  "name": string,
  "description": string,
  "achievementType": enum (AchievementType),
  "totalSteps": integer,
  "formattedTotalSteps": string,
  "revealedIconUrl": string,
  "isRevealedIconUrlDefault": boolean,
  "unlockedIconUrl": string,
  "isUnlockedIconUrlDefault": boolean,
  "initialState": enum (InitialAchievementState),
  "experiencePoints": string
}
フィールド
kind

string

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

string

実績の ID。
name

string

実績の名前。
description

string

実績の説明。
achievementType

enum (AchievementType)

アチーブメントの種類。
totalSteps

integer

増分達成の合計歩数。
formattedTotalSteps

string

増分達成の合計歩数（文字列）。
revealedIconUrl

string

表示された実績アイコンの画像 URL。
isRevealedIconUrlDefault

boolean

返される公開アイコン画像がデフォルト画像か、ゲームから提供された画像かを示す。
unlockedIconUrl

string

ロック解除された実績アイコンの画像 URL。
isUnlockedIconUrlDefault

boolean

返されるロック解除済みのアイコン画像がデフォルト画像か、ゲーム提供の画像かを指定します。
initialState

enum (InitialAchievementState)

実績の初期状態。
experiencePoints

string (int64 format)

この実績を達成したときに獲得できる経験値。

AchievementType

利用可能なアチーブメントの種類。

列挙型
STANDARD 実績はロックされているか、ロックが解除されているかのいずれかです。
INCREMENTAL 実績は増分です。

InitialAchievementState

実績の初期状態。

列挙型
HIDDEN 実績が非表示になっています。
REVEALED 実績が公開されます。
UNLOCKED 実績が解除された。