Method: events.listDefinitions

Возвращает список определений событий в этом приложении.

HTTP-запрос

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

Параметры запроса

Параметры
language

string

Предпочтительный язык для строк, возвращаемых этим методом.

maxResults

integer

Максимальное количество определений событий, возвращаемых в ответе, используемых для разбиения по страницам. Для любого ответа фактическое количество возвращаемых определений событий может быть меньше указанного maxResults .

pageToken

string

Токен, возвращенный предыдущим запросом.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ ListDefinitions.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
Поля
kind

string

Уникально определяет тип этого ресурса. Значением всегда является фиксированная строка games#eventDefinitionListResponse .

nextPageToken

string

Токен нумерации страниц для следующей страницы результатов.

items[]

object ( EventDefinition )

Определения событий.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

Дополнительную информацию см. в обзоре OAuth 2.0 .

СобытиеОпределение

Ресурс определения событий.

JSON-представление 
{
  "id": string,
  "visibility": enum (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
Поля
id

string

Идентификатор события.

visibility

enum ( EventVisibility )

Видимость отслеживаемого события в этом определении.

displayName

string

Имя, отображаемое для события.

imageUrl

string

Базовый URL-адрес изображения, представляющего событие.

childEvents[]

object ( EventChild )

Список событий, которые являются дочерними по отношению к этому событию.

description

string

Описание того, что представляет собой это событие.

isDefaultImageUrl

boolean

Указывает, является ли возвращаемое изображение значка изображением по умолчанию или предоставлено игрой.

kind

string

Уникально определяет тип этого ресурса. Значением всегда является фиксированная строка games#eventDefinition .

EventVisibility

Возможные значения видимости события.

Перечисления
REVEALED Это событие должно быть видно всем пользователям.
HIDDEN Это событие должно быть показано только пользователям, которые записали это событие хотя бы один раз.

СобытиеChild

Ресурс дочерних отношений событий.

JSON-представление 
{
  "childId": string,
  "kind": string
}
Поля
childId

string

Идентификатор дочернего события.

kind

string

Уникально определяет тип этого ресурса. Значением всегда является фиксированная строка games#eventChild .