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 เสมอ