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 . |
محتوا و نمونه کدها در این صفحه مشمول پروانههای توصیفشده در پروانه محتوا هستند. جاوا و OpenJDK علامتهای تجاری یا علامتهای تجاری ثبتشده Oracle و/یا وابستههای آن هستند.
تاریخ آخرین بهروزرسانی 2025-07-29 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2025-07-29 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: events.listDefinitions\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListEventDefinitionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [EventDefinition](#EventDefinition)\n - [JSON representation](#EventDefinition.SCHEMA_REPRESENTATION)\n- [EventVisibility](#EventVisibility)\n- [EventChild](#EventChild)\n - [JSON representation](#EventChild.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReturns a list of the event definitions in this application.\n\n### HTTP request\n\n`GET https://games.googleapis.com/games/v1/eventDefinitions`\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `language` | `string` The preferred language to use for strings returned by this method. |\n| `maxResults` | `integer` The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified `maxResults`. |\n| `pageToken` | `string` The token returned by the previous request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA ListDefinitions response.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"items\": [ { object (/games/services/web/api/rest/v1/events/listDefinitions#EventDefinition) } ] } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`. |\n| `nextPageToken` | `string` The pagination token for the next page of results. |\n| `items[]` | `object (`[EventDefinition](/games/services/web/api/rest/v1/events/listDefinitions#EventDefinition)`)` The event definitions. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/games`\n- `\n https://www.googleapis.com/auth/games_lite`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nEventDefinition\n---------------\n\nAn event definition resource.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"visibility\": enum (/games/services/web/api/rest/v1/events/listDefinitions#EventVisibility), \"displayName\": string, \"imageUrl\": string, \"childEvents\": [ { object (/games/services/web/api/rest/v1/events/listDefinitions#EventChild) } ], \"description\": string, \"isDefaultImageUrl\": boolean, \"kind\": string } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The ID of the event. |\n| `visibility` | `enum (`[EventVisibility](/games/services/web/api/rest/v1/events/listDefinitions#EventVisibility)`)` The visibility of event being tracked in this definition. |\n| `displayName` | `string` The name to display for the event. |\n| `imageUrl` | `string` The base URL for the image that represents the event. |\n| `childEvents[]` | `object (`[EventChild](/games/services/web/api/rest/v1/events/listDefinitions#EventChild)`)` A list of events that are a child of this event. |\n| `description` | `string` Description of what this event represents. |\n| `isDefaultImageUrl` | `boolean` Indicates whether the icon image being returned is a default image, or is game-provided. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`. |\n\nEventVisibility\n---------------\n\nPossible values for the visibility of an event.\n\n| Enums ||\n|------------|---------------------------------------------------------------------------------------|\n| `REVEALED` | This event should be visible to all users. |\n| `HIDDEN` | This event should only be shown to users that have recorded this event at least once. |\n\nEventChild\n----------\n\nAn event child relationship resource.\n\n| JSON representation |\n|-----------------------------------------------|\n| ``` { \"childId\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------------------------------------------------------------|\n| `childId` | `string` The ID of the child event. |\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`. |"]]
