REST Resource: albums

Ressource : Album

Représentation d'un album dans Google Photos. Les albums sont des conteneurs pour les é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 dépasser 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

[Sortie uniquement] "True" si vous pouvez créer des éléments multimédias dans cet album. Ce champ dépend des niveaux d'accès accordés et des autorisations associées à 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 sur les albums partagés. Ce champ n'est renseigné que si l'album est 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. Il ne doit pas être utilisé tel quel. Vous devez ajouter les paramètres à cette URL avant de l'utiliser. 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, qu'il est partagé et que vous disposez de l'étendue de partage.

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

object (SharedAlbumOptions)

Options qui déterminent si quelqu'un peut ajouter des éléments multimédias à un album partagé ou commenter un album partagé.
shareableUrl

string

Un lien vers l'album Google Photos partagé Toutes les personnes disposant du lien peuvent consulter le contenu de l'album. Vous devez donc le traiter 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 cet album pour y accéder à la place.

Un shareableUrl est invalidé si le propriétaire désactive le partage par lien dans l'application Google Photos ou si l'album n'est plus partagé.
shareToken

string

Jeton permettant de rejoindre un album partagé, de le quitter ou d'en récupérer les détails pour le compte 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 l'album n'est plus partagé.
isJoined

boolean

"True" si l'utilisateur est associé à l'album. Ce principe s'applique toujours au propriétaire de l'album.
isOwned

boolean

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

boolean

"True" si les utilisateurs peuvent participer à l'album.

SharedAlbumOptions

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

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

boolean

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

boolean

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

Méthodes

addEnrichment

 Ajoute un élément enrichissant à 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 du albumId spécifié.

list

 Liste tous les albums présentés à un utilisateur dans l'onglet "Albums" de l'application Google Photos.

patch

 Met à jour l'album avec le id spécifié.

share

 Marque un album comme partagé et accessible aux autres utilisateurs.

unshare

 Permet de marquer un album précédemment partagé comme privé.