REST Resource: albums

Ressource: Album

Représentation d'un album dans Google Photos. Les albums sont des conteneurs d'éléments multimédias. Si un album a été partagé par l'application, il contient une propriété shareInfo supplémentaire.

Représentation JSON 
{
  "id": string,
  "title": string,
  "productUrl": string,
  "isWriteable": boolean,
  "shareInfo": {
    object (ShareInfo)
  },
  "mediaItemsCount": string,
  "coverPhotoBaseUrl": string,
  "coverPhotoMediaItemId": string
}
Champs
id

string

Identifiant de l'album. Il s'agit d'un identifiant persistant qui peut être utilisé entre les sessions pour identifier cet album.
title

string

Nom de l'album affiché dans le compte Google Photos de l'utilisateur. Cette chaîne ne doit pas comporter plus de 500 caractères.
productUrl

string

[Uniquement en sortie] URL Google Photos de l'album. L'utilisateur doit être connecté à son compte Google Photos pour accéder à ce lien.
isWriteable

boolean

[Uniquement en sortie] Vrai si vous pouvez créer des éléments multimédias dans cet album. Ce champ est basé sur les niveaux d'accès accordés et les autorisations de l'album. Si les champs d'application ou les autorisations de l'album sont modifiés, ce champ est mis à jour.
shareInfo

object (ShareInfo)

[Uniquement en sortie] Informations relatives aux albums partagés. Ce champ n'est renseigné que s'il s'agit d'un album partagé, si le développeur l'a créé et si l'utilisateur a accordé le champ d'application photoslibrary.sharing.
mediaItemsCount

string (int64 format)

[Uniquement en sortie] Nombre d'éléments multimédias dans l'album.
coverPhotoBaseUrl

string

[Uniquement en sortie] URL des octets de la photo de couverture. Ce champ ne doit pas être utilisé tel quel. Avant de l'utiliser, vous devez ajouter des paramètres à cette URL. Consultez la documentation destinée aux développeurs pour obtenir la liste complète des paramètres acceptés. Par exemple, '=w2048-h1024' définit les dimensions de la photo de couverture sur une largeur de 2 048 pixels et une hauteur de 1 024 pixels.
coverPhotoMediaItemId

string

Identifiant de l'élément multimédia associé à la photo de couverture.

ShareInfo

Informations sur les albums partagés. Ces informations ne sont incluses que si vous avez créé l'album, s'il est partagé et si vous avez accès au partage.

Représentation JSON 
{
  "sharedAlbumOptions": {
    object (SharedAlbumOptions)
  },
  "shareableUrl": string,
  "shareToken": string,
  "isJoined": boolean,
  "isOwned": boolean,
  "isJoinable": boolean
}
Champs
sharedAlbumOptions

object (SharedAlbumOptions)

Options permettant de définir si un utilisateur peut ajouter des commentaires à un album multimédia ou y ajouter des éléments multimédias.
shareableUrl

string

Lien vers l'album Google Photos partagé. Toutes les personnes disposant du lien peuvent afficher le contenu de l'album. Vous devez donc l'utiliser avec précaution.

Le paramètre shareableUrl n'est renvoyé que si le partage par lien est activé pour l'album. Si un utilisateur est déjà associé à un album qui n'est pas partagé par lien, il peut utiliser l'productUrl de l'album pour y accéder.

Une shareableUrl n'est plus valide si le propriétaire désactive le partage par lien dans l'application Google Photos ou si le partage de l'album n'est pas activé.
shareToken

string

Jeton permettant de rejoindre, quitter ou récupérer les détails d'un album partagé au nom d'un utilisateur qui n'en est pas le propriétaire.

Une shareToken n'est plus valide si le propriétaire désactive le partage par lien dans l'application Google Photos ou si le partage de l'album n'est pas activé.
isJoined

boolean

"True" si l'utilisateur est joint à l'album. Cela est toujours vrai pour le propriétaire d'un album.
isOwned

boolean

"True" si l'utilisateur est le propriétaire de l'album.
isJoinable

boolean

"True" si les utilisateurs peuvent rejoindre l'album.

SharedAlbumOptions

Options permettant de contrôler le partage d'un album

Représentation JSON 
{
  "isCollaborative": boolean,
  "isCommentable": boolean
}
Champs
isCollaborative

boolean

Vrai si l'album partagé autorise les collaborateurs (utilisateurs qui ont rejoint l'album) à y ajouter des éléments multimédias. Valeur par défaut : "false".
isCommentable

boolean

Vrai si l'album partagé autorise les collaborateurs (utilisateurs qui ont rejoint l'album) à y ajouter des commentaires. Valeur par défaut : "false".

Méthodes

addEnrichment

 Ajoute un élément enrichi à une position spécifiée dans un album défini.

batchAddMediaItems

 Ajoute à un album un ou plusieurs éléments multimédias de la bibliothèque Google Photos d'un utilisateur.

batchRemoveMediaItems

 Supprime un ou plusieurs éléments multimédias d'un album spécifié.

create

 Crée un album dans la bibliothèque Google Photos d'un utilisateur.

get

 Renvoie l'album en fonction de la valeur albumId spécifiée.

list

 Liste tous les albums visibles par un utilisateur dans l'onglet "Albums" de l'application Google Photos.

patch

 Mettez à jour l'album avec l'élément id spécifié.

share

 Permet de marquer un album comme partagé et accessible à d'autres utilisateurs.

unshare

 Marque un album précédemment partagé comme privé.