Method: mediaItems.list

傳回使用者在指定工作階段中選取的媒體項目清單。

如果工作階段沒有任何挑選的媒體項目,因此無法傳回媒體內容,系統會傳回 FAILED_PRECONDITION 錯誤。在這種情況下,在有限輸入裝置上執行的應用程式應轉譯 QR code,將工作階段的 pickerUri 編碼,提示使用者掃描 QR code,並在 Google 相簿選擇器 UI 中選擇媒體項目。在等待使用者挑選商品時,用戶端應每 pollingConfig.pollInterval 輪詢 sessions.get,一次,直到 sessions.get 回應中的 pickedItemsSet = true 為止。屆時,用戶端可以繼續呼叫 mediaItems.list,並預期會收到成功的回應。

HTTP 要求

GET https://photospicker.googleapis.com/v1/mediaItems

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
sessionId

string

必要欄位。Google 為這個工作階段產生的 ID。

pageSize

integer

選用設定。要傳回的媒體項目數量上限。

服務傳回的結果可能會少於這個值 (包括零結果)。如果未指定或設為 0,最多會傳回 50 個媒體項目。值的上限為 100;超過 100 個值會強制轉換為 100。負值會導致 INVALID_ARGUMENT 錯誤。

pageToken

string

選用設定。屬於接收自前一個 mediaItems.list 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

要求主體

要求主體必須為空白。

回應主體

mediaItems.list 遠端程序呼叫 (RPC) 的回應。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "mediaItems": [
    {
      object (PickedMediaItem)
    }
  ],
  "nextPageToken": string
}
欄位
mediaItems[]

object (PickedMediaItem)

含有所選媒體項目的頁面。

nextPageToken

string

可做為 pageToken 傳送的權杖,用於擷取 mediaItems.list 要求中的下一頁。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/photospicker.mediaitems.readonly