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

設定後,結果會排除不是由這個應用程式建立的媒體項目。預設值為 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