Method: albums.list

Google フォト アプリの [アルバム] タブでユーザーに表示されるすべてのアルバムを一覧表示します。

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
  • https://www.googleapis.com/auth/photoslibrary.readonly
  • https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata