このページは Cloud Translation API によって翻訳されました。

Method: sharedAlbums.list

ユーザーの Google フォトアプリの [共有] タブで利用できるすべての共有アルバムを取得します。

GET https://photoslibrary.googleapis.com/v1/sharedAlbums

この URL は gRPC Transcoding 構文を使用します。

パラメータ

パラメータ
`pageSize`	`integer` レスポンスで返されるアルバムの最大数。指定した数よりも少ないアルバムが返される場合があります。デフォルトの `pageSize` は 20、最大値は 50 です。
`pageToken`	`string` 結果の次のページを取得するための連続トークン。これをリクエストに追加すると、`pageToken` の後に行が返されます。`pageToken` は、`listSharedAlbums` リクエストに対するレスポンスの `nextPageToken` パラメータで返される値である必要があります。
`excludeNonAppCreatedData`	`boolean` 設定すると、このアプリ以外で作成されたメディアアイテムが結果から除外されます。デフォルトは false です（すべてのアルバムが返されます）。photoslibrary.readonly.appcreateddata スコープが使用されている場合、このフィールドは無視されます。

pageSize

integer

レスポンスで返されるアルバムの最大数。指定した数よりも少ないアルバムが返される場合があります。デフォルトの pageSize は 20、最大値は 50 です。

pageToken

string

結果の次のページを取得するための連続トークン。これをリクエストに追加すると、pageToken の後に行が返されます。pageToken は、listSharedAlbums リクエストに対するレスポンスの nextPageToken パラメータで返される値である必要があります。

excludeNonAppCreatedData

boolean

設定すると、このアプリ以外で作成されたメディアアイテムが結果から除外されます。デフォルトは false です（すべてのアルバムが返されます）。photoslibrary.readonly.appcreateddata スコープが使用されている場合、このフィールドは無視されます。

リクエストの本文は空にする必要があります。

リクエストされた共有アルバムのリストです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{ "sharedAlbums": [ { object (`Album`) } ], "nextPageToken": string }

フィールド

フィールド
`sharedAlbums[]`	`object (Album)` 出力専用。共有アルバムのリスト。
`nextPageToken`	`string` 出力専用。共有アルバムの次のセットを取得するために使用するトークン。このリクエストで取得する共有アルバムがさらにある場合に入力されます。

sharedAlbums[]

object (Album)

出力専用。共有アルバムのリスト。

nextPageToken

string

出力専用。共有アルバムの次のセットを取得するために使用するトークン。このリクエストで取得する共有アルバムがさらにある場合に入力されます。

次の OAuth スコープのいずれかが必要です。