您目前查看的是 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
除非另有註明，否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權，程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間：2025-07-25 (世界標準時間)。
[null,null,["上次更新時間：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`"]]
