You are viewing the legacy documentation for the Google Photos Library API.
Method: albums.share
Stay organized with collections
Save and categorize content based on your preferences.
Marks 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.
HTTP request
POST https://photoslibrary.googleapis.com/v1/albums/{albumId}:share
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
albumId |
string
Required. Identifier of the album to be shared. This albumId must belong to an album created by the developer.
|
Request body
The request body contains data with the following structure:
| Fields |
sharedAlbumOptions |
object (SharedAlbumOptions)
Options to be set when converting the album to a shared album.
|
Response body
Response to successfully sharing an album.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"shareInfo": {
object (ShareInfo)
}
} |
| Fields |
shareInfo |
object (ShareInfo)
Output only. Information about the shared album.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/photoslibrary.sharing
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\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`"]]
