Method: sharedAlbums.join

AI-generated Key Takeaways

• 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.

• HTTP request
• Request body
  • JSON representation
• Response body
  • JSON representation
• Authorization scopes
• Try it!

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