شما در حال مشاهده اسناد قدیمی برای Google Photos Library API هستید.
REST Resource: sharedAlbums
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
منبع: آلبوم
نمایش یک آلبوم در Google Photos. آلبوم ها محفظه هایی برای آیتم های رسانه ای هستند. اگر آلبومی توسط برنامه به اشتراک گذاشته شده باشد، دارای ویژگی shareInfo اضافی است.
| نمایندگی JSON |
|---|
{
"id": string,
"title": string,
"productUrl": string,
"isWriteable": boolean,
"shareInfo": {
object (ShareInfo)
},
"mediaItemsCount": string,
"coverPhotoBaseUrl": string,
"coverPhotoMediaItemId": string
} |
| فیلدها |
|---|
id | string شناسه آلبوم این یک شناسه ثابت است که می‌تواند بین جلسات برای شناسایی این آلبوم استفاده شود. |
title | string نام آلبوم نمایش داده شده به کاربر در حساب Google Photos. این رشته نباید بیشتر از 500 کاراکتر باشد. |
productUrl | string [فقط خروجی] URL Google Photos برای آلبوم. کاربر برای دسترسی به این پیوند باید به حساب Google Photos خود وارد شود. |
isWriteable | boolean [فقط خروجی] اگر بتوانید موارد رسانه ای را در این آلبوم ایجاد کنید درست است. این فیلد بر اساس محدوده های اعطا شده و مجوزهای آلبوم است. اگر محدوده ها تغییر کند یا مجوزهای آلبوم تغییر کند، این قسمت به روز می شود. |
shareInfo | object ( ShareInfo ) [فقط خروجی] اطلاعات مربوط به آلبوم های مشترک. این قسمت فقط در صورتی پر می شود که آلبوم یک آلبوم مشترک باشد، توسعه دهنده آلبوم را ایجاد کرده و کاربر محدوده photoslibrary.sharing را اعطا کرده است. |
mediaItemsCount | string ( int64 format) [فقط خروجی] تعداد موارد رسانه در آلبوم. |
coverPhotoBaseUrl | string [فقط خروجی] URL به بایت های عکس روی جلد. این نباید همانطور که هست استفاده شود. قبل از استفاده، پارامترها باید به این URL اضافه شوند. برای لیست کامل پارامترهای پشتیبانی شده به مستندات توسعه دهنده مراجعه کنید. برای مثال، '=w2048-h1024' ابعاد عکس روی جلد را به عرض 2048 پیکسل و ارتفاع 1024 پیکسل تنظیم می کند. |
coverPhotoMediaItemId | string شناسه مورد رسانه مرتبط با عکس روی جلد. |
روش ها |
|---|
| آلبوم را بر اساس shareToken مشخص شده برمی گرداند. |
| از طرف کاربر Google Photos به یک آلبوم مشترک می پیوندد. |
| آلبوم مشترکی را که قبلاً به آن ملحق شده است از طرف کاربر Google Photos ترک می‌کند. |
| همه آلبوم‌های به اشتراک‌گذاشته‌شده موجود در برگه اشتراک‌گذاری برنامه Google Photos کاربر را فهرست می‌کند. |
،
منبع: آلبوم
نمایش یک آلبوم در Google Photos. آلبوم ها محفظه هایی برای آیتم های رسانه ای هستند. اگر آلبومی توسط برنامه به اشتراک گذاشته شده باشد، دارای ویژگی shareInfo اضافی است.
| نمایندگی JSON |
|---|
{
"id": string,
"title": string,
"productUrl": string,
"isWriteable": boolean,
"shareInfo": {
object (ShareInfo)
},
"mediaItemsCount": string,
"coverPhotoBaseUrl": string,
"coverPhotoMediaItemId": string
} |
| فیلدها |
|---|
id | string شناسه آلبوم این یک شناسه ثابت است که می‌تواند بین جلسات برای شناسایی این آلبوم استفاده شود. |
title | string نام آلبوم نمایش داده شده به کاربر در حساب Google Photos. این رشته نباید بیشتر از 500 کاراکتر باشد. |
productUrl | string [فقط خروجی] URL Google Photos برای آلبوم. کاربر برای دسترسی به این پیوند باید به حساب Google Photos خود وارد شود. |
isWriteable | boolean [فقط خروجی] اگر بتوانید موارد رسانه ای را در این آلبوم ایجاد کنید درست است. این فیلد بر اساس محدوده های اعطا شده و مجوزهای آلبوم است. اگر محدوده ها تغییر کند یا مجوزهای آلبوم تغییر کند، این قسمت به روز می شود. |
shareInfo | object ( ShareInfo ) [فقط خروجی] اطلاعات مربوط به آلبوم های مشترک. این قسمت فقط در صورتی پر می شود که آلبوم یک آلبوم مشترک باشد، توسعه دهنده آلبوم را ایجاد کرده و کاربر محدوده photoslibrary.sharing را اعطا کرده است. |
mediaItemsCount | string ( int64 format) [فقط خروجی] تعداد موارد رسانه در آلبوم. |
coverPhotoBaseUrl | string [فقط خروجی] URL به بایت های عکس روی جلد. این نباید همانطور که هست استفاده شود. قبل از استفاده، پارامترها باید به این URL اضافه شوند. برای لیست کامل پارامترهای پشتیبانی شده به مستندات توسعه دهنده مراجعه کنید. برای مثال، '=w2048-h1024' ابعاد عکس روی جلد را به عرض 2048 پیکسل و ارتفاع 1024 پیکسل تنظیم می کند. |
coverPhotoMediaItemId | string شناسه مورد رسانه مرتبط با عکس روی جلد. |
روش ها |
|---|
| آلبوم را بر اساس shareToken مشخص شده برمی گرداند. |
| از طرف کاربر Google Photos به یک آلبوم مشترک می پیوندد. |
| آلبوم مشترکی را که قبلاً به آن ملحق شده است از طرف کاربر Google Photos ترک می‌کند. |
| همه آلبوم‌های به اشتراک‌گذاشته‌شده موجود در برگه اشتراک‌گذاری برنامه Google Photos کاربر را فهرست می‌کند. |
،
منبع: آلبوم
نمایش یک آلبوم در Google Photos. آلبوم ها محفظه هایی برای آیتم های رسانه ای هستند. اگر آلبومی توسط برنامه به اشتراک گذاشته شده باشد، دارای ویژگی shareInfo اضافی است.
| نمایندگی JSON |
|---|
{
"id": string,
"title": string,
"productUrl": string,
"isWriteable": boolean,
"shareInfo": {
object (ShareInfo)
},
"mediaItemsCount": string,
"coverPhotoBaseUrl": string,
"coverPhotoMediaItemId": string
} |
| فیلدها |
|---|
id | string شناسه آلبوم این یک شناسه ثابت است که می‌تواند بین جلسات برای شناسایی این آلبوم استفاده شود. |
title | string نام آلبوم نمایش داده شده به کاربر در حساب Google Photos. این رشته نباید بیشتر از 500 کاراکتر باشد. |
productUrl | string [فقط خروجی] URL Google Photos برای آلبوم. کاربر برای دسترسی به این پیوند باید به حساب Google Photos خود وارد شود. |
isWriteable | boolean [فقط خروجی] اگر بتوانید موارد رسانه ای را در این آلبوم ایجاد کنید درست است. این فیلد بر اساس محدوده های اعطا شده و مجوزهای آلبوم است. اگر محدوده ها تغییر کند یا مجوزهای آلبوم تغییر کند، این قسمت به روز می شود. |
shareInfo | object ( ShareInfo ) [فقط خروجی] اطلاعات مربوط به آلبوم های مشترک. این قسمت فقط در صورتی پر می شود که آلبوم یک آلبوم مشترک باشد، توسعه دهنده آلبوم را ایجاد کرده و کاربر محدوده photoslibrary.sharing را اعطا کرده است. |
mediaItemsCount | string ( int64 format) [فقط خروجی] تعداد موارد رسانه در آلبوم. |
coverPhotoBaseUrl | string [فقط خروجی] URL به بایت های عکس روی جلد. این نباید همانطور که هست استفاده شود. قبل از استفاده، پارامترها باید به این URL اضافه شوند. برای لیست کامل پارامترهای پشتیبانی شده به مستندات توسعه دهنده مراجعه کنید. برای مثال، '=w2048-h1024' ابعاد عکس روی جلد را به عرض 2048 پیکسل و ارتفاع 1024 پیکسل تنظیم می کند. |
coverPhotoMediaItemId | string شناسه مورد رسانه مرتبط با عکس روی جلد. |
روش ها |
|---|
| آلبوم را بر اساس shareToken مشخص شده برمی گرداند. |
| از طرف کاربر Google Photos به یک آلبوم مشترک می پیوندد. |
| آلبوم مشترکی را که قبلاً به آن ملحق شده است از طرف کاربر Google Photos ترک می‌کند. |
| همه آلبوم‌های به اشتراک‌گذاشته‌شده موجود در برگه اشتراک‌گذاری برنامه Google Photos کاربر را فهرست می‌کند. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eAlbums in Google Photos are containers for media items and can be shared.\u003c/p\u003e\n"],["\u003cp\u003eShared albums have a \u003ccode\u003eshareInfo\u003c/code\u003e property and developers can access them with the \u003ccode\u003ephotoslibrary.sharing\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAlbum\u003c/code\u003e resource provides methods to get, join, leave, and list shared albums.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAlbum\u003c/code\u003e properties provide information such as ID, title, URL, writability status, media count, and cover photo details.\u003c/p\u003e\n"]]],["Albums in Google Photos are containers for media items, identified by a unique `id` and a user-facing `title`. Key details include the album's `productUrl`, whether it's `isWriteable`, `mediaItemsCount`, and cover photo information (`coverPhotoBaseUrl`, `coverPhotoMediaItemId`). Shared albums contain a `shareInfo` property. Actions include: retrieving albums with a `shareToken`, joining, leaving, and listing shared albums via methods such as `get`, `join`, `leave`, and `list`.\n"],null,["# REST Resource: sharedAlbums\n\n- [Resource: Album](#Album)\n - [JSON representation](#Album.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Album\n---------------\n\nRepresentation of an album in Google Photos. Albums are containers for media items. If an album has been shared by the application, it contains an extra `shareInfo` property.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"title\": string, \"productUrl\": string, \"isWriteable\": boolean, \"shareInfo\": { object (/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo) }, \"mediaItemsCount\": string, \"coverPhotoBaseUrl\": string, \"coverPhotoMediaItemId\": string } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album. |\n| `title` | `string` Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters. |\n| `productUrl` | `string` \\[Output only\\] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link. |\n| `isWriteable` | `boolean` \\[Output only\\] True if you can create media items in this album. This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated. |\n| `shareInfo` | `object (`[ShareInfo](/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo)`)` \\[Output only\\] Information related to shared albums. This field is only populated if the album is a shared album, the developer created the album and the user has granted the `photoslibrary.sharing` scope. |\n| `mediaItemsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \\[Output only\\] The number of media items in the album. |\n| `coverPhotoBaseUrl` | `string` \\[Output only\\] A URL to the cover photo's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the [developer documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls) for a complete list of supported parameters. For example, `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of 2048 px and height of 1024 px. |\n| `coverPhotoMediaItemId` | `string` Identifier for the media item associated with the cover photo. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| ### [get](/photos/library/legacy/reference/rest/v1/sharedAlbums/get) | Returns the album based on the specified `shareToken`. |\n| ### [join](/photos/library/legacy/reference/rest/v1/sharedAlbums/join) | Joins a shared album on behalf of the Google Photos user. |\n| ### [leave](/photos/library/legacy/reference/rest/v1/sharedAlbums/leave) | Leaves a previously-joined shared album on behalf of the Google Photos user. |\n| ### [list](/photos/library/legacy/reference/rest/v1/sharedAlbums/list) | Lists all shared albums available in the Sharing tab of the user's Google Photos app. |"]]
