Method: events.listDefinitions

Retorna uma lista das definições de evento neste aplicativo.

Solicitação HTTP

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

Parâmetros de consulta

Parâmetros
language

string

O idioma preferido a ser usado para strings retornadas por este método.
maxResults

integer

O número máximo de definições de evento a serem retornadas na resposta, usado para paginação. Para qualquer resposta, o número real de definições de evento a serem retornadas pode ser menor do que o maxResults especificado.
pageToken

string

O token retornado pela solicitação anterior.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma resposta ListDescription.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
Campos
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#eventDefinitionListResponse.
nextPageToken

string

O token de paginação para a próxima página de resultados.
items[]

object (EventDefinition)

As definições do evento.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

EventDefinition

Um recurso de definição de evento.

Representação JSON 
{
  "id": string,
  "visibility": enum (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
Campos
id

string

ID do evento.
visibility

enum (EventVisibility)

A visibilidade do evento que está sendo acompanhado nesta definição.
displayName

string

O nome a ser exibido para o evento.
imageUrl

string

O URL de base da imagem que representa o evento.
childEvents[]

object (EventChild)

Uma lista de eventos filhos desse evento.
description

string

Descrição do que esse evento representa.
isDefaultImageUrl

boolean

Indica se a imagem do ícone retornada é uma imagem padrão ou fornecida pelo jogo.
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#eventDefinition.

EventVisibility

Valores possíveis para a visibilidade de um evento.

Enums
REVEALED Este evento precisa ser visível para todos os usuários.
HIDDEN Esse evento só deve ser exibido aos usuários que o registraram pelo menos uma vez.

EventChild

Um recurso de relação de evento filho.

Representação JSON 
{
  "childId": string,
  "kind": string
}
Campos
childId

string

O ID do evento filho.
kind

string

Identifica exclusivamente o tipo desse recurso. O valor é sempre a string fixa games#eventChild.