You are viewing the legacy documentation for the Google Photos Library API.
Method: sharedAlbums.join
Joins a shared album on behalf of the Google Photos user.
HTTP request
POST https://photoslibrary.googleapis.com/v1/sharedAlbums:join
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
| JSON representation |
{
"shareToken": string
} |
| Fields |
shareToken |
string
Required. Token to join the shared album on behalf of the user.
|
Response body
Response to successfully joining the shared album on behalf of the user.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"album": {
object (Album)
}
} |
| Fields |
album |
object (Album)
Shared album that the user has joined.
|
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."],[[["Joins a shared album on behalf of a Google Photos user using a provided share token."],["The request body requires a shareToken to initiate the joining process."],["A successful response includes the details of the shared album the user has joined."],["Requires authorization with the `https://www.googleapis.com/auth/photoslibrary.sharing` scope."]]],["A POST request is made to `https://photoslibrary.googleapis.com/v1/sharedAlbums:join` to join a shared album. The request body, in JSON format, requires a `shareToken` string. The successful response body contains an `album` object, also in JSON format, representing the joined shared album. Authorization for this action requires the `https://www.googleapis.com/auth/photoslibrary.sharing` OAuth scope. This uses gRPC transcoding syntax.\n"]]
