شما در حال مشاهده اسناد قدیمی برای Google Photos Library API هستید.
Method: sharedAlbums.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
همه آلبوم‌های به اشتراک‌گذاشته‌شده موجود در برگه اشتراک‌گذاری برنامه Google Photos کاربر را فهرست می‌کند.
درخواست HTTP
GET https://photoslibrary.googleapis.com/v1/sharedAlbums
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
pageSize | integer حداکثر تعداد آلبوم برای بازگشت در پاسخ. ممکن است تعداد کمتری آلبوم از تعداد مشخص شده بازگردانده شود. pageSize پیش فرض 20 و حداکثر 50 است. |
pageToken | string یک نشانه ادامه برای دریافت صفحه بعدی نتایج. با افزودن این به درخواست، ردیف‌های بعد از pageToken برمی‌گردد. pageToken باید مقداری باشد که در پارامتر nextPageToken در پاسخ به درخواست listSharedAlbums برگردانده شده است. |
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
،
همه آلبوم‌های به اشتراک‌گذاشته‌شده موجود در برگه اشتراک‌گذاری برنامه Google Photos کاربر را فهرست می‌کند.
درخواست HTTP
GET https://photoslibrary.googleapis.com/v1/sharedAlbums
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
pageSize | integer حداکثر تعداد آلبوم برای بازگشت در پاسخ. ممکن است تعداد کمتری آلبوم از تعداد مشخص شده بازگردانده شود. pageSize پیش فرض 20 و حداکثر 50 است. |
pageToken | string یک نشانه ادامه برای دریافت صفحه بعدی نتایج. با افزودن این به درخواست، ردیف‌های بعد از pageToken برمی‌گردد. pageToken باید مقداری باشد که در پارامتر nextPageToken در پاسخ به درخواست listSharedAlbums برگردانده شده است. |
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
،
همه آلبوم‌های به اشتراک‌گذاشته‌شده موجود در برگه اشتراک‌گذاری برنامه Google Photos کاربر را فهرست می‌کند.
درخواست HTTP
GET https://photoslibrary.googleapis.com/v1/sharedAlbums
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
pageSize | integer حداکثر تعداد آلبوم برای بازگشت در پاسخ. ممکن است تعداد کمتری آلبوم از تعداد مشخص شده بازگردانده شود. pageSize پیش فرض 20 و حداکثر 50 است. |
pageToken | string یک نشانه ادامه برای دریافت صفحه بعدی نتایج. با افزودن این به درخواست، ردیف‌های بعد از pageToken برمی‌گردد. pageToken باید مقداری باشد که در پارامتر nextPageToken در پاسخ به درخواست listSharedAlbums برگردانده شده است. |
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
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده 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`"]]
