Method: events.listDefinitions
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Menampilkan daftar definisi peristiwa dalam aplikasi ini.
Permintaan HTTP
GET https://games.googleapis.com/games/v1/eventDefinitions
Parameter kueri
| Parameter |
language |
string
Bahasa yang lebih disukai untuk digunakan untuk string yang ditampilkan oleh metode ini.
|
maxResults |
integer
Jumlah maksimum definisi peristiwa yang akan ditampilkan dalam respons, yang digunakan untuk paging. Untuk respons apa pun, jumlah sebenarnya definisi peristiwa 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 berisi data dengan struktur berikut:
| Representasi JSON |
{
"kind": string,
"nextPageToken": string,
"items": [
{
object (EventDefinition)
}
]
} |
| Kolom |
kind |
string
Secara unik mengidentifikasi jenis resource ini. Nilainya 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 kejadian.
|
visibility |
enum (EventVisibility)
Visibilitas peristiwa yang 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 tentang apa yang diwakili oleh peristiwa ini.
|
isDefaultImageUrl |
boolean
Menunjukkan apakah gambar ikon yang ditampilkan adalah gambar default, atau disediakan oleh game.
|
kind |
string
Secara unik mengidentifikasi jenis resource ini. Nilainya selalu berupa string tetap games#eventDefinition.
|
EventVisibility
Kemungkinan nilai untuk visibilitas peristiwa.
| Enum |
REVEALED |
Peristiwa ini akan terlihat oleh semua pengguna. |
HIDDEN |
Peristiwa ini hanya boleh ditampilkan kepada pengguna yang telah mencatat 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. Nilainya selalu berupa string tetap games#eventChild.
|
Konten dan contoh kode di halaman ini tunduk kepada lisensi yang dijelaskan dalam Lisensi Konten. Java dan OpenJDK adalah merek dagang atau merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-27 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-27 UTC."],[],[],null,["# Method: events.listDefinitions\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListEventDefinitionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [EventDefinition](#EventDefinition)\n - [JSON representation](#EventDefinition.SCHEMA_REPRESENTATION)\n- [EventVisibility](#EventVisibility)\n- [EventChild](#EventChild)\n - [JSON representation](#EventChild.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReturns a list of the event definitions in this application.\n\n### HTTP request\n\n`GET https://games.googleapis.com/games/v1/eventDefinitions`\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `language` | `string` The preferred language to use for strings returned by this method. |\n| `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`. |\n| `pageToken` | `string` The token returned by the previous request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA ListDefinitions response.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"items\": [ { object (/games/services/web/api/rest/v1/events/listDefinitions#EventDefinition) } ] } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`. |\n| `nextPageToken` | `string` The pagination token for the next page of results. |\n| `items[]` | `object (`[EventDefinition](/games/services/web/api/rest/v1/events/listDefinitions#EventDefinition)`)` The event definitions. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/games`\n- `\n https://www.googleapis.com/auth/games_lite`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nEventDefinition\n---------------\n\nAn event definition resource.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"visibility\": enum (/games/services/web/api/rest/v1/events/listDefinitions#EventVisibility), \"displayName\": string, \"imageUrl\": string, \"childEvents\": [ { object (/games/services/web/api/rest/v1/events/listDefinitions#EventChild) } ], \"description\": string, \"isDefaultImageUrl\": boolean, \"kind\": string } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The ID of the event. |\n| `visibility` | `enum (`[EventVisibility](/games/services/web/api/rest/v1/events/listDefinitions#EventVisibility)`)` The visibility of event being tracked in this definition. |\n| `displayName` | `string` The name to display for the event. |\n| `imageUrl` | `string` The base URL for the image that represents the event. |\n| `childEvents[]` | `object (`[EventChild](/games/services/web/api/rest/v1/events/listDefinitions#EventChild)`)` A list of events that are a child of this event. |\n| `description` | `string` Description of what this event represents. |\n| `isDefaultImageUrl` | `boolean` Indicates whether the icon image being returned is a default image, or is game-provided. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`. |\n\nEventVisibility\n---------------\n\nPossible values for the visibility of an event.\n\n| Enums ||\n|------------|---------------------------------------------------------------------------------------|\n| `REVEALED` | This event should be visible to all users. |\n| `HIDDEN` | This event should only be shown to users that have recorded this event at least once. |\n\nEventChild\n----------\n\nAn event child relationship resource.\n\n| JSON representation |\n|-----------------------------------------------|\n| ``` { \"childId\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------------------------------------------------------------|\n| `childId` | `string` The ID of the child event. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`. |"]]
