2025 年 4 月 1 日,Library API 中的部分範圍已遭到移除。
詳情請參閱這篇文章。
Method: albums.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
HTTP 要求
GET https://photoslibrary.googleapis.com/v1/albums
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 |
pageSize |
integer
回覆中傳回的專輯數量上限。傳回的專輯數量可能少於指定數量。預設 pageSize 為 20,上限為 50。
|
pageToken |
string
用來取得結果下一頁的接續符記。將這項值加入要求後,系統會傳回 pageToken 之後的資料列。pageToken 應為 listAlbums 要求回應中 nextPageToken 參數傳回的值。
|
excludeNonAppCreatedData |
boolean
如果設為 true,結果就會排除非由此應用程式建立的媒體項目。預設值為 false (會傳回所有專輯)。如果使用 photoslibrary.readonly.appcreateddata 範圍,系統會忽略這個欄位。
|
回應主體
要求的相簿清單。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
{
"albums": [
{
object (Album )
}
],
"nextPageToken": string
} |
欄位 |
albums[] |
object (Album )
僅供輸出。使用者 Google 相簿應用程式「相簿」分頁中顯示的相簿清單。
|
nextPageToken |
string
僅供輸出。用於取得下一組相簿的符記。如果此要求需要擷取更多專輯,就會填入這個值。
|
授權範圍
需要下列其中一種 OAuth 範圍:
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\u003eLists all albums displayed in the user's Google Photos Albums tab.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size, page token, and excluding non-app created data.\u003c/p\u003e\n"],["\u003cp\u003eResponses include an array of albums and a token for retrieving further pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, with some legacy scopes being phased out.\u003c/p\u003e\n"],["\u003cp\u003eFunctionality will be limited to app-created media starting March 31, 2025.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of albums from the Google Photos app using the `GET https://photoslibrary.googleapis.com/v1/albums` request. The request requires no body but accepts `pageSize`, `pageToken`, and `excludeNonAppCreatedData` as query parameters. The response includes an array of albums and an optional `nextPageToken` for pagination. It also outlines the required authorization scopes and indicates that certain scopes will limit functionality to app-created content after March 31, 2025.\n"],null,["# Method: albums.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.ListAlbumsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all albums created by your app.\n\n### HTTP request\n\n`GET https://photoslibrary.googleapis.com/v1/albums`\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 `listAlbums` 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 albums requested.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------|\n| ``` { \"albums\": [ { object (/photos/library/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `albums[]` | `object (`[Album](/photos/library/reference/rest/v1/albums#Album)`)` Output only. List of albums shown in the Albums tab of the user's Google Photos app. |\n| `nextPageToken` | `string` Output only. Token to use to get the next set of albums. Populated if there are more albums to retrieve for this request. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata`"]]