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