AchievementDefinitions: list

Lists all the achievement definitions for your application. Try it now.

Request

HTTP request

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

Parameters

Parameter name	Value	Description
Optional query parameters
`language`	`string`	The preferred language to use for strings returned by this method.
`maxResults`	`integer`	The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified `maxResults`. Acceptable values are `1` to `200`, inclusive.
`pageToken`	`string`	The token returned by the previous request.

Authorization

This request requires authorization with the following scope:

Scope
`https://www.googleapis.com/auth/games`

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "games#achievementDefinitionsListResponse",
  "nextPageToken": string,
  "items": [
    {
      "kind": "games#achievementDefinition",
      "id": string,
      "name": string,
      "description": string,
      "achievementType": string,
      "totalSteps": integer,
      "formattedTotalSteps": string,
      "revealedIconUrl": string,
      "isRevealedIconUrlDefault": boolean,
      "unlockedIconUrl": string,
      "isUnlockedIconUrlDefault": boolean,
      "initialState": string,
      "experiencePoints": long
    }
  ]
}

Property name	Value	Description
`kind`	`string`	Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinitionsListResponse`.
`nextPageToken`	`string`	Token corresponding to the next page of results.
`items[]`	`list`	The achievement definitions.
`items[].kind`	`string`	Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinition`.
`items[].id`	`string`	The ID of the achievement.
`items[].name`	`string`	The name of the achievement.
`items[].description`	`string`	The description of the achievement.
`items[].achievementType`	`string`	The type of the achievement. Possible values are: "`STANDARD`" - Achievement is either locked or unlocked. "`INCREMENTAL`" - Achievement is incremental. Acceptable values are: "`INCREMENTAL`" "`STANDARD`"
`items[].totalSteps`	`integer`	The total steps for an incremental achievement.
`items[].formattedTotalSteps`	`string`	The total steps for an incremental achievement as a string.
`items[].revealedIconUrl`	`string`	The image URL for the revealed achievement icon.
`items[].isRevealedIconUrlDefault`	`boolean`	Indicates whether the revealed icon image being returned is a default image, or is provided by the game.
`items[].unlockedIconUrl`	`string`	The image URL for the unlocked achievement icon.
`items[].isUnlockedIconUrlDefault`	`boolean`	Indicates whether the unlocked icon image being returned is a default image, or is game-provided.
`items[].initialState`	`string`	The initial state of the achievement. Possible values are: "`HIDDEN`" - Achievement is hidden. "`REVEALED`" - Achievement is revealed. "`UNLOCKED`" - Achievement is unlocked. Acceptable values are: "`HIDDEN`" "`REVEALED`" "`UNLOCKED`"
`items[].experiencePoints`	`long`	Experience points which will be earned when unlocking this achievement.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.