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
EventDefinition
ทรัพยากรคำจำกัดความเหตุการณ์
| การแสดง 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
ค่าที่เป็นไปได้สำหรับการมองเห็นกิจกรรม
| Enum |
REVEALED |
กิจกรรมนี้ควรแสดงต่อผู้ใช้ทั้งหมด |
HIDDEN |
ควรแสดงกิจกรรมนี้ต่อผู้ใช้ที่บันทึกเหตุการณ์นี้อย่างน้อย 1 ครั้งเท่านั้น |
EventChild
ทรัพยากรความสัมพันธ์ย่อยของเหตุการณ์
| การแสดง JSON |
{
"childId": string,
"kind": string
} |
| ช่อง |
childId |
string
รหัสเหตุการณ์ย่อย
|
kind |
string
ระบุประเภทของทรัพยากรนี้โดยไม่ซ้ำกัน ค่าเป็นสตริงคงที่ games#eventChild เสมอ
|
ตัวอย่างเนื้อหาและโค้ดในหน้าเว็บนี้ขึ้นอยู่กับใบอนุญาตที่อธิบายไว้ในใบอนุญาตการใช้เนื้อหา Java และ OpenJDK เป็นเครื่องหมายการค้าหรือเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-27 UTC
[[["เข้าใจง่าย","easyToUnderstand","thumb-up"],["แก้ปัญหาของฉันได้","solvedMyProblem","thumb-up"],["อื่นๆ","otherUp","thumb-up"]],[["ไม่มีข้อมูลที่ฉันต้องการ","missingTheInformationINeed","thumb-down"],["ซับซ้อนเกินไป/มีหลายขั้นตอนมากเกินไป","tooComplicatedTooManySteps","thumb-down"],["ล้าสมัย","outOfDate","thumb-down"],["ปัญหาเกี่ยวกับการแปล","translationIssue","thumb-down"],["ตัวอย่าง/ปัญหาเกี่ยวกับโค้ด","samplesCodeIssue","thumb-down"],["อื่นๆ","otherDown","thumb-down"]],["อัปเดตล่าสุด 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`. |"]]
