方法:events.listDefinitions

返回此应用中事件定义的列表。

HTTP 请求

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

查询参数

参数
language

字符串

此方法返回的字符串的首选语言。

maxResults

整数

响应中返回的事件定义的最大数量,用于分页。对于任何响应,实际返回的事件定义数量都可能小于指定的 maxResults

pageToken

字符串

先前请求返回的令牌。

请求正文

请求正文必须为空。

响应正文

ListDefinitions 响应。

如果成功,响应正文将包含以下结构的数据

JSON 表示形式
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (EventDefinition)
    }
  ]
}
字段
kind

字符串

唯一标识此资源的类型。值始终是固定字符串 games#eventDefinitionListResponse

nextPageToken

字符串

下一页结果的分页标记。

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

字符串

事件的 ID。

visibility

枚举 (EventVisibility)

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

displayName

字符串

事件的显示名称。

imageUrl

字符串

表示事件的图像的基本 URL。

childEvents[]

对象 (EventChild)

此事件的子事件列表。

description

字符串

此事件代表内容的描述。

isDefaultImageUrl

布尔值

指示返回的图标图像是否为默认图像,或者是由游戏提供的图像。

kind

字符串

唯一标识此资源的类型。值始终是固定字符串 games#eventDefinition

EventVisibility

事件可见性的可能值。

枚举
REVEALED 此事件应对所有用户可见。
HIDDEN 此事件仅应显示给至少记录过此事件一次的用户。

EventChild

事件子级关系资源。

JSON 表示形式
{
  "childId": string,
  "kind": string
}
字段
childId

字符串

子事件的 ID。

kind

字符串

唯一标识此资源的类型。值始终是固定字符串 games#eventChild