- בקשת HTTP
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- EventDefinition
- EventVisibility
- EventChild
- רוצים לנסות?
מחזירה רשימה של הגדרות האירוע באפליקציה הזו.
בקשת HTTP
GET https://games.googleapis.com/games/v1/eventDefinitions
פרמטרים של שאילתה
פרמטרים | |
---|---|
language |
השפה המועדפת לשימוש למחרוזות שמוחזרות בשיטה הזו. |
maxResults |
המספר המקסימלי של הגדרות אירועים שיחזרו בתשובה. המספר הזה משמש לחלוקה לדפים. בכל תגובה, המספר בפועל של הגדרות האירועים שיוחזרו עשוי להיות קטן מהערך שצוין ב- |
pageToken |
האסימון שהוחזר בעקבות הבקשה הקודמת. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
תגובה של ListSettings.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"kind": string,
"nextPageToken": string,
"items": [
{
object ( |
שדות | |
---|---|
kind |
מזהה באופן ייחודי את סוג המשאב הזה. הערך הוא תמיד המחרוזת הקבועה |
nextPageToken |
אסימון החלוקה לדפים של דף התוצאות הבא. |
items[] |
הגדרות האירוע. |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/games
https://www.googleapis.com/auth/games_lite
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
EventDefinition
משאב של הגדרת אירוע.
ייצוג JSON |
---|
{ "id": string, "visibility": enum ( |
שדות | |
---|---|
id |
מזהה האירוע. |
visibility |
החשיפה של אירוע שנמצא במעקב בהגדרה הזו. |
displayName |
השם שיוצג לאירוע. |
imageUrl |
כתובת ה-URL הבסיסית של התמונה שמייצגת את האירוע. |
childEvents[] |
רשימה של אירועים שהם צאצאים של האירוע הזה. |
description |
תיאור של מה שהאירוע הזה מייצג. |
isDefaultImageUrl |
מציין אם תמונת הסמל שהוחזרה היא תמונת ברירת מחדל או שסופקה מתוך המשחק. |
kind |
מזהה באופן ייחודי את סוג המשאב הזה. הערך הוא תמיד המחרוזת הקבועה |
EventVisibility
ערכים אפשריים לחשיפת אירוע.
טיפוסים בני מנייה (enum) | |
---|---|
REVEALED |
האירוע הזה צריך להיות גלוי לכל המשתמשים. |
HIDDEN |
האירוע צריך להופיע רק למשתמשים שהקליטו את האירוע הזה לפחות פעם אחת. |
EventChild
משאב של קשרי גומלין צאצא של אירוע.
ייצוג JSON |
---|
{ "childId": string, "kind": string } |
שדות | |
---|---|
childId |
המזהה של אירוע הצאצא. |
kind |
מזהה באופן ייחודי את סוג המשאב הזה. הערך הוא תמיד המחרוזת הקבועה |