Method: achievementDefinitions.list

Répertorie toutes les définitions de réussites pour votre application.

Requête HTTP

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

Paramètres de requête

Paramètres
language

string

Langue préférée à utiliser pour les chaînes renvoyées par cette méthode.

maxResults

integer

Nombre maximal de ressources de réussite à afficher dans la réponse. Utilisé pour la pagination. Pour chaque réponse, le nombre réel de ressources de réussite renvoyées peut être inférieur à la valeur maxResults spécifiée.

pageToken

string

Jeton renvoyé par la requête précédente.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Liste d'objets de définition de réussite.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (AchievementDefinition)
    }
  ]
}
Champs
kind

string

Identifie de manière unique le type de cette ressource. La valeur est toujours la chaîne fixe games#achievementDefinitionsListResponse.

nextPageToken

string

Jeton correspondant à la page de résultats suivante.

items[]

object (AchievementDefinition)

Les définitions des réussites

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

AchievementDefinition

Un objet de définition de réussite.

Représentation 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
}
Champs
kind

string

Identifie de manière unique le type de cette ressource. La valeur est toujours la chaîne fixe games#achievementDefinition.

id

string

Identifiant de la réussite.

name

string

Nom du succès.

description

string

Description de la réussite.

achievementType

enum (AchievementType)

Type de la réussite.

totalSteps

integer

Le nombre total d'étapes pour une réussite progressive.

formattedTotalSteps

string

Nombre total d'étapes pour un succès progressif, sous forme de chaîne.

revealedIconUrl

string

URL de l'icône de réussite révélée

isRevealedIconUrlDefault

boolean

Indique si l'image de l'icône révélée renvoyée est une image par défaut ou si elle est fournie par le jeu.

unlockedIconUrl

string

URL de l'icône de réussite déverrouillée.

isUnlockedIconUrlDefault

boolean

Indique si l'image de l'icône déverrouillée renvoyée est une image par défaut ou si elle est fournie par le jeu.

initialState

enum (InitialAchievementState)

État initial du succès.

experiencePoints

string (int64 format)

Points d'expérience qui seront gagnés lorsque vous débloquerez cette réussite.

AchievementType

Types de réussites possibles.

Enums
STANDARD La réussite est verrouillée ou déverrouillée.
INCREMENTAL La réalisation est progressive.

InitialAchievementState

États initiaux possibles d'une réussite.

Enums
HIDDEN La réussite est masquée.
REVEALED La réussite est révélée.
UNLOCKED Réussite déverrouillée.