Method: albums.list

列出 Google 相簿應用程式「相簿」分頁中向使用者顯示的所有相簿。

HTTP 要求

GET https://photoslibrary.googleapis.com/v1/albums

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

查詢參數

參數
pageSize

integer

要在回應中傳回的相簿數量上限。傳回的相簿數量可能會少於指定數量。pageSize 的預設值為 20,最大值為 50。

pageToken

string

用於取得結果下一頁的接續權杖。將此項目加入要求,會傳回 pageToken 之後的資料列。pageToken 應為回應 listAlbums 要求在 nextPageToken 參數中傳回的值。

excludeNonAppCreatedData

boolean

如果設為 true,結果就會排除非由這個應用程式建立的媒體項目。預設值為 false (會傳回所有專輯)。如果使用 photoslibrary.readonly.appcreateddata 範圍,系統就會忽略這個欄位。

要求主體

要求主體必須為空白。

回應主體

要求的相簿清單。

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

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

object (Album)

僅供輸出。使用者 Google 相簿應用程式「相簿」分頁中顯示的相簿清單。

nextPageToken

string

僅供輸出。取得下一組相簿時使用的權杖。如果還有其他相簿需要擷取,就會填入此欄位。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/photoslibrary
  • https://www.googleapis.com/auth/photoslibrary.readonly
  • https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata