Method: events.listDefinitions
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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 für Strings, 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 der angegebene 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
Kennzeichnet den Typ dieser Ressource eindeutig. 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 Ressource zur Ereignisdefinition.
| 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 darstellt.
|
childEvents[] |
object (EventChild)
Eine Liste der Ereignisse, die diesem Ereignis untergeordnet sind.
|
description |
string
Beschreibung dieses Ereignisses.
|
isDefaultImageUrl |
boolean
Gibt an, ob das zurückgegebene Symbolbild ein Standardbild oder ein Spiel ist.
|
kind |
string
Kennzeichnet den Typ dieser Ressource eindeutig. 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 erfasst haben. |
EventChild
Eine untergeordnete Ereignisbeziehungsressource.
| JSON-Darstellung |
{
"childId": string,
"kind": string
} |
| Felder |
childId |
string
Die ID des untergeordneten Ereignisses.
|
kind |
string
Kennzeichnet den Typ dieser Ressource eindeutig. Der Wert ist immer der feste String games#eventChild.
|
Alle Inhalte und Codebeispiele auf dieser Seite unterliegen den Lizenzen wie im Abschnitt Inhaltslizenz beschrieben. Java und OpenJDK sind Marken oder eingetragene Marken von Oracle und/oder seinen Tochtergesellschaften.
Zuletzt aktualisiert: 2025-07-27 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-27 (UTC)."],[],[],null,["# Method: events.listDefinitions\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListEventDefinitionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [EventDefinition](#EventDefinition)\n - [JSON representation](#EventDefinition.SCHEMA_REPRESENTATION)\n- [EventVisibility](#EventVisibility)\n- [EventChild](#EventChild)\n - [JSON representation](#EventChild.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReturns a list of the event definitions in this application.\n\n### HTTP request\n\n`GET https://games.googleapis.com/games/v1/eventDefinitions`\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `language` | `string` The preferred language to use for strings returned by this method. |\n| `maxResults` | `integer` The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified `maxResults`. |\n| `pageToken` | `string` The token returned by the previous request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA ListDefinitions response.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"items\": [ { object (/games/services/web/api/rest/v1/events/listDefinitions#EventDefinition) } ] } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`. |\n| `nextPageToken` | `string` The pagination token for the next page of results. |\n| `items[]` | `object (`[EventDefinition](/games/services/web/api/rest/v1/events/listDefinitions#EventDefinition)`)` The event definitions. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/games`\n- `\n https://www.googleapis.com/auth/games_lite`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nEventDefinition\n---------------\n\nAn event definition resource.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"visibility\": enum (/games/services/web/api/rest/v1/events/listDefinitions#EventVisibility), \"displayName\": string, \"imageUrl\": string, \"childEvents\": [ { object (/games/services/web/api/rest/v1/events/listDefinitions#EventChild) } ], \"description\": string, \"isDefaultImageUrl\": boolean, \"kind\": string } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The ID of the event. |\n| `visibility` | `enum (`[EventVisibility](/games/services/web/api/rest/v1/events/listDefinitions#EventVisibility)`)` The visibility of event being tracked in this definition. |\n| `displayName` | `string` The name to display for the event. |\n| `imageUrl` | `string` The base URL for the image that represents the event. |\n| `childEvents[]` | `object (`[EventChild](/games/services/web/api/rest/v1/events/listDefinitions#EventChild)`)` A list of events that are a child of this event. |\n| `description` | `string` Description of what this event represents. |\n| `isDefaultImageUrl` | `boolean` Indicates whether the icon image being returned is a default image, or is game-provided. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`. |\n\nEventVisibility\n---------------\n\nPossible values for the visibility of an event.\n\n| Enums ||\n|------------|---------------------------------------------------------------------------------------|\n| `REVEALED` | This event should be visible to all users. |\n| `HIDDEN` | This event should only be shown to users that have recorded this event at least once. |\n\nEventChild\n----------\n\nAn event child relationship resource.\n\n| JSON representation |\n|-----------------------------------------------|\n| ``` { \"childId\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------------------------------------------------------------|\n| `childId` | `string` The ID of the child event. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`. |"]]
