Method: events.listDefinitions

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

Solicitud HTTP

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

Parámetros de consulta

Parámetros
language

string

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

integer

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

string

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

El token de paginación de la siguiente página de resultados.
items[]

object (EventDefinition)

Las definiciones del evento

Permisos de autorización

Se necesita uno de los siguientes alcances 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 hace seguimiento en esta definición.
displayName

string

El nombre que se mostrará para el evento.
imageUrl

string

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

object (EventChild)

Una lista de eventos que son elementos 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 si la proporciona el juego.
kind

string

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

EventVisibility

Los valores posibles para la visibilidad de un evento.

Enumeradores
REVEALED Todos los usuarios deben poder ver este evento.
HIDDEN Este evento solo se debe mostrar a los usuarios que lo registraron al menos una vez.

EventChild

Un recurso de relación de evento secundario.

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

string

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.