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
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-01-30。
[null,null,["最后更新时间 (UTC):2025-01-30。"],[[["This method lists all shared albums accessible in the Sharing tab of the user's Google Photos app, returning a maximum of 50 albums per request."],["The request must be a `GET` request to the `https://photoslibrary.googleapis.com/v1/sharedAlbums` endpoint and can include optional parameters for pagination and filtering."],["The response includes a list of shared albums and a token for retrieving additional albums if available."],["Authorization is required using one of the specified OAuth scopes, granting varying levels of access to the user's photo library."],["This method will be deprecated on March 31, 2025, due to changes in Photos APIs, so refer to the provided update documentation for migration instructions."]]],["This content outlines how to retrieve a list of shared albums from Google Photos using the `listSharedAlbums` method. It involves sending a `GET` request to `https://photoslibrary.googleapis.com/v1/sharedAlbums` with optional `pageSize`, `pageToken`, and `excludeNonAppCreatedData` query parameters. The request body must be empty. The response contains a list of `sharedAlbums` and a `nextPageToken` for pagination, with the response format being in JSON. Authentication requires one of three specific OAuth scopes. The method will be discontinued on March 31, 2025.\n"]]