REST Resource: sessions

資源：PickingSession

代表使用者工作階段，使用者可在這段期間使用 Google 相簿挑選相片和影片。

JSON 表示法 
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
欄位
id

string

僅供輸出。Google 為這個工作階段產生的 ID。
pickerUri

string

僅供輸出。用於將使用者重新導向至 Google 相簿 (網頁版) 的 URI，以便使用者為目前的工作階段挑選相片和影片。

如要順利查看這個頁面，使用者必須在網頁瀏覽器中登入擁有這個工作階段的 Google 帳戶。

基於安全考量，pickerUri 無法在 iframe 中開啟。

如果是網頁應用程式，您可以在這個 URI 後方附加 /autoclose。使用者選取完畢後，Google 相簿視窗或分頁就會自動關閉，不會顯示「完成」畫面。
pollingConfig

object (PollingConfig)

僅供輸出。應用程式輪詢 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)

僅供輸出。建議的輪詢要求間隔時間。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
timeoutIn

string (Duration format)

僅供輸出。用戶端應停止輪詢的時間長度。

如果值為 0，表示用戶端應停止輪詢 (如果尚未停止)。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。

PickingConfig

用戶端指定的設定，用於設定使用者在本次工作階段的揀貨體驗。

JSON 表示法 
{
  "maxItemCount": string
}
欄位
maxItemCount

string (int64 format)

(選用步驟) 使用者在本次工作階段中可選取的項目數量上限。如果未指定，預設值為 2000。

如未指定或設為 0，最多可挑選 2000 個項目。如果值超過 2000，系統會強制設為 2000。如果值為負數，系統會傳回 INVALID_ARGUMENT 錯誤。

方法

create

 產生新工作階段，使用者可在其中選取要開放第三方存取的相片和影片。

delete

 刪除指定工作階段。

get

 擷取指定工作階段的相關資訊。