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

מזהה האירוע.
visibility

enum (EventVisibility)

החשיפה של האירוע שנמצא במעקב בהגדרה הזו.
displayName

string

השם שיוצג עבור האירוע.
imageUrl

string

כתובת ה-URL הבסיסית של התמונה שמייצגת את האירוע.
childEvents[]

object (EventChild)

רשימת אירועים שהם צאצאים של האירוע הזה.
description

string

תיאור של מה שהאירוע הזה מייצג.
isDefaultImageUrl

boolean

מציין אם תמונת הסמל שמוחזרת היא תמונת ברירת מחדל או שהיא מסופקת על ידי משחק.
kind

string

מזהה באופן ייחודי את סוג המשאב הזה. הערך הוא תמיד המחרוזת הקבועה games#eventDefinition.

EventVisibility

ערכים אפשריים לחשיפה של אירוע.

טיפוסים בני מנייה (enums)
REVEALED האירוע הזה צריך להיות גלוי לכל המשתמשים.
HIDDEN יש להציג את האירוע הזה רק למשתמשים שתיעדו את האירוע הזה לפחות פעם אחת.

EventChild

משאב של קשר צאצא של אירוע.

ייצוג JSON 
{
  "childId": string,
  "kind": string
}
שדות
childId

string

המזהה של אירוע הצאצא.
kind

string

מזהה באופן ייחודי את סוג המשאב הזה. הערך הוא תמיד המחרוזת הקבועה games#eventChild.