Method: events.listDefinitions

Restituisce un elenco delle definizioni degli eventi in questa applicazione.

Richiesta HTTP

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

Parametri di ricerca

Parametri
language

string

La lingua preferita da utilizzare per le stringhe restituite da questo metodo.

maxResults

integer

Il numero massimo di definizioni di eventi da restituire nella risposta, utilizzato per il paging. Per qualsiasi risposta, il numero effettivo di definizioni di eventi da restituire potrebbe essere inferiore al valore maxResults specificato.

pageToken

string

Il token restituito dalla richiesta precedente.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Una risposta ListDefinitions.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
Campi
kind

string

Identifica in modo univoco il tipo di questa risorsa. Il valore è sempre la stringa fissa games#eventDefinitionListResponse.

nextPageToken

string

Il token di impaginazione per la pagina successiva dei risultati.

items[]

object (EventDefinition)

Le definizioni degli eventi.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

EventDefinition

Una risorsa di definizione dell'evento.

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

string

L'ID dell'evento.

visibility

enum (EventVisibility)

La visibilità dell'evento monitorato in questa definizione.

displayName

string

Il nome da visualizzare per l'evento.

imageUrl

string

L'URL di base per l'immagine che rappresenta l'evento.

childEvents[]

object (EventChild)

Un elenco degli eventi secondari di questo evento.

description

string

Descrizione di ciò che rappresenta l'evento.

isDefaultImageUrl

boolean

Indica se l'immagine dell'icona restituita è un'immagine predefinita o se è fornita dal gioco.

kind

string

Identifica in modo univoco il tipo di questa risorsa. Il valore è sempre la stringa fissa games#eventDefinition.

EventVisibility

Valori possibili per la visibilità di un evento.

Enum
REVEALED Questo evento deve essere visibile a tutti gli utenti.
HIDDEN Questo evento deve essere mostrato solo agli utenti che lo hanno registrato almeno una volta.

EventChild

Una risorsa di relazione figlio evento.

Rappresentazione JSON
{
  "childId": string,
  "kind": string
}
Campi
childId

string

L'ID dell'evento secondario.

kind

string

Identifica in modo univoco il tipo di questa risorsa. Il valore è sempre la stringa fissa games#eventChild.