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 中開啟。
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

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