- HTTP request
- Request body
- Response body
- Authorization scopes
- UpdateMultipleAchievements
- UpdateAchievement
- AchievementUpdateType
- AchievementIncrement
- SetAchievementSteps
- UpdatedAchievement
- UpdatedAchievementState
- Try it!
Updates multiple achievements for the currently authenticated player.
HTTP request
POST https://games.googleapis.com/games/v1/achievements/updateMultiple
Request body
The request body contains an instance of UpdateMultipleAchievements
.
Response body
Response message for achievements.updateMultiple rpc.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"updatedAchievements": [
{
object ( |
Fields | |
---|---|
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
updatedAchievements[] |
The updated state of the achievements. |
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.
UpdateMultipleAchievements
A list of achievement update requests.
JSON representation |
---|
{
"kind": string,
"updates": [
{
object ( |
Fields | |
---|---|
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
updates[] |
The individual achievement update requests. |
UpdateAchievement
A request to update an achievement.
JSON representation |
---|
{ "kind": string, "achievementId": string, "updateType": enum ( |
Fields | |
---|---|
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
achievementId |
The achievement this update is being applied to. |
updateType |
The type of update being applied. |
incrementPayload |
The payload if an update of type |
setStepsAtLeastPayload |
The payload if an update of type |
AchievementUpdateType
Possible achievement update types.
Enums | |
---|---|
REVEAL |
Achievement is revealed. |
UNLOCK |
Achievement is unlocked. |
INCREMENT |
Achievement is incremented. |
SET_STEPS_AT_LEAST |
Achievement progress is set to at least the passed value. |
AchievementIncrement
The payload to request to increment an achievement.
JSON representation |
---|
{ "kind": string, "steps": integer, "requestId": string } |
Fields | |
---|---|
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
steps |
The number of steps to be incremented. |
requestId |
The requestId associated with an increment to an achievement. |
SetAchievementSteps
The payload to request to increment an achievement.
JSON representation |
---|
{ "kind": string, "steps": integer } |
Fields | |
---|---|
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
steps |
The minimum number of steps for the achievement to be set to. |
UpdatedAchievement
An updated achievement.
JSON representation |
---|
{
"kind": string,
"achievementId": string,
"updateOccurred": boolean,
"currentState": enum ( |
Fields | |
---|---|
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
achievementId |
The achievement this update is was applied to. |
updateOccurred |
Whether the requested updates actually affected the achievement. |
currentState |
The current state of the achievement. |
currentSteps |
The current steps recorded for this achievement if it is incremental. |
newlyUnlocked |
Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player). |
UpdatedAchievementState
Possible updated achievement states.
Enums | |
---|---|
HIDDEN |
Achievement is hidden. |
REVEALED |
Achievement is revealed. |
UNLOCKED |
Achievement is unlocked. |