REST Resource: sessions

資源:PickingSession

使用者工作階段的表示法,在此期間,使用者可以使用 Google 相簿挑選相片和影片。

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

string

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

pickerUri

string

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

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

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

pollingConfig

object (PollingConfig)

僅供輸出。應用程式在輪詢 sessions.get 時應使用的建議設定。

只有在未為這個工作階段選取媒體項目 (也就是 mediaItemsSet 為 false)。

expireTime

string (Timestamp format)

僅供輸出。這個工作階段 (以及所選取的媒體項目) 的存取權到期時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,最多九個小數位數。例如 "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)

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

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

timeoutIn

string (Duration format)

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

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

持續時間以秒為單位,最多 9 個小數位數,結尾為「s」。例如:"3.5s"

方法

create

產生新工作階段,使用者可在該工作階段中選擇相片和影片供第三方存取。

delete

刪除指定的工作階段。

get

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