- HTTP request
- Query parameters
- Request body
- Response body
- Authorization scopes
- EventDefinition
- EventVisibility
- EventChild
- Try it!
Returns a list of the event definitions in this application.
HTTP request
GET https://games.googleapis.com/games/v1/eventDefinitions
Query parameters
Parameters | |
---|---|
language |
The preferred language to use for strings returned by this method. |
maxResults |
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 |
pageToken |
The token returned by the previous request. |
Request body
The request body must be empty.
Response body
A ListDefinitions response.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"kind": string,
"nextPageToken": string,
"items": [
{
object ( |
Fields | |
---|---|
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
nextPageToken |
The pagination token for the next page of results. |
items[] |
The event definitions. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/games
https://www.googleapis.com/auth/games_lite
For more information, see the OAuth 2.0 Overview.
EventDefinition
An event definition resource.
JSON representation |
---|
{ "id": string, "visibility": enum ( |
Fields | |
---|---|
id |
The ID of the event. |
visibility |
The visibility of event being tracked in this definition. |
displayName |
The name to display for the event. |
imageUrl |
The base URL for the image that represents the event. |
childEvents[] |
A list of events that are a child of this event. |
description |
Description of what this event represents. |
isDefaultImageUrl |
Indicates whether the icon image being returned is a default image, or is game-provided. |
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |
EventVisibility
Possible values for the visibility of an event.
Enums | |
---|---|
REVEALED |
This event should be visible to all users. |
HIDDEN |
This event should only be shown to users that have recorded this event at least once. |
EventChild
An event child relationship resource.
JSON representation |
---|
{ "childId": string, "kind": string } |
Fields | |
---|---|
childId |
The ID of the child event. |
kind |
Uniquely identifies the type of this resource. Value is always the fixed string |