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 の概要をご覧ください。

イベント定義

イベント定義リソース。

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

イベントを表す画像のベース URL。
childEvents[]

object (EventChild)

このイベントの子であるイベントのリスト。
description

string

このイベントが表す内容の説明。
isDefaultImageUrl

boolean

返されるアイコン画像がデフォルトの画像か、ゲームから提供されたアイコンかを示します。
kind

string

このリソースのタイプを一意に識別します。値は常に固定文字列 games#eventDefinition です。

イベントの公開設定

イベントの公開設定として指定できる値。

列挙型
REVEALED このイベントはすべてのユーザーに表示されるようにする必要があります。
HIDDEN このイベントは、このイベントを 1 回以上記録したユーザーにのみ表示します。

EventChild

イベントの子関係リソース。

JSON 表現 
{
  "childId": string,
  "kind": string
}
フィールド
childId

string

子イベントの ID。
kind

string

このリソースのタイプを一意に識別します。値は常に固定文字列 games#eventChild です。