Method: achievements.reveal

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

HTTP request

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

Path parameters

Parameters
achievementId

string

The ID of the achievement used by this method.

Request body

The request body must be empty.

Response body

An achievement reveal response

If successful, the response body contains data with the following structure:

JSON representation
{
  "kind": string,
  "currentState": enum (RevealAchievementState)
}
Fields
kind

string

Uniquely identifies the type of this resource. Value is always the fixed string games#achievementRevealResponse.

currentState

enum (RevealAchievementState)

The current state of the achievement for which a reveal was attempted. This might be UNLOCKED if the achievement was already unlocked.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

For more information, see the OAuth 2.0 Overview.

RevealAchievementState

Possible reveal achievement states.

Enums
REVEALED Achievement is revealed.
UNLOCKED Achievement is unlocked.