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 מסיבות אבטחה.
pollingConfig

object (PollingConfig)

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

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

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

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