شما در حال مشاهده اسناد قدیمی برای Google Photos Library API هستید.
Method: albums.share
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
آلبومی را به‌عنوان اشتراک‌گذاری شده و قابل دسترسی برای سایر کاربران علامت‌گذاری می‌کند. این عمل فقط در آلبوم هایی قابل انجام است که توسط توسعه دهنده از طریق API ایجاد شده اند.
درخواست HTTP
POST https://photoslibrary.googleapis.com/v1/albums/{albumId}:share
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
albumId | string مورد نیاز. شناسه آلبومی که باید به اشتراک گذاشته شود. این albumId باید متعلق به آلبومی باشد که توسط توسعه دهنده ایجاد شده است. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
| فیلدها |
|---|
sharedAlbumOptions | object ( SharedAlbumOptions ) گزینه هایی که باید هنگام تبدیل آلبوم به آلبوم مشترک تنظیم شوند. |
بدن پاسخگو
پاسخ به اشتراک گذاری موفقیت آمیز یک آلبوم.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"shareInfo": {
object (ShareInfo)
}
} |
| فیلدها |
|---|
shareInfo | object ( ShareInfo ) فقط خروجی اطلاعاتی در مورد آلبوم مشترک |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/photoslibrary.sharing
،
آلبومی را به‌عنوان اشتراک‌گذاری شده و قابل دسترسی برای سایر کاربران علامت‌گذاری می‌کند. این عمل فقط در آلبوم هایی قابل انجام است که توسط توسعه دهنده از طریق API ایجاد شده اند.
درخواست HTTP
POST https://photoslibrary.googleapis.com/v1/albums/{albumId}:share
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
albumId | string مورد نیاز. شناسه آلبومی که باید به اشتراک گذاشته شود. این albumId باید متعلق به آلبومی باشد که توسط توسعه دهنده ایجاد شده است. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
| فیلدها |
|---|
sharedAlbumOptions | object ( SharedAlbumOptions ) گزینه هایی که باید هنگام تبدیل آلبوم به آلبوم مشترک تنظیم شوند. |
بدن پاسخگو
پاسخ به اشتراک گذاری موفقیت آمیز یک آلبوم.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"shareInfo": {
object (ShareInfo)
}
} |
| فیلدها |
|---|
shareInfo | object ( ShareInfo ) فقط خروجی اطلاعاتی در مورد آلبوم مشترک |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/photoslibrary.sharing
،
آلبومی را به‌عنوان اشتراک‌گذاری شده و قابل دسترسی برای سایر کاربران علامت‌گذاری می‌کند. این عمل فقط در آلبوم هایی قابل انجام است که توسط توسعه دهنده از طریق API ایجاد شده اند.
درخواست HTTP
POST https://photoslibrary.googleapis.com/v1/albums/{albumId}:share
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
albumId | string مورد نیاز. شناسه آلبومی که باید به اشتراک گذاشته شود. این albumId باید متعلق به آلبومی باشد که توسط توسعه دهنده ایجاد شده است. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
| فیلدها |
|---|
sharedAlbumOptions | object ( SharedAlbumOptions ) گزینه هایی که باید هنگام تبدیل آلبوم به آلبوم مشترک تنظیم شوند. |
بدن پاسخگو
پاسخ به اشتراک گذاری موفقیت آمیز یک آلبوم.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"shareInfo": {
object (ShareInfo)
}
} |
| فیلدها |
|---|
shareInfo | object ( ShareInfo ) فقط خروجی اطلاعاتی در مورد آلبوم مشترک |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/photoslibrary.sharing
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eMarks an album as shared, making it accessible to other users, but only for albums created via the API.\u003c/p\u003e\n"],["\u003cp\u003eRequires an HTTP POST request to a specific URL with the album ID as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes shared album options, and the response provides shared album information.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is necessary using the \u003ccode\u003ehttps://www.googleapis.com/auth/photoslibrary.sharing\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: albums.share\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ShareAlbumResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nMarks an album as shared and accessible to other users. This action can only be performed on albums which were created by the developer via the API.\n\n### HTTP request\n\n`POST https://photoslibrary.googleapis.com/v1/albums/{albumId}:share`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------|\n| `albumId` | `string` Required. Identifier of the album to be shared. This `albumId` must belong to an album created by the developer. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"sharedAlbumOptions\": { object (/photos/library/legacy/reference/rest/v1/albums#Album.SharedAlbumOptions) } } ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sharedAlbumOptions` | `object (`[SharedAlbumOptions](/photos/library/legacy/reference/rest/v1/albums#Album.SharedAlbumOptions)`)` Options to be set when converting the album to a shared album. |\n\n### Response body\n\nResponse to successfully sharing an album.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------|\n| ``` { \"shareInfo\": { object (/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo) } } ``` |\n\n| Fields ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| `shareInfo` | `object (`[ShareInfo](/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo)`)` Output only. Information about the shared album. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/photoslibrary.sharing`"]]
