Method: events.listDefinitions

Gibt eine Liste der Ereignisdefinitionen in dieser Anwendung zurück.

HTTP-Anfrage

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

Abfrageparameter

Parameter
language

string

Die bevorzugte Sprache, die für Strings verwendet wird, die von dieser Methode zurückgegeben werden.
maxResults

integer

Die maximale Anzahl von Ereignisdefinitionen, die in der Antwort zurückgegeben werden sollen; wird für die Seitenordnung verwendet. Bei jeder Antwort kann die tatsächliche Anzahl der zurückzugebenden Ereignisdefinitionen kleiner als maxResults sein.
pageToken

string

Das von der vorherigen Anfrage zurückgegebene Token.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine ListDefinitions-Antwort.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
Felder
kind

string

Identifiziert eindeutig den Typ dieser Ressource. Der Wert ist immer der feste String games#eventDefinitionListResponse.
nextPageToken

string

Das Paginierungstoken für die nächste Ergebnisseite.
items[]

object (EventDefinition)

Die Ereignisdefinitionen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

EventDefinition

Eine Ereignisdefinitionsressource.

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

string

Die ID des Ereignisses.
visibility

enum (EventVisibility)

Die Sichtbarkeit des Ereignisses, das in dieser Definition erfasst wird.
displayName

string

Der Name, der für das Ereignis angezeigt werden soll.
imageUrl

string

Die Basis-URL für das Bild, das das Ereignis repräsentiert.
childEvents[]

object (EventChild)

Eine Liste von Ereignissen, die diesem Ereignis untergeordnet sind.
description

string

Beschreibung dessen, wofür dieses Ereignis steht.
isDefaultImageUrl

boolean

Gibt an, ob das zurückgegebene Symbolbild ein Standardbild ist oder vom Spiel bereitgestellt wird.
kind

string

Identifiziert eindeutig den Typ dieser Ressource. Der Wert ist immer der feste String games#eventDefinition.

EventVisibility

Mögliche Werte für die Sichtbarkeit eines Ereignisses.

Enums
REVEALED Dieses Ereignis sollte für alle Nutzer sichtbar sein.
HIDDEN Dieses Ereignis sollte nur Nutzern angezeigt werden, die es mindestens einmal aufgezeichnet haben.

EventChild

Eine untergeordnete Ereignisbeziehungsressource.

JSON-Darstellung 
{
  "childId": string,
  "kind": string
}
Felder
childId

string

Die ID des untergeordneten Ereignisses.
kind

string

Identifiziert eindeutig den Typ dieser Ressource. Der Wert ist immer der feste String games#eventChild.