您正在查看 Google Photos Library API 的旧版文档。
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
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-09-12。
[null,null,["最后更新时间 (UTC):2024-09-12。"],[[["Lists all albums displayed in the user's Google Photos Albums tab using the `GET https://photoslibrary.googleapis.com/v1/albums` request."],["Allows pagination with `pageSize` and `pageToken` query parameters to control the number of albums returned and retrieve subsequent pages."],["The response provides a list of `albums` and a `nextPageToken` for further navigation if available."],["Requires authorization with one of the specified OAuth scopes, such as `https://www.googleapis.com/auth/photoslibrary`, for access."],["Can exclude non-app created data using the `excludeNonAppCreatedData` parameter or the `photoslibrary.readonly.appcreateddata` scope."]]],["To retrieve a user's albums from Google Photos, send a `GET` request to `https://photoslibrary.googleapis.com/v1/albums`. The request body must be empty. Optional query parameters include `pageSize` (default 20, max 50), `pageToken` for pagination, and `excludeNonAppCreatedData`. The response contains an array of album objects and `nextPageToken` for subsequent requests. Authorization requires one of three specified OAuth scopes.\n"]]