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。