REST Resource: albums

Recurso: Album

Representação de um álbum no Google Fotos. Á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 as sessões para identificar o álbum.
title

string

Nome do álbum exibido ao usuário na conta do Google Fotos. Essa string não deve 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 o link.
isWriteable

boolean

[Somente saída] Verdadeiro se você puder criar itens de mídia neste álbum. Este campo é baseado nos escopos concedidos e nas permissões do álbum. Se os escopos ou as permissões do álbum forem alterados, este campo será atualizado.
shareInfo

object (ShareInfo)

[Somente saída] Informações relacionadas aos álbuns compartilhados. Esse campo só é preenchido se o álbum for compartilhado, tiver sido criado pelo desenvolvedor 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 da capa. Ele não deve ser usado como está. Os parâmetros precisam ser anexados a esse URL antes do uso. Consulte a documentação do desenvolvedor para uma lista completa dos parâmetros compatíveis. Por exemplo, '=w2048-h1024' define as dimensões da foto da capa como 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ê tiver criado o álbum, se ele for compartilhado e se você tiver 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 ver o conteúdo do álbum, por isso ele deve 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 é compartilhado por link, ele pode usar a productUrl do álbum para acessá-lo.

Uma shareableUrl será invalidada se o proprietário desativar o compartilhamento de link no app Google Fotos ou se o compartilhamento do álbum for cancelado.
shareToken

string

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

Uma shareToken será invalidada 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 já estiver participando do álbum. Isso sempre acontece com 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 permitir que os colaboradores (usuários que ingressaram no álbum) adicionem itens de mídia a ele. O padrão é "false".
isCommentable

boolean

Verdadeiro se o álbum compartilhado permite que os colaboradores (usuários que ingressaram no á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 exibidos para um usuário na guia "Álbuns" do aplicativo Google Fotos.

patch

 Atualiza o álbum com o id especificado.

share

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

unshare

 Marca um álbum compartilhado anteriormente como particular.