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
  • https://www.googleapis.com/auth/photoslibrary.readonly.originals