Method: albums.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
רשימה של כל האלבומים שנוצרו על ידי האפליקציה.
בקשת HTTP
GET https://photoslibrary.googleapis.com/v1/albums
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
| פרמטרים |
pageSize |
integer
המספר המקסימלי של אלבומים שיופיעו בתגובה. יכול להיות שיוחזר פחות אלבומים מהמספר שצוין. ערך ברירת המחדל של pageSize הוא 20, והערך המקסימלי הוא 50.
|
pageToken |
string
אסימון המשך כדי לקבל את דף התוצאות הבא. הוספת הערך הזה לבקשה מחזירה את השורות אחרי pageToken. הערך של pageToken צריך להיות הערך שמוחזר בפרמטר nextPageToken בתגובה לבקשה listAlbums.
|
excludeNonAppCreatedData |
boolean
אם ההגדרה מוגדרת, התוצאות לא יכללו פריטים של מדיה שלא נוצרו על ידי האפליקציה הזו. ברירת המחדל היא false (כל האלבומים יחזרו). המערכת מתעלמת מהשדה הזה אם נעשה שימוש בהיקף photoslibrary.readonly.appcreateddata.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
רשימת האלבומים המבוקשים.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"albums": [
{
object (Album)
}
],
"nextPageToken": string
} |
| שדות |
albums[] |
object (Album)
פלט בלבד. רשימת האלבומים שמוצגים בכרטיסייה 'אלבומים' באפליקציית Google Photos של המשתמש.
|
nextPageToken |
string
פלט בלבד. אסימון לשימוש כדי לקבל את הקבוצה הבאה של האלבומים. מאוכלס אם יש עוד אלבומים לאחזור עבור הבקשה הזו.
|
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\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`"]]
