REST Resource: albums

Recurso: Album

Representação de um álbum no Google Fotos. Os álbuns são contêineres de itens de mídia. Se um álbum foi compartilhado pelo aplicativo, ele contém 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 é baseado 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 deve ser usado do jeito que está. Os parâmetros precisam ser anexados a esse URL antes do uso. Consulte a documentação para desenvolvedores e confira uma lista completa dos parâmetros aceitos. Por exemplo, '=w2048-h1024' define as dimensões da foto da capa com 2.048 px de largura e 1.024 px de altura.
coverPhotoMediaItemId

string

Identificador do item de mídia associado à foto da capa.

ShareInfo

Informações sobre álbuns compartilhados. Essas informações só serão incluídas se você criou o álbum, ele está compartilhado e você tem o escopo de compartilhamento.

Representação JSON 
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
Campos
sharedAlbumOptions

object (SharedAlbumOptions)

Opções que controlam se alguém pode adicionar itens de mídia ou comentar em um álbum compartilhado.
shareableUrl

string

Um link para o álbum compartilhado do Google Fotos. Qualquer pessoa com o link pode acessar o conteúdo do álbum, por isso, ele precisa ser tratado com cuidado.

O parâmetro shareableUrl só será retornado se o compartilhamento de link estiver ativado no álbum. Se um usuário já estiver participando de um álbum que não está compartilhado por link, ele poderá usar o productUrl do álbum para acessá-lo.

Um shareableUrl é invalidado se o proprietário desativa o compartilhamento de links no app Google Fotos ou se o álbum é desativado.
shareToken

string

Um token usado para entrar, sair ou recuperar os detalhes de um álbum compartilhado em nome de um usuário que não é o proprietário.

Um shareToken será invalidado se o proprietário desativar o compartilhamento de link no app Google Fotos ou se o compartilhamento do álbum for cancelado.
isJoined

boolean

Verdadeiro se o usuário estiver associado ao álbum. Isso é sempre verdade para o proprietário do álbum.
isOwned

boolean

Verdadeiro se o usuário for o proprietário do álbum.
isJoinable

boolean

Verdadeiro se os usuários puderem participar do álbum.

SharedAlbumOptions

Opções que controlam o compartilhamento de um álbum.

Representação JSON 
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
Campos
isCollaborative

boolean

Verdadeiro se o álbum compartilhado permite que os colaboradores (usuários que se juntaram ao álbum) adicionem itens de mídia. O padrão é "false".
isCommentable

boolean

Verdadeiro se o álbum compartilhado permite que os colaboradores (usuários que se juntaram ao álbum) adicionem comentários. O padrão é "false".

Métodos

addEnrichment

 Adiciona um enriquecimento em uma posição especificada em um álbum definido.

batchAddMediaItems

 Adiciona um ou mais itens de mídia da biblioteca do Google Fotos de um usuário a um álbum.

batchRemoveMediaItems

 Remove um ou mais itens de mídia de um álbum especificado.

create

 Cria um álbum na biblioteca do Google Fotos de um usuário.

get

 Retorna o álbum com base no albumId especificado.

list

 Lista todos os álbuns mostrados a um usuário na guia "Álbuns" do app Google Fotos.

patch

 Atualiza o álbum com a id especificada.

share

 Marca um álbum como compartilhado e acessível para outros usuários.

unshare

 Marca um álbum compartilhado anteriormente como particular.