Method: albums.list

列出 Google 相册应用的“影集”标签页中向用户显示的所有影集。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

响应中可返回的影集数量上限。返回的影集数量可能会少于指定的数量。pageSize 的默认值为 20,最大值为 50。

pageToken

string

获得下一页结果的延续令牌。将此内容添加到请求中会返回 pageToken 之后的行。在对 listAlbums 请求的响应中,pageToken 应为 nextPageToken 参数中返回的值。

excludeNonAppCreatedData

boolean

如果设置此字段,则结果会排除并非由此应用创建的媒体内容。默认值为 false(系统将返回所有影集)。如果使用 photoslibrary.readonly.app createddata 范围,系统将忽略此字段。

请求正文

请求正文必须为空。

响应正文

请求的影集列表。

如果成功,响应正文将包含结构如下的数据:

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