Method: achievementDefinitions.list

Lista todas as definições de conquistas do seu app.

Solicitação HTTP

GET https://games.googleapis.com/games/v1/achievements

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.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma lista de objetos de definição 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 (AchievementDefinition)
    }
  ]
}
Campos
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#achievementDefinitionsListResponse.

nextPageToken

string

Token correspondente à próxima página de resultados.

items[]

object (AchievementDefinition)

As definições de 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.

AchievementDefinition

Um objeto de definição de conquista.

Representação JSON
{
  "kind": string,
  "id": string,
  "name": string,
  "description": string,
  "achievementType": enum (AchievementType),
  "totalSteps": integer,
  "formattedTotalSteps": string,
  "revealedIconUrl": string,
  "isRevealedIconUrlDefault": boolean,
  "unlockedIconUrl": string,
  "isUnlockedIconUrlDefault": boolean,
  "initialState": enum (InitialAchievementState),
  "experiencePoints": string
}
Campos
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#achievementDefinition.

id

string

O ID da conquista.

name

string

O nome da conquista.

description

string

A descrição da conquista.

achievementType

enum (AchievementType)

O tipo de conquista.

totalSteps

integer

O total de etapas para uma conquista incremental.

formattedTotalSteps

string

O total de etapas de uma conquista incremental como uma string.

revealedIconUrl

string

O URL da imagem do ícone de conquista revelado.

isRevealedIconUrlDefault

boolean

Indica se a imagem do ícone revelada que está sendo retornada é uma imagem padrão ou foi fornecida pelo jogo.

unlockedIconUrl

string

O URL da imagem do ícone da conquista desbloqueada.

isUnlockedIconUrlDefault

boolean

Indica se a imagem do ícone desbloqueado que está sendo retornada é uma imagem padrão ou fornecida pelo jogo.

initialState

enum (InitialAchievementState)

O estado inicial da conquista.

experiencePoints

string (int64 format)

Pontos de experiência que serão ganhos ao desbloquear essa conquista.

AchievementType

Possíveis tipos de conquistas.

Enumerações
STANDARD A conquista está bloqueada ou desbloqueada.
INCREMENTAL A conquista é incremental.

InitialAchievementState

Possíveis estados iniciais de uma conquista.

Enumerações
HIDDEN A conquista está oculta.
REVEALED A conquista é revelada.
UNLOCKED A conquista foi desbloqueada.