Method: events.listDefinitions

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

בקשת HTTP

GET https://games.googleapis.com/games/v1/eventDefinitions

פרמטרים של שאילתה

פרמטרים
language

string

השפה המועדפת לשימוש למחרוזות שמוחזרות בשיטה הזו.
maxResults

integer

המספר המקסימלי של הגדרות אירועים שיחזרו בתשובה. המספר הזה משמש לחלוקה לדפים. בכל תגובה, מספר הגדרות האירועים שיוחזרו בפועל עשוי להיות קטן מ-maxResults שצוין.
pageToken

string

האסימון שהוחזר בעקבות הבקשה הקודמת.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תגובה של ListSettings.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג 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

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

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

EventChild

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

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

string

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

string

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