Method: sharedAlbums.list

列出使用者 Google 相簿應用程式「分享」分頁中提供的所有共用相簿。

HTTP 要求

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

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

查詢參數

參數
pageSize

integer

回應中傳回的專輯數量上限。傳回的專輯數量可能少於指定數量。預設 pageSize 為 20,上限為 50。

pageToken

string

用來取得結果下一頁的接續符記。將這項值加入要求後,系統會傳回 pageToken 之後的資料列。pageToken 應為 listSharedAlbums 要求回應中 nextPageToken 參數傳回的值。

excludeNonAppCreatedData

boolean

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

要求主體

要求主體必須為空白。

回應主體

要求的共享相簿清單。

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

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

object (Album)

僅供輸出。共享相簿清單。

nextPageToken

string

僅供輸出。用於取得下一組共享相簿的符記。如果這項要求需要擷取更多共享相簿,就會填入這個值。

授權範圍

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

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