- Żądanie HTTP
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- EventDefinition
- EventVisibility
- EventChild
- Wypróbuj
Zwraca listę definicji zdarzeń w tej aplikacji.
Żądanie HTTP
GET https://games.googleapis.com/games/v1/eventDefinitions
Parametry zapytania
Parametry | |
---|---|
language |
Preferowany język używany w przypadku ciągów znaków zwracanych przez tę metodę. |
maxResults |
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 |
pageToken |
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 ( |
Pola | |
---|---|
kind |
Jednoznacznie identyfikuje typ tego zasobu. Wartością jest zawsze stały ciąg znaków |
nextPageToken |
Token podziału na strony dla następnej strony wyników. |
items[] |
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 ( |
Pola | |
---|---|
id |
Identyfikator zdarzenia. |
visibility |
Widoczność zdarzenia śledzonego w tej definicji. |
displayName |
Wyświetlana nazwa zdarzenia. |
imageUrl |
Podstawowy adres URL obrazu reprezentującego zdarzenie. |
childEvents[] |
Lista zdarzeń podrzędnych wobec tego zdarzenia. |
description |
Opis reprezentowanego zdarzenia. |
isDefaultImageUrl |
Wskazuje, czy zwracany obraz ikony jest obrazem domyślnym czy pochodzi z gry. |
kind |
Jednoznacznie identyfikuje typ tego zasobu. Wartością jest zawsze stały ciąg znaków |
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 |
Identyfikator zdarzenia podrzędnego. |
kind |
Jednoznacznie identyfikuje typ tego zasobu. Wartością jest zawsze stały ciąg znaków |