Method: achievements.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista o progresso de todas as conquistas do app para o jogador autenticado.
Solicitação HTTP
GET https://games.googleapis.com/games/v1/players/{playerId}/achievements
Parâmetros de caminho
Parâmetros |
playerId |
string
Um ID do jogador. Um valor de me pode ser usado no lugar do ID do jogador autenticado.
|
Parâmetros de consulta
Parâmetros |
language |
string
O idioma preferencial a ser usado para strings retornadas por esse método.
|
maxResults |
integer
O número máximo de recursos de conquistas a serem retornados na resposta, usado para paginação. Para qualquer resposta, o número real de recursos de conquistas retornados pode ser menor do que o maxResults especificado.
|
pageToken |
string
O token retornado pela solicitação anterior.
|
state |
enum (State )
Informa ao servidor para retornar apenas conquistas com o estado especificado. Se esse parâmetro não for especificado, todos os prêmios serão retornados.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Uma lista de objetos de conquistas.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
{
"kind": string,
"nextPageToken": string,
"items": [
{
object (PlayerAchievement )
}
]
} |
Campos |
kind |
string
Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#playerAchievementListResponse .
|
nextPageToken |
string
Token correspondente à próxima página de resultados.
|
items[] |
object (PlayerAchievement )
As conquistas.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/games
https://www.googleapis.com/auth/games_lite
Para mais informações, consulte a Visão geral do OAuth 2.0.
Estado
Enumerações |
ALL |
Lista todas as conquistas. Esse é o padrão. |
HIDDEN |
Listar apenas conquistas ocultas. |
REVEALED |
Lista apenas conquistas reveladas. |
UNLOCKED |
Listar apenas as conquistas desbloqueadas. |
PlayerAchievement
Representação JSON |
{
"kind": string,
"id": string,
"currentSteps": integer,
"formattedCurrentStepsString": string,
"achievementState": enum (State ),
"lastUpdatedTimestamp": string,
"experiencePoints": string
} |
Campos |
kind |
string
Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#playerAchievement .
|
id |
string
O ID da conquista.
|
currentSteps |
integer
As etapas atuais de uma conquista incremental.
|
formattedCurrentStepsString |
string
As etapas atuais de uma conquista incremental como uma string.
|
achievementState |
enum (State )
O estado da conquista.
|
lastUpdatedTimestamp |
string (int64 format)
O carimbo de data/hora da última modificação no estado dessa conquista.
|
experiencePoints |
string (int64 format)
Pontos de experiência ganhos com a conquista. Esse campo não está presente para conquistas que ainda não foram desbloqueadas e 0 para conquistas que foram desbloqueadas pelos testadores, mas não foram publicadas.
|
Estado
Define os estados possíveis de uma conquista.
Enumerações |
HIDDEN |
A conquista está oculta. |
REVEALED |
A conquista é revelada. |
UNLOCKED |
A conquista foi desbloqueada. |
O conteúdo e os exemplos de código nesta página estão sujeitos às licenças descritas na Licença de conteúdo. Java e OpenJDK são marcas registradas da Oracle e/ou suas afiliadas.
Última atualização 2025-07-27 UTC.
[null,null,["Última atualização 2025-07-27 UTC."],[],[],null,["# Method: achievements.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAchievementsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [State](#State)\n- [PlayerAchievement](#PlayerAchievement)\n - [JSON representation](#PlayerAchievement.SCHEMA_REPRESENTATION)\n- [State](#State_1)\n- [Try it!](#try-it)\n\nLists the progress for all your application's achievements for the currently authenticated player.\n\n### HTTP request\n\n`GET https://games.googleapis.com/games/v1/players/{playerId}/achievements`\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------|\n| `playerId` | `string` A player ID. A value of `me` may be used in place of the authenticated player's ID. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `language` | `string` The preferred language to use for strings returned by this method. |\n| `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`. |\n| `pageToken` | `string` The token returned by the previous request. |\n| `state` | `enum (`[State](/games/services/web/api/rest/v1/achievements/list#State)`)` Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of achievement objects.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"items\": [ { object (/games/services/web/api/rest/v1/achievements/list#PlayerAchievement) } ] } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievementListResponse`. |\n| `nextPageToken` | `string` Token corresponding to the next page of results. |\n| `items[]` | `object (`[PlayerAchievement](/games/services/web/api/rest/v1/achievements/list#PlayerAchievement)`)` The achievements. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/games`\n- `\n https://www.googleapis.com/auth/games_lite`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nState\n-----\n\n| Enums ||\n|------------|---------------------------------------------|\n| `ALL` | List all achievements. This is the default. |\n| `HIDDEN` | List only hidden achievements. |\n| `REVEALED` | List only revealed achievements. |\n| `UNLOCKED` | List only unlocked achievements. |\n\nPlayerAchievement\n-----------------\n\nAn achievement object.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"id\": string, \"currentSteps\": integer, \"formattedCurrentStepsString\": string, \"achievementState\": enum (/games/services/web/api/rest/v1/achievements/list#State_1), \"lastUpdatedTimestamp\": string, \"experiencePoints\": string } ``` |\n\n| Fields ||\n|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievement`. |\n| `id` | `string` The ID of the achievement. |\n| `currentSteps` | `integer` The current steps for an incremental achievement. |\n| `formattedCurrentStepsString` | `string` The current steps for an incremental achievement as a string. |\n| `achievementState` | `enum (`[State](/games/services/web/api/rest/v1/achievements/list#State_1)`)` The state of the achievement. |\n| `lastUpdatedTimestamp` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The timestamp of the last modification to this achievement's state. |\n| `experiencePoints` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` 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. |\n\nState\n-----\n\nDefines possible states of an achievement.\n\n| Enums ||\n|------------|--------------------------|\n| `HIDDEN` | Achievement is hidden. |\n| `REVEALED` | Achievement is revealed. |\n| `UNLOCKED` | Achievement is unlocked. |"]]