Method: events.listDefinitions

Returns a list of the event definitions in this application.

HTTP request

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

Query parameters

Parameters
language

string

The preferred language to use for strings returned by this method.
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.
pageToken

string

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 (EventDefinition)
    }
  ]
}
Fields
kind

string

Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinitionListResponse.
nextPageToken

string

The pagination token for the next page of results.
items[]

object (EventDefinition)

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 (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
Fields
id

string

The ID of the event.
visibility

enum (EventVisibility)

The visibility of event being tracked in this definition.
displayName

string

The name to display for the event.
imageUrl

string

The base URL for the image that represents the event.
childEvents[]

object (EventChild)

A list of events that are a child of this event.
description

string

Description of what this event represents.
isDefaultImageUrl

boolean

Indicates whether the icon image being returned is a default image, or is game-provided.
kind

string

Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinition.

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

string

The ID of the child event.
kind

string

Uniquely identifies the type of this resource. Value is always the fixed string games#eventChild.