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

شناسه رویداد.

visibility

enum ( EventVisibility )

قابلیت مشاهده رویدادی که در این تعریف ردیابی می شود.

displayName

string

نامی که برای رویداد نمایش داده می شود.

imageUrl

string

URL پایه تصویری که رویداد را نشان می دهد.

childEvents[]

object ( EventChild )

لیستی از رویدادهایی که فرزند این رویداد هستند.

description

string

شرح آنچه این رویداد نشان می دهد.

isDefaultImageUrl

boolean

نشان می دهد که آیا تصویر نمادی که برگردانده می شود یک تصویر پیش فرض است یا توسط بازی ارائه شده است.

kind

string

منحصر به فرد نوع این منبع را شناسایی می کند. مقدار همیشه games#eventDefinition .

رویت رویداد

مقادیر ممکن برای نمایان بودن یک رویداد.

Enums
REVEALED این رویداد باید برای همه کاربران قابل مشاهده باشد.
HIDDEN این رویداد فقط باید به کاربرانی نشان داده شود که حداقل یک بار این رویداد را ثبت کرده باشند.

EventChild

منبع رابطه کودک رویداد.

نمایندگی JSON 
{
  "childId": string,
  "kind": string
}
فیلدها
childId

string

شناسه رویداد کودک.

kind

string

منحصر به فرد نوع این منبع را شناسایی می کند. ارزش همیشه games#eventChild .