Method: events.listDefinitions

Trả về danh sách các định nghĩa sự kiện trong ứng dụng này.

Yêu cầu HTTP

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

Tham số truy vấn

Các tham số
language

string

Ngôn ngữ ưu tiên dùng cho các chuỗi được phương thức này trả về.
maxResults

integer

Số lượng định nghĩa sự kiện tối đa cần trả về trong phản hồi, dùng để phân trang. Đối với mọi phản hồi, số lượng định nghĩa sự kiện thực tế cần trả về có thể ít hơn maxResults được chỉ định.
pageToken

string

Mã thông báo được yêu cầu trước đó trả về.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi ListDefinition.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
Các trường
kind

string

Xác định duy nhất loại tài nguyên này. Giá trị luôn là chuỗi cố định games#eventDefinitionListResponse.
nextPageToken

string

Mã phân trang cho trang kết quả tiếp theo.
items[]

object (EventDefinition)

Định nghĩa sự kiện.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

EventDefinition

Tài nguyên định nghĩa sự kiện.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "visibility": enum (EventVisibility),
  "displayName": string,
  "imageUrl": string,
  "childEvents": [
    {
      object (EventChild)
    }
  ],
  "description": string,
  "isDefaultImageUrl": boolean,
  "kind": string
}
Các trường
id

string

Mã của sự kiện.
visibility

enum (EventVisibility)

Chế độ hiển thị của sự kiện đang được theo dõi trong định nghĩa này.
displayName

string

Tên hiển thị cho sự kiện.
imageUrl

string

URL cơ sở cho hình ảnh biểu thị sự kiện.
childEvents[]

object (EventChild)

Danh sách các sự kiện là phần tử con của sự kiện này.
description

string

Mô tả về nội dung của sự kiện này.
isDefaultImageUrl

boolean

Cho biết liệu hình ảnh biểu tượng được trả về là hình ảnh mặc định hay do trò chơi cung cấp.
kind

string

Xác định duy nhất loại tài nguyên này. Giá trị luôn là chuỗi cố định games#eventDefinition.

EventVisibility

Giá trị có thể cho chế độ hiển thị của một sự kiện.

Enum
REVEALED Tất cả người dùng đều có thể thấy sự kiện này.
HIDDEN Chỉ những người dùng đã ghi lại sự kiện này ít nhất một lần mới được nhìn thấy sự kiện này.

EventChild

Tài nguyên mối quan hệ con sự kiện.

Biểu diễn dưới dạng JSON 
{
  "childId": string,
  "kind": string
}
Các trường
childId

string

Mã của sự kiện con.
kind

string

Xác định duy nhất loại tài nguyên này. Giá trị luôn là chuỗi cố định games#eventChild.