方法: 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[]

对象 (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

枚举 (EventVisibility)

此定义中跟踪的事件的可见性。

displayName

string

要显示的事件名称。

imageUrl

string

表示事件的图片的基准 URL。

childEvents[]

对象 (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