您正在查看 Google Photos Library API 的旧版文档。
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-07-25。
[null,null,["最后更新时间 (UTC)：2025-07-25。"],[[["\u003cp\u003eThis API lists all shared albums accessible through the user's Google Photos Sharing tab.\u003c/p\u003e\n"],["\u003cp\u003eIt supports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for handling large result sets.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of shared albums and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required with one of the specified OAuth scopes, including readonly and app-created data options.\u003c/p\u003e\n"]]],["This document details how to list shared albums from a user's Google Photos library. Use a `GET` request to `https://photoslibrary.googleapis.com/v1/sharedAlbums`. Optional query parameters `pageSize` (default 20, max 50), `pageToken` (for pagination), and `excludeNonAppCreatedData` (default false) modify the results. The request body must be empty. The response includes a list of `sharedAlbums` and a `nextPageToken` for pagination. Authorization requires one of three specified OAuth scopes.\n"],null,["# Method: sharedAlbums.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListSharedAlbumsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all shared albums available in the Sharing tab of the user's Google Photos app.\n\n### HTTP request\n\n`GET https://photoslibrary.googleapis.com/v1/sharedAlbums`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default `pageSize` is 20, the maximum is 50. |\n| `pageToken` | `string` A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listSharedAlbums` request. |\n| `excludeNonAppCreatedData` | `boolean` If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nList of shared albums requested.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"sharedAlbums\": [ { object (/photos/library/legacy/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sharedAlbums[]` | `object (`[Album](/photos/library/legacy/reference/rest/v1/albums#Album)`)` Output only. List of shared albums. |\n| `nextPageToken` | `string` Output only. Token to use to get the next set of shared albums. Populated if there are more shared albums to retrieve for this request. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/photoslibrary`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata`"]]
