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

事件的 ID。
visibility

enum (EventVisibility)

此定義中追蹤的事件顯示設定。
displayName

string

事件的顯示名稱。
imageUrl

string

代表事件的圖片基本網址。
childEvents[]

object (EventChild)

屬於此事件子項的事件清單。
description

string

這個事件代表的內容說明。
isDefaultImageUrl

boolean

指出傳回的圖示圖片是否為預設圖片，或是由遊戲提供。
kind

string

專門識別這個資源的類型。值一律為固定字串 games#eventDefinition。

EventVisibility

事件的顯示設定值可能的值。

列舉
REVEALED 所有使用者都能看到這個活動。
HIDDEN 這個活動只應向已記錄過這個事件至少一次的使用者顯示。

EventChild

活動子項關係資源。

JSON 表示法 
{
  "childId": string,
  "kind": string
}
欄位
childId

string

子事件的 ID。
kind

string

專門識別這個資源的類型。值一律為固定字串 games#eventChild。