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

顯示成就圖示的圖片網址。

isRevealedIconUrlDefault

boolean

指出傳回的圖示圖片是預設圖片,還是由遊戲提供。

unlockedIconUrl

string

解鎖成就圖示的圖片網址。

isUnlockedIconUrlDefault

boolean

指出傳回的解鎖圖示圖片是否為預設圖片,還是由遊戲提供。

initialState

enum (InitialAchievementState)

成就的初始狀態。

experiencePoints

string (int64 format)

解鎖這項成就時可獲得的經驗值。

AchievementType

可能的成就類型。

列舉
STANDARD 成就已鎖定或解鎖。
INCREMENTAL 成就更多。

InitialAchievementState

成就的可能初始狀態。

列舉
HIDDEN 已隱藏成就。
REVEALED 成就顯示。
UNLOCKED 成就已解鎖。