Method: events.listDefinitions
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Restituisce un elenco delle definizioni degli eventi in questa applicazione.
Richiesta HTTP
GET https://games.googleapis.com/games/v1/eventDefinitions
Parametri di query
| 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)
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 di eventi.
| 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 dell'immagine che rappresenta l'evento.
|
childEvents[] |
object (EventChild)
Un elenco di eventi secondari di questo evento.
|
description |
string
Descrizione di ciò che rappresenta questo evento.
|
isDefaultImageUrl |
boolean
Indica se l'immagine dell'icona restituita è un'immagine predefinita o è fornita dal gioco.
|
kind |
string
Identifica in modo univoco il tipo di questa risorsa. Il valore è sempre la stringa fissa games#eventDefinition.
|
EventVisibility
I 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 della relazione secondaria dell'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.
|
I campioni di contenuti e codice in questa pagina sono soggetti alle licenze descritte nella Licenza per i contenuti. Java e OpenJDK sono marchi o marchi registrati di Oracle e/o delle sue società consociate.
Ultimo aggiornamento 2025-07-27 UTC.
[null,null,["Ultimo aggiornamento 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`. |"]]
