Method: albums.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
アプリが作成したすべてのアルバムを一覧表示します。
HTTP リクエスト
GET https://photoslibrary.googleapis.com/v1/albums
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
| パラメータ |
pageSize |
integer
レスポンスで返されるアルバムの最大数。指定した数よりも少ないアルバムが返される場合があります。デフォルトの pageSize は 20、最大値は 50 です。
|
pageToken |
string
結果の次のページを取得するための連続トークン。これをリクエストに追加すると、pageToken の後に行が返されます。pageToken は、listAlbums リクエストに対するレスポンスの nextPageToken パラメータで返される値である必要があります。
|
excludeNonAppCreatedData |
boolean
設定すると、このアプリ以外で作成されたメディア アイテムが結果から除外されます。デフォルトは false です（すべてのアルバムが返されます）。photoslibrary.readonly.appcreateddata スコープが使用されている場合、このフィールドは無視されます。
|
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
リクエストされたアルバムのリストです。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
| JSON 表現 |
{
"albums": [
{
object (Album)
}
],
"nextPageToken": string
} |
| フィールド |
albums[] |
object (Album)
出力専用。ユーザーの Google フォト アプリの [アルバム] タブに表示されるアルバムのリスト。
|
nextPageToken |
string
出力専用。アルバムの次のセットを取得するために使用するトークン。このリクエストで取得するアルバムがさらにある場合に入力されます。
|
認可スコープ
以下のいずれかの OAuth スコープが必要です。
https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eLists all albums displayed in the user's Google Photos Albums tab.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size, page token, and excluding non-app created data.\u003c/p\u003e\n"],["\u003cp\u003eResponses include an array of albums and a token for retrieving further pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, with some legacy scopes being phased out.\u003c/p\u003e\n"],["\u003cp\u003eFunctionality will be limited to app-created media starting March 31, 2025.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of albums from the Google Photos app using the `GET https://photoslibrary.googleapis.com/v1/albums` request. The request requires no body but accepts `pageSize`, `pageToken`, and `excludeNonAppCreatedData` as query parameters. The response includes an array of albums and an optional `nextPageToken` for pagination. It also outlines the required authorization scopes and indicates that certain scopes will limit functionality to app-created content after March 31, 2025.\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 created by your 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/reference/rest/v1/albums#Album) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `albums[]` | `object (`[Album](/photos/library/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- `\n https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata`"]]
