Method: events.listDefinitions

Menampilkan daftar definisi peristiwa dalam aplikasi ini.

Permintaan HTTP

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

Parameter kueri

Parameter
language

string

Bahasa yang dipilih untuk digunakan pada string yang ditampilkan oleh metode ini.

maxResults

integer

Jumlah maksimum definisi peristiwa untuk ditampilkan dalam respons, yang digunakan untuk paging. Untuk respons apa pun, jumlah definisi peristiwa sebenarnya yang akan ditampilkan mungkin kurang dari maxResults yang ditentukan.

pageToken

string

Token yang ditampilkan oleh permintaan sebelumnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons ListDefinitions.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

string

Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#eventDefinitionListResponse.

nextPageToken

string

Token penomoran halaman untuk halaman hasil berikutnya.

items[]

object (EventDefinition)

Definisi peristiwa.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

EventDefinition

Resource definisi peristiwa.

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

string

ID peristiwa.

visibility

enum (EventVisibility)

Visibilitas peristiwa yang sedang dilacak dalam definisi ini.

displayName

string

Nama yang akan ditampilkan untuk peristiwa.

imageUrl

string

URL dasar untuk gambar yang mewakili peristiwa.

childEvents[]

object (EventChild)

Daftar peristiwa yang merupakan turunan dari peristiwa ini.

description

string

Deskripsi yang diwakili oleh peristiwa ini.

isDefaultImageUrl

boolean

Menunjukkan apakah gambar ikon yang ditampilkan adalah gambar default, atau disediakan game.

kind

string

Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#eventDefinition.

EventVisibility

Nilai yang mungkin untuk visibilitas peristiwa.

Enum
REVEALED Acara ini harus terlihat oleh semua pengguna.
HIDDEN Peristiwa ini hanya boleh ditampilkan kepada pengguna yang telah merekam peristiwa ini setidaknya satu kali.

EventChild

Resource hubungan turunan peristiwa.

Representasi JSON
{
  "childId": string,
  "kind": string
}
Kolom
childId

string

ID peristiwa turunan.

kind

string

Secara unik mengidentifikasi jenis resource ini. Nilai selalu berupa string tetap games#eventChild.