REST Resource: sharedAlbums

Resource: Album

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

JSON representation
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
Fields
id

string

[Ouput only] Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.

title

string

Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters.

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.

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.

shareInfo

object (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.

mediaItemsCount

string (int64 format)

[Output only] The number of media items in the album.

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

coverPhotoMediaItemId

string

[Output only] Identifier for the media item associated with the cover photo.

Methods

get

Returns the album based on the specified shareToken.

join

Joins a shared album on behalf of the Google Photos user.

leave

Leaves a previously-joined shared album on behalf of the Google Photos user.

list

Lists all shared albums available in the Sharing tab of the user's Google Photos app.