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 qui peut être utilisé entre les sessions pour identifier cet album.
title

string

Nom de l'album présenté à l'utilisateur dans son compte Google Photos. Cette chaîne ne doit pas dépasser 500 caractères.
productUrl

string

[Uniquement en sortie] URL Google Photos de l'album. Pour accéder à ce lien, l'utilisateur doit être connecté à son compte Google Photos.
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 champs d'application autorisés et les autorisations de l'album. Si vous modifiez les champs d'application ou les autorisations de l'album, ce champ est mis à jour.
shareInfo

object (ShareInfo)

[Uniquement en sortie] Informations liées aux albums partagés. Ce champ n'est renseigné que si l'album est un album partagé, si le développeur a créé l'album et si l'utilisateur a accordé le niveau d'accès 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 pour une largeur de 2 048 px et une hauteur de 1 024 px.
coverPhotoMediaItemId

string

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

Partager

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 disposez de la portée de partage.

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

object (SharedAlbumOptions)

Options permettant d'autoriser ou non les utilisateurs à ajouter des éléments multimédias ou à commenter un album partagé.
shareableUrl

string

Un lien vers l'album Google Photos partagé Toute personne disposant du lien peut consulter le contenu de l'album. Il doit donc être traité avec précaution.

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

La valeur shareableUrl n'est pas valide 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, de quitter ou de récupérer les détails d'un album partagé au nom d'un utilisateur qui n'en est pas le propriétaire.

La valeur shareToken n'est pas 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

Valeur "true" si l'utilisateur est joint à l'album C'est toujours le cas pour le propriétaire de l'album.
isOwned

boolean

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

boolean

Défini sur "true" si les utilisateurs peuvent joindre l'album.

Options d'album partagé

Options contrôlant le partage d'un album.

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

boolean

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

boolean

Défini sur "true" si l'album partagé permet à des collaborateurs (utilisateurs ayant rejoint l'album) d'y ajouter des commentaires. Valeur par défaut : "false".

Méthodes

addEnrichment

 Ajoute un enrichissement à une position spécifiée dans un album défini.

batchAddMediaItems

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

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 de l'utilisateur.

get

 Renvoie l'album en fonction du paramètre albumId spécifié.

list

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

patch

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

share

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

unshare

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