Method: events.listDefinitions

Renvoie la liste des définitions d'événements dans cette application.

Requête HTTP

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

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 définitions d'événement à renvoyer dans la réponse. Utilisé pour la pagination. Pour toute réponse, le nombre réel de définitions d'événements à renvoyer 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

Réponse ListDefinition.

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 (EventDefinition)
    }
  ]
}
Champs
kind

string

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

string

Jeton de pagination pour la page de résultats suivante.
items[]

object (EventDefinition)

Définitions des événements.

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.

EventDefinition

Ressource de définition d'événement.

Représentation JSON 
{
  "id": string,
  "visibility": enum (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
Champs
id

string

ID de l'événement.
visibility

enum (EventVisibility)

Visibilité de l'événement suivi dans cette définition.
displayName

string

Nom à afficher pour l'événement.
imageUrl

string

URL de base de l'image représentant l'événement.
childEvents[]

object (EventChild)

Liste des événements enfants de cet événement.
description

string

Description de ce que cet événement représente.
isDefaultImageUrl

boolean

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

string

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

EventVisibility

Valeurs possibles pour la visibilité d'un événement.

Enums
REVEALED Cet événement doit être visible par tous les utilisateurs.
HIDDEN Cet événement ne doit être présenté qu'aux utilisateurs l'ayant enregistré au moins une fois.

EventChild

Ressource de relation enfant d'événement.

Représentation JSON 
{
  "childId": string,
  "kind": string
}
Champs
childId

string

ID de l'événement enfant.
kind

string

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