شما در حال مشاهده اسناد قدیمی برای Google Photos Library API هستید.
Method: albums.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
همه آلبوم‌هایی را که در برگه آلبوم‌های برنامه Google Photos به کاربر نشان داده می‌شود فهرست می‌کند.
درخواست HTTP
GET https://photoslibrary.googleapis.com/v1/albums
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
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 -
https://www.googleapis.com/auth/photoslibrary.readonly -
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
،
همه آلبوم‌هایی را که در برگه آلبوم‌های برنامه Google Photos به کاربر نشان داده می‌شود فهرست می‌کند.
درخواست HTTP
GET https://photoslibrary.googleapis.com/v1/albums
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
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 -
https://www.googleapis.com/auth/photoslibrary.readonly -
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
،
همه آلبوم‌هایی را که در برگه آلبوم‌های برنامه Google Photos به کاربر نشان داده می‌شود فهرست می‌کند.
درخواست HTTP
GET https://photoslibrary.googleapis.com/v1/albums
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
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 -
https://www.googleapis.com/auth/photoslibrary.readonly -
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eLists all albums displayed in the user's Google Photos Albums tab using the \u003ccode\u003eGET https://photoslibrary.googleapis.com/v1/albums\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters to control the number of albums returned and retrieve subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of \u003ccode\u003ealbums\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e for further navigation if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with one of the specified OAuth scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/photoslibrary\u003c/code\u003e, for access.\u003c/p\u003e\n"],["\u003cp\u003eCan exclude non-app created data using the \u003ccode\u003eexcludeNonAppCreatedData\u003c/code\u003e parameter or the \u003ccode\u003ephotoslibrary.readonly.appcreateddata\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["To retrieve a user's albums from Google Photos, send a `GET` request to `https://photoslibrary.googleapis.com/v1/albums`. The request body must be empty. Optional query parameters include `pageSize` (default 20, max 50), `pageToken` for pagination, and `excludeNonAppCreatedData`. The response contains an array of album objects and `nextPageToken` for subsequent requests. Authorization requires one of three specified OAuth scopes.\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 shown to a user in the Albums tab of the Google Photos 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/legacy/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `albums[]` | `object (`[Album](/photos/library/legacy/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- `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`"]]
