Method: sharedAlbums.list

列出用户 Google 相册应用“分享”标签页中提供的所有共享影集。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

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

pageToken

string

获得下一页结果的延续令牌。将此属性添加到请求中,即可返回 pageToken 后面的行。在对 listSharedAlbums 请求的响应中,pageToken 应该是 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