Vous consultez actuellement l'ancienne documentation de l'API Library de Google Photos.
Method: albums.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Liste tous les albums présentés à un utilisateur dans l'onglet "Albums" de l'application Google Photos.
Requête HTTP
GET https://photoslibrary.googleapis.com/v1/albums
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
| Paramètres |
pageSize |
integer
Nombre maximal d'albums à renvoyer dans la réponse. Le nombre d'albums renvoyés peut être inférieur au nombre spécifié. La valeur par défaut de pageSize est 20, la valeur maximale est 50.
|
pageToken |
string
Jeton de continuation permettant d'obtenir la page suivante des résultats. L'ajout de cette valeur à la requête renvoie les lignes après pageToken. pageToken doit être la valeur renvoyée dans le paramètre nextPageToken dans la réponse à la requête listAlbums.
|
excludeNonAppCreatedData |
boolean
Si cette valeur est définie, les résultats excluent les éléments multimédias qui n'ont pas été créés par cette application. La valeur par défaut est "false" (tous les albums sont renvoyés). Ce champ est ignoré si le champ d'application photoslibrary.readonly.appcreateddata est utilisé.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Liste des albums demandés.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"albums": [
{
object (Album)
}
],
"nextPageToken": string
} |
| Champs |
albums[] |
object (Album)
Uniquement en sortie. Liste des albums affichés dans l'onglet "Albums" de l'application Google Photos de l'utilisateur.
|
nextPageToken |
string
Uniquement en sortie. Jeton à utiliser pour obtenir le prochain ensemble d'albums. Renseigné s'il existe d'autres albums à récupérer pour cette requête.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/photoslibrary
https://www.googleapis.com/auth/photoslibrary.readonly
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
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\u003eLists all albums displayed in the user's Google Photos Albums tab using the \u003ccode\u003eGET https://photoslibrary.googleapis.com/v1/albums\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters to control the number of albums returned and retrieve subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of \u003ccode\u003ealbums\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e for further navigation if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with one of the specified OAuth scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/photoslibrary\u003c/code\u003e, for access.\u003c/p\u003e\n"],["\u003cp\u003eCan exclude non-app created data using the \u003ccode\u003eexcludeNonAppCreatedData\u003c/code\u003e parameter or the \u003ccode\u003ephotoslibrary.readonly.appcreateddata\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["To retrieve a user's albums from Google Photos, send a `GET` request to `https://photoslibrary.googleapis.com/v1/albums`. The request body must be empty. Optional query parameters include `pageSize` (default 20, max 50), `pageToken` for pagination, and `excludeNonAppCreatedData`. The response contains an array of album objects and `nextPageToken` for subsequent requests. Authorization requires one of three specified OAuth scopes.\n"],null,["# Method: albums.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAlbumsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all albums shown to a user in the Albums tab of the Google Photos app.\n\n### HTTP request\n\n`GET https://photoslibrary.googleapis.com/v1/albums`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of albums to return in the response. Fewer albums might be returned than the specified number. The default `pageSize` is 20, the maximum is 50. |\n| `pageToken` | `string` A continuation token to get the next page of the results. Adding this to the request returns the rows after the `pageToken`. The `pageToken` should be the value returned in the `nextPageToken` parameter in the response to the `listAlbums` request. |\n| `excludeNonAppCreatedData` | `boolean` If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nList of albums requested.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"albums\": [ { object (/photos/library/legacy/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `albums[]` | `object (`[Album](/photos/library/legacy/reference/rest/v1/albums#Album)`)` Output only. List of albums shown in the Albums tab of the user's Google Photos app. |\n| `nextPageToken` | `string` Output only. Token to use to get the next set of albums. Populated if there are more albums to retrieve for this request. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/photoslibrary`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly`\n- `\n https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata`"]]
