Events: listDefinitions

Requires authorization

Returns a list of the event definitions in this application. Try it now.

Request

HTTP request

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

Parameters

Parameter name Value Description
Optional query parameters
consistencyToken long The last-seen mutation timestamp.
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. Acceptable values are 1 to 100, inclusive.
pageToken string The token returned by the previous request.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/games

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "games#eventDefinitionListResponse",
  "nextPageToken": string,
  "items": [
    {
      "kind": "games#eventDefinition",
      "id": string,
      "displayName": string,
      "description": string,
      "imageUrl": string,
      "isDefaultImageUrl": boolean,
      "visibility": string,
      "childEvents": [
        {
          "kind": "games#eventChild",
          "childId": string
        }
      ]
    }
  ]
}
Property name Value Description Notes
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[] list The event definitions.
items[].kind string Uniquely identifies the type of this resource. Value is always the fixed string games#eventDefinition.
items[].id string The ID of the event.
items[].displayName string The name to display for the event.
items[].description string Description of what this event represents.
items[].imageUrl string The base URL for the image that represents the event.
items[].isDefaultImageUrl boolean Indicates whether the icon image being returned is a default image, or is game-provided.
items[].visibility string The visibility of event being tracked in this definition.
Possible values are:
  • "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.


Acceptable values are:
  • "HIDDEN"
  • "REVEALED"
items[].childEvents[] list A list of events that are a child of this event.
items[].childEvents[].kind string Uniquely identifies the type of this resource. Value is always the fixed string games#eventChild.
items[].childEvents[].childId string The ID of the child event.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Enviar comentarios sobre…

Play Games Services for Web
Play Games Services for Web