Method: achievementDefinitions.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Répertorie toutes les définitions de réussite pour votre application.
Requête HTTP
GET https://games.googleapis.com/games/v1/achievements
Paramètres de requête
Paramètres |
language |
string
Langue privilégiée pour les chaînes renvoyées par cette méthode.
|
maxResults |
integer
Nombre maximal de ressources de succès à renvoyer dans la réponse. Utilisé pour la pagination. Pour toute 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 des objets de définition des réussites.
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 )
Définition 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
Objet de définition d'une 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 de la réussite.
|
description |
string
Description de la réussite.
|
achievementType |
enum (AchievementType )
Type de réussite.
|
totalSteps |
integer
Nombre total d'étapes pour une réussite progressive.
|
formattedTotalSteps |
string
Nombre total d'étapes pour une réussite progressive, sous forme de chaîne.
|
revealedIconUrl |
string
URL de l'image de l'icône de réussite révélée.
|
isRevealedIconUrlDefault |
boolean
Indique si l'image d'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 la 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 a été fournie par le jeu.
|
initialState |
enum (InitialAchievementState )
État initial de la réussite
|
experiencePoints |
string (int64 format)
Points d'expérience que vous gagnerez si vous débloquez cette réussite.
|
AchievementType
Types de réussites possibles.
Enums |
STANDARD |
La réussite est soit verrouillée, soit déverrouillée. |
INCREMENTAL |
Les réussites sont progressives. |
InitialAchievementState
États initiaux possibles d'une réussite.
Enums |
HIDDEN |
La réussite est masquée. |
REVEALED |
La réussite s'affiche. |
UNLOCKED |
Réussite déverrouillée. |
Le contenu et les exemples de code de cette page sont soumis aux licences décrites dans la Licence de contenu. Java et OpenJDK sont des marques ou des marques déposées d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/27 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/07/27 (UTC)."],[],[],null,["# Method: achievementDefinitions.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAchievementDefinitionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [AchievementDefinition](#AchievementDefinition)\n - [JSON representation](#AchievementDefinition.SCHEMA_REPRESENTATION)\n- [AchievementType](#AchievementType)\n- [InitialAchievementState](#InitialAchievementState)\n- [Try it!](#try-it)\n\nLists all the achievement definitions for your application.\n\n### HTTP request\n\n`GET https://games.googleapis.com/games/v1/achievements`\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\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of achievement definition 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/achievementDefinitions/list#AchievementDefinition) } ] } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinitionsListResponse`. |\n| `nextPageToken` | `string` Token corresponding to the next page of results. |\n| `items[]` | `object (`[AchievementDefinition](/games/services/web/api/rest/v1/achievementDefinitions/list#AchievementDefinition)`)` The achievement definitions. |\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\nAchievementDefinition\n---------------------\n\nAn achievement definition object.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"id\": string, \"name\": string, \"description\": string, \"achievementType\": enum (/games/services/web/api/rest/v1/achievementDefinitions/list#AchievementType), \"totalSteps\": integer, \"formattedTotalSteps\": string, \"revealedIconUrl\": string, \"isRevealedIconUrlDefault\": boolean, \"unlockedIconUrl\": string, \"isUnlockedIconUrlDefault\": boolean, \"initialState\": enum (/games/services/web/api/rest/v1/achievementDefinitions/list#InitialAchievementState), \"experiencePoints\": string } ``` |\n\n| Fields ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinition`. |\n| `id` | `string` The ID of the achievement. |\n| `name` | `string` The name of the achievement. |\n| `description` | `string` The description of the achievement. |\n| `achievementType` | `enum (`[AchievementType](/games/services/web/api/rest/v1/achievementDefinitions/list#AchievementType)`)` The type of the achievement. |\n| `totalSteps` | `integer` The total steps for an incremental achievement. |\n| `formattedTotalSteps` | `string` The total steps for an incremental achievement as a string. |\n| `revealedIconUrl` | `string` The image URL for the revealed achievement icon. |\n| `isRevealedIconUrlDefault` | `boolean` Indicates whether the revealed icon image being returned is a default image, or is provided by the game. |\n| `unlockedIconUrl` | `string` The image URL for the unlocked achievement icon. |\n| `isUnlockedIconUrlDefault` | `boolean` Indicates whether the unlocked icon image being returned is a default image, or is game-provided. |\n| `initialState` | `enum (`[InitialAchievementState](/games/services/web/api/rest/v1/achievementDefinitions/list#InitialAchievementState)`)` The initial state of the achievement. |\n| `experiencePoints` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Experience points which will be earned when unlocking this achievement. |\n\nAchievementType\n---------------\n\nPossible achievement types.\n\n| Enums ||\n|---------------|-------------------------------------------|\n| `STANDARD` | Achievement is either locked or unlocked. |\n| `INCREMENTAL` | Achievement is incremental. |\n\nInitialAchievementState\n-----------------------\n\nPossible initial states of an achievement.\n\n| Enums ||\n|------------|--------------------------|\n| `HIDDEN` | Achievement is hidden. |\n| `REVEALED` | Achievement is revealed. |\n| `UNLOCKED` | Achievement is unlocked. |"]]