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

如果設定完畢，結果會排除並非由這個應用程式建立的媒體項目。預設為 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