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

이벤트를 나타내는 이미지의 기본 URL입니다.

childEvents[]

object (EventChild)

이 이벤트의 하위 이벤트 목록입니다.

description

string

이 이벤트가 나타내는 항목에 관한 설명입니다.

isDefaultImageUrl

boolean

반환되는 아이콘 이미지가 기본 이미지인지 또는 게임에서 제공하는 이미지인지 나타냅니다.

kind

string

이 리소스의 유형을 고유하게 식별합니다. 값은 항상 고정 문자열 games#eventDefinition입니다.

EventVisibility

이벤트 공개 상태의 가능한 값입니다.

Enum
REVEALED 이 이벤트는 모든 사용자에게 표시되어야 합니다.
HIDDEN 이 이벤트는 이 이벤트를 한 번 이상 기록한 사용자에게만 표시해야 합니다.

EventChild

이벤트 하위 관계 리소스입니다.

JSON 표현
{
  "childId": string,
  "kind": string
}
필드
childId

string

하위 이벤트의 ID입니다.

kind

string

이 리소스의 유형을 고유하게 식별합니다. 값은 항상 고정 문자열 games#eventChild입니다.