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