Method: events.listDefinitions

Zwraca listę definicji zdarzeń w tej aplikacji.

Żądanie HTTP

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

Parametry zapytania

Parametry
language

string

Preferowany język używany w przypadku ciągów znaków zwracanych przez tę metodę.
maxResults

integer

Maksymalna liczba definicji zdarzeń zwracanych w odpowiedzi, używanych na potrzeby stronicowania. W przypadku każdej odpowiedzi rzeczywista liczba definicji zdarzeń do zwrócenia może być mniejsza od określonej wartości maxResults.
pageToken

string

Token zwrócony przez poprzednie żądanie.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź ListDefinitions.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
Pola
kind

string

Jednoznacznie identyfikuje typ tego zasobu. Wartością jest zawsze stały ciąg znaków games#eventDefinitionListResponse.
nextPageToken

string

Token podziału na strony dla następnej strony wyników.
items[]

object (EventDefinition)

Definicje zdarzeń.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

EventDefinition

Zasób definicji zdarzenia.

Zapis JSON 
{
  "id": string,
  "visibility": enum (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
Pola
id

string

Identyfikator zdarzenia.
visibility

enum (EventVisibility)

Widoczność zdarzenia śledzonego w tej definicji.
displayName

string

Wyświetlana nazwa zdarzenia.
imageUrl

string

Podstawowy adres URL obrazu reprezentującego zdarzenie.
childEvents[]

object (EventChild)

Lista zdarzeń podrzędnych wobec tego zdarzenia.
description

string

Opis reprezentowanego zdarzenia.
isDefaultImageUrl

boolean

Wskazuje, czy zwracany obraz ikony jest obrazem domyślnym czy pochodzi z gry.
kind

string

Jednoznacznie identyfikuje typ tego zasobu. Wartością jest zawsze stały ciąg znaków games#eventDefinition.

EventVisibility

Możliwe wartości widoczności zdarzenia.

Wartości w polu enum
REVEALED To wydarzenie powinno być widoczne dla wszystkich użytkowników.
HIDDEN To zdarzenie powinno być widoczne tylko dla użytkowników, którzy zarejestrowali je co najmniej raz.

EventChild

Zasób relacji podrzędnej ze zdarzeniem.

Zapis JSON 
{
  "childId": string,
  "kind": string
}
Pola
childId

string

Identyfikator zdarzenia podrzędnego.
kind

string

Jednoznacznie identyfikuje typ tego zasobu. Wartością jest zawsze stały ciąg znaków games#eventChild.