Achievements: list

Requires authorization

Lists the progress for all your application's achievements for the currently authenticated player. Try it now.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
playerId string A player ID. A value of me may be used in place of the authenticated player's ID.
Optional query parameters
consistencyToken long The last-seen mutation timestamp.
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.
state string Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned.

Acceptable values are:
  • "ALL": List all achievements. This is the default.
  • "HIDDEN": List only hidden achievements.
  • "REVEALED": List only revealed achievements.
  • "UNLOCKED": List only unlocked achievements.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

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#playerAchievementListResponse",
  "nextPageToken": string,
  "items": [
    {
      "kind": "games#playerAchievement",
      "id": string,
      "currentSteps": integer,
      "formattedCurrentStepsString": string,
      "achievementState": string,
      "lastUpdatedTimestamp": long,
      "experiencePoints": long
    }
  ]
}
Property name Value Description Notes
kind string Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievementListResponse.
nextPageToken string Token corresponding to the next page of results.
items[] list The achievements.
items[].kind string Uniquely identifies the type of this resource. Value is always the fixed string games#playerAchievement.
items[].id string The ID of the achievement.
items[].currentSteps integer The current steps for an incremental achievement.
items[].formattedCurrentStepsString string The current steps for an incremental achievement as a string.
items[].achievementState string The 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[].lastUpdatedTimestamp long The timestamp of the last modification to this achievement's state.
items[].experiencePoints long Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished.

Try it!

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

Send feedback about...

Play Games Services for Web
Play Games Services for Web