Method: events.listDefinitions

Muestra una lista de las definiciones de eventos de esta aplicación.

Solicitud HTTP

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

Parámetros de consulta

Parámetros
language

string

Es el idioma preferido para usar en las cadenas que muestra este método.
maxResults

integer

Es la cantidad máxima de definiciones de eventos que se mostrarán en la respuesta, que se usa para la paginación. Para cualquier respuesta, la cantidad real de definiciones de eventos que se mostrarán puede ser menor que el maxResults especificado.
pageToken

string

Es el token que muestra la solicitud anterior.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Una respuesta de ListDefinitions.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
Campos
kind

string

Identifica de forma única el tipo de este recurso. El valor siempre es la cadena fija games#eventDefinitionListResponse.
nextPageToken

string

Es el token de paginación para la siguiente página de resultados.
items[]

object (EventDefinition)

Las definiciones de eventos

Permisos de autorización

Se requiere uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

EventDefinition

Un recurso de definición de eventos.

Representación JSON 
{
  "id": string,
  "visibility": enum (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
Campos
id

string

El ID del evento.
visibility

enum (EventVisibility)

Es la visibilidad del evento al que se le hace un seguimiento en esta definición.
displayName

string

Es el nombre que se mostrará para el evento.
imageUrl

string

Es la URL base de la imagen que representa el evento.
childEvents[]

object (EventChild)

Es una lista de eventos que son secundarios de este evento.
description

string

Descripción de lo que representa este evento.
isDefaultImageUrl

boolean

Indica si la imagen del ícono que se muestra es una imagen predeterminada o proporcionada por el juego.
kind

string

Identifica de forma única el tipo de este recurso. El valor siempre es la cadena fija games#eventDefinition.

EventVisibility

Valores posibles para la visibilidad de un evento.

Enums
REVEALED Este evento debería ser visible para todos los usuarios.
HIDDEN Este evento solo debe mostrarse a los usuarios que lo hayan registrado al menos una vez.

EventChild

Un recurso de relación secundario de un evento.

Representación JSON 
{
  "childId": string,
  "kind": string
}
Campos
childId

string

Es el ID del evento secundario.
kind

string

Identifica de forma única el tipo de este recurso. El valor siempre es la cadena fija games#eventChild.