REST Resource: sessions

משאב: PickingSession

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

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

string

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

string

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

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

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

באפליקציות מבוססות-אינטרנט, אפשר לצרף את /autoclose ל-URI הזה. חלון או כרטיסיית Google Photos ייסגרו אוטומטית אחרי שהמשתמש יסיים לבחור, במקום להציג מסך 'סיום'.
pollingConfig

object (PollingConfig)

פלט בלבד. ההגדרה המומלצת שאפליקציות צריכות להשתמש בה בזמן שליחת בקשות (polling) sessions.get.

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

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
pickingConfig

object (PickingConfig)

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

ההגדרה הזו מצוינת על ידי אפליקציית הלקוח כשמתקשרים אל sessions.create, ואי אפשר לשנות אותה בדיעבד (בלי ליצור סשן חדש).
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".

PickingConfig

הגדרה שצוינה על ידי הלקוח לחוויית הבחירה של המשתמש במהלך הסשן הזה.

ייצוג ב-JSON 
{
  "maxItemCount": string
}
שדות
maxItemCount

string (int64 format)

אופציונלי. מספר הפריטים המקסימלי שהמשתמש יכול לבחור במהלך הסשן. אם לא מציינים ערך, ברירת המחדל היא 2000.

אם לא מציינים ערך או מגדירים את הערך 0, אפשר לבחור עד 2,000 פריטים. ערכים גבוהים מ-2,000 יומרו ל-2,000. ערכים שליליים יגרמו לשגיאה INVALID_ARGUMENT.

Methods

create

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

delete

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

get

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