REST Resource: albums

Recurso: álbum

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 permanente que pode ser usado entre as 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ó é preenchido se o álbum for compartilhado, se o desenvolvedor tiver criado o álbum e se 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 para desenvolvedores e confira uma lista completa dos parâmetros aceitos. Por exemplo, '=w2048-h1024' define as dimensões da foto da capa com largura de 2.048 px e altura de 1.024 px.
coverPhotoMediaItemId

string

Identificador do item de mídia associado à foto de 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ó é retornado se o álbum tiver o compartilhamento de link ativado. Se um usuário já estiver em um álbum que não é compartilhado por link, ele poderá usar o productUrl do álbum para acessar o conteúdo.

Um shareableUrl é invalidado se o proprietário desativar o compartilhamento de links no app Google Fotos ou se o álbum for 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 é invalidado se o proprietário desativa o compartilhamento de links no app Google Fotos ou se o álbum é desativado.
isJoined

boolean

Verdadeiro se o usuário está 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 o álbum pode ser adicionado por usuários.

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 criado por um app.

batchAddMediaItems

 Adiciona um ou mais itens de mídia criados pelo app à biblioteca do Google Fotos de um usuário em um álbum criado pelo app.

batchRemoveMediaItems

 Remove um ou mais itens de mídia criados por um app de um álbum criado por um app especificado.

create

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

get

 Retorna o álbum criado pelo app com base no albumId especificado.

list

 Lista todos os álbuns criados pelo seu app.

patch

 Atualize o álbum criado pelo app com o id especificado.