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