Achievements: reveal

Requires authorization

Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player. Try it now.

Request

HTTP request

POST https://www.googleapis.com/games/v1/achievements/achievementId/reveal

Parameters

Parameter name Value Description
Path parameters
achievementId string The ID of the achievement used by this method.
Optional query parameters
consistencyToken long The last-seen mutation timestamp.

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#achievementRevealResponse",
  "currentState": string
}
Property name Value Description Notes
kind string Uniquely identifies the type of this resource. Value is always the fixed string games#achievementRevealResponse.
currentState string The current state of the achievement for which a reveal was attempted. This might be UNLOCKED if the achievement was already unlocked.
Possible values are:
  • "REVEALED" - Achievement is revealed.
  • "UNLOCKED" - Achievement is unlocked.


Acceptable values are:
  • "HIDDEN"
  • "REVEALED"
  • "UNLOCKED"

Try it!

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