Esta é a documentação legada da API Google Photos Library.
REST Resource: sharedAlbums
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: álbum
Representação de um álbum no Google Fotos. Os álbuns são contêineres de itens de mídia. Se um álbum tiver sido compartilhado pelo aplicativo, ele terá uma propriedade shareInfo extra.
| Representação JSON |
{
"id": string,
"title": string,
"productUrl": string,
"isWriteable": boolean,
"shareInfo": {
object (ShareInfo)
},
"mediaItemsCount": string,
"coverPhotoBaseUrl": string,
"coverPhotoMediaItemId": string
} |
| Campos |
id |
string
Identificador do álbum. Esse é um identificador persistente que pode ser usado entre sessões para identificar esse álbum.
|
title |
string
Nome do álbum exibido para o usuário na conta do Google Fotos. Essa string não pode ter mais de 500 caracteres.
|
productUrl |
string
[Somente saída] URL do Google Fotos para o álbum. O usuário precisa fazer login na conta do Google Fotos para acessar esse link.
|
isWriteable |
boolean
[Somente saída] Verdadeiro se você pode criar itens de mídia neste álbum. Esse campo se baseia nos escopos concedidos e nas permissões do álbum. Se os escopos ou as permissões do álbum forem alterados, esse campo será atualizado.
|
shareInfo |
object (ShareInfo)
[Somente saída] Informações relacionadas a álbuns compartilhados. Esse campo só será preenchido se o álbum for compartilhado e se o desenvolvedor tiver criado o álbum e o usuário tiver concedido o escopo photoslibrary.sharing.
|
mediaItemsCount |
string (int64 format)
[Somente saída] O número de itens de mídia no álbum.
|
coverPhotoBaseUrl |
string
[Somente saída] Um URL para os bytes da foto de capa. Não use esse URL como está. Os parâmetros precisam ser anexados a ele antes do uso. Consulte a documentação do desenvolvedor para uma lista completa de parâmetros compatíveis. Por exemplo, '=w2048-h1024' define as dimensões da foto da capa para ter 2.048 px de largura e 1.024 px de altura.
|
coverPhotoMediaItemId |
string
Identificador do item de mídia associado à foto de capa.
|
Métodos |
|
|
Retorna o álbum com base no shareToken especificado. |
|
|
Participa de um álbum compartilhado em nome do usuário do Google Fotos. |
|
|
Sai de um álbum compartilhado em nome do usuário do Google Fotos. |
|
|
Lista todos os álbuns compartilhados disponíveis na guia "Compartilhamento" do aplicativo Google Fotos do usuário. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[[["\u003cp\u003eAlbums in Google Photos are containers for media items and can be shared.\u003c/p\u003e\n"],["\u003cp\u003eShared albums have a \u003ccode\u003eshareInfo\u003c/code\u003e property and developers can access them with the \u003ccode\u003ephotoslibrary.sharing\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAlbum\u003c/code\u003e resource provides methods to get, join, leave, and list shared albums.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAlbum\u003c/code\u003e properties provide information such as ID, title, URL, writability status, media count, and cover photo details.\u003c/p\u003e\n"]]],["Albums in Google Photos are containers for media items, identified by a unique `id` and a user-facing `title`. Key details include the album's `productUrl`, whether it's `isWriteable`, `mediaItemsCount`, and cover photo information (`coverPhotoBaseUrl`, `coverPhotoMediaItemId`). Shared albums contain a `shareInfo` property. Actions include: retrieving albums with a `shareToken`, joining, leaving, and listing shared albums via methods such as `get`, `join`, `leave`, and `list`.\n"],null,["# REST Resource: sharedAlbums\n\n- [Resource: Album](#Album)\n - [JSON representation](#Album.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Album\n---------------\n\nRepresentation 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.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"title\": string, \"productUrl\": string, \"isWriteable\": boolean, \"shareInfo\": { object (/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo) }, \"mediaItemsCount\": string, \"coverPhotoBaseUrl\": string, \"coverPhotoMediaItemId\": string } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album. |\n| `title` | `string` Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters. |\n| `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. |\n| `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. |\n| `shareInfo` | `object (`[ShareInfo](/photos/library/legacy/reference/rest/v1/albums#Album.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. |\n| `mediaItemsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \\[Output only\\] The number of media items in the album. |\n| `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](https://developers.google.com/photos/library/guides/access-media-items#base-urls) 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. |\n| `coverPhotoMediaItemId` | `string` Identifier for the media item associated with the cover photo. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| ### [get](/photos/library/legacy/reference/rest/v1/sharedAlbums/get) | Returns the album based on the specified `shareToken`. |\n| ### [join](/photos/library/legacy/reference/rest/v1/sharedAlbums/join) | Joins a shared album on behalf of the Google Photos user. |\n| ### [leave](/photos/library/legacy/reference/rest/v1/sharedAlbums/leave) | Leaves a previously-joined shared album on behalf of the Google Photos user. |\n| ### [list](/photos/library/legacy/reference/rest/v1/sharedAlbums/list) | Lists all shared albums available in the Sharing tab of the user's Google Photos app. |"]]
