REST Resource: sessions

משאב: PickingSession

ייצוג של סשן של משתמש שבמהלכו המשתמש יכול לבחור תמונות וסרטונים באמצעות Google Photos.

ייצוג ב-JSON
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "mediaItemsSet": boolean
}
שדות
id

string

פלט בלבד. המזהה שנוצר על ידי Google לסשן הזה.

pickerUri

string

פלט בלבד. ה-URI המשמש להפניה אוטומטית של המשתמשים ל-Google Photos (באינטרנט) כדי שהם יוכלו לבחור תמונות וסרטונים לסשן הנוכחי.

כדי לצפות בדף הזה, המשתמש צריך להיות מחובר לחשבון Google שמוגדר לו בדפדפן האינטרנט שנמצא בבעלות של הסשן הזה.

אי אפשר לפתוח את pickerUri ב-iframe מסיבות אבטחה.

pollingConfig

object (PollingConfig)

פלט בלבד. ההגדרה המומלצת שבה צריכות להשתמש אפליקציות במהלך הסקרים של sessions.get.

השדה הזה מתמלא רק אם עדיין לא נבחרו פריטי מדיה לסשן הזה (כלומר, mediaItemsSet הוא שקר).

expireTime

string (Timestamp format)

פלט בלבד. המועד שבו יפוג תוקף הגישה לסשן הזה (ולפריטי המדיה שנבחרו בו).

חותמת זמן בפורמט 'Zulu' בפורמט RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

mediaItemsSet

boolean

פלט בלבד. אם הערך מוגדר כ-true, המערכת בחרה פריטים של מדיה לסשן הזה והאפליקציה יכולה לבקש את רשימת הפריטים שנבחרו באמצעות mediaItems.list.

PollingConfig

הגדרות לדגימה של ה-API.

ייצוג ב-JSON
{
  "pollInterval": string,
  "timeoutIn": string
}
שדות
pollInterval

string (Duration format)

פלט בלבד. משך הזמן המומלץ בין בקשות לסקרים.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

timeoutIn

string (Duration format)

פלט בלבד. משך הזמן שאחריו הלקוח צריך להפסיק את הבדיקה.

הערך 0 מציין שהלקוח צריך להפסיק את הסקרים, אם הוא עדיין לא עשה זאת.

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. דוגמה: "3.5s".

שיטות

create

יצירת סשן חדש שבו המשתמש יכול לבחור תמונות וסרטונים שיהיו זמינים לצד שלישי.

delete

מוחק את הסשן שצוין.

get

אחזור מידע על הסשן שצוין.