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。