Vous consultez actuellement l'ancienne documentation de l'API Library de Google Photos.
REST Resource: sharedAlbums
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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
[Sortie uniquement] 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] 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 )
[Sortie uniquement] 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. Cette URL ne doit pas être utilisée telle quelle. Des paramètres doivent être ajoutés à 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 px et une hauteur de 1 024 px.
|
coverPhotoMediaItemId |
string
Identifiant de l'élément multimédia associé à la photo de couverture.
|
Méthodes |
|
Renvoie l'album en fonction du shareToken spécifié. |
|
Rejoint un album partagé au nom de l'utilisateur Google Photos |
|
Quitte un album partagé auquel il a précédemment adhéré au nom de l'utilisateur Google Photos. |
|
Répertorie tous les albums partagés disponibles dans l'onglet "Partage" de l'application Google Photos de l'utilisateur. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eAlbums in Google Photos are containers for media items and can be shared.\u003c/p\u003e\n"],["\u003cp\u003eShared albums have a \u003ccode\u003eshareInfo\u003c/code\u003e property and developers can access them with the \u003ccode\u003ephotoslibrary.sharing\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAlbum\u003c/code\u003e resource provides methods to get, join, leave, and list shared albums.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAlbum\u003c/code\u003e properties provide information such as ID, title, URL, writability status, media count, and cover photo details.\u003c/p\u003e\n"]]],["Albums in Google Photos are containers for media items, identified by a unique `id` and a user-facing `title`. Key details include the album's `productUrl`, whether it's `isWriteable`, `mediaItemsCount`, and cover photo information (`coverPhotoBaseUrl`, `coverPhotoMediaItemId`). Shared albums contain a `shareInfo` property. Actions include: retrieving albums with a `shareToken`, joining, leaving, and listing shared albums via methods such as `get`, `join`, `leave`, and `list`.\n"],null,["# REST Resource: sharedAlbums\n\n- [Resource: Album](#Album)\n - [JSON representation](#Album.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Album\n---------------\n\nRepresentation of an album in Google Photos. Albums are containers for media items. If an album has been shared by the application, it contains an extra `shareInfo` property.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"title\": string, \"productUrl\": string, \"isWriteable\": boolean, \"shareInfo\": { object (/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo) }, \"mediaItemsCount\": string, \"coverPhotoBaseUrl\": string, \"coverPhotoMediaItemId\": string } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album. |\n| `title` | `string` Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters. |\n| `productUrl` | `string` \\[Output only\\] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link. |\n| `isWriteable` | `boolean` \\[Output only\\] True if you can create media items in this album. This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated. |\n| `shareInfo` | `object (`[ShareInfo](/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo)`)` \\[Output only\\] Information related to shared albums. This field is only populated if the album is a shared album, the developer created the album and the user has granted the `photoslibrary.sharing` scope. |\n| `mediaItemsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \\[Output only\\] The number of media items in the album. |\n| `coverPhotoBaseUrl` | `string` \\[Output only\\] A URL to the cover photo's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the [developer documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls) for a complete list of supported parameters. For example, `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of 2048 px and height of 1024 px. |\n| `coverPhotoMediaItemId` | `string` Identifier for the media item associated with the cover photo. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| ### [get](/photos/library/legacy/reference/rest/v1/sharedAlbums/get) | Returns the album based on the specified `shareToken`. |\n| ### [join](/photos/library/legacy/reference/rest/v1/sharedAlbums/join) | Joins a shared album on behalf of the Google Photos user. |\n| ### [leave](/photos/library/legacy/reference/rest/v1/sharedAlbums/leave) | Leaves a previously-joined shared album on behalf of the Google Photos user. |\n| ### [list](/photos/library/legacy/reference/rest/v1/sharedAlbums/list) | Lists all shared albums available in the Sharing tab of the user's Google Photos app. |"]]