Google Photos Library API の以前のドキュメントを表示しています。
REST Resource: sharedAlbums
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
リソース: Album
Google フォトのアルバムを表します。アルバムはメディア アイテムのコンテナです。アプリケーションによってアルバムが共有されている場合、追加の shareInfo
プロパティが含まれます。
JSON 表現 |
{
"id": string,
"title": string,
"productUrl": string,
"isWriteable": boolean,
"shareInfo": {
object (ShareInfo )
},
"mediaItemsCount": string,
"coverPhotoBaseUrl": string,
"coverPhotoMediaItemId": string
} |
フィールド |
id |
string
アルバムの識別子。これは、セッション間でこのアルバムを識別するために使用できる永続的な ID です。
|
title |
string
Google フォト アカウントでユーザーに表示されるアルバムの名前。この文字列は 500 文字以内にする必要があります。
|
productUrl |
string
[出力のみ] アルバムの Google フォトの URL。ユーザーがこのリンクにアクセスするには、Google フォト アカウントにログインする必要があります。
|
isWriteable |
boolean
[出力専用] このアルバムにメディア アイテムを作成できる場合は true。このフィールドは、付与されるスコープとアルバムの権限に基づいています。範囲やアルバムの権限が変更されると、このフィールドが更新されます。
|
shareInfo |
object (ShareInfo )
[出力のみ] 共有アルバムに関連する情報。このフィールドは、アルバムが共有アルバムであり、デベロッパーがアルバムを作成してユーザーが photoslibrary.sharing スコープを許可した場合にのみ入力されます。
|
mediaItemsCount |
string (int64 format)
[出力のみ] アルバム内のメディア アイテムの数。
|
coverPhotoBaseUrl |
string
[出力のみ] カバー写真のバイトの URL。これはそのまま使用しないでください。使用する前に、この URL にパラメータを追加する必要があります。サポートされている全パラメータの一覧については、デベロッパー向けドキュメントをご覧ください。たとえば、'=w2048-h1024' は、カバー写真に対して、幅 2,048 ピクセル、高さ 1,024 ピクセルのサイズを設定します。
|
coverPhotoMediaItemId |
string
カバー写真に関連付けられているメディア アイテムの ID です。
|
メソッド |
|
指定された shareToken に基づいてアルバムを返します。 |
|
Google フォトのユーザーに代わって共有アルバムに参加します。 |
|
Google フォトのユーザーに代わって参加済みの共有アルバムから退出します。 |
|
ユーザーの Google フォト アプリの [共有] タブで利用できるすべての共有アルバムが一覧表示されます。 |
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eAlbums in Google Photos are containers for media items and can be shared.\u003c/p\u003e\n"],["\u003cp\u003eShared albums have a \u003ccode\u003eshareInfo\u003c/code\u003e property and developers can access them with the \u003ccode\u003ephotoslibrary.sharing\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAlbum\u003c/code\u003e resource provides methods to get, join, leave, and list shared albums.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAlbum\u003c/code\u003e properties provide information such as ID, title, URL, writability status, media count, and cover photo details.\u003c/p\u003e\n"]]],["Albums in Google Photos are containers for media items, identified by a unique `id` and a user-facing `title`. Key details include the album's `productUrl`, whether it's `isWriteable`, `mediaItemsCount`, and cover photo information (`coverPhotoBaseUrl`, `coverPhotoMediaItemId`). Shared albums contain a `shareInfo` property. Actions include: retrieving albums with a `shareToken`, joining, leaving, and listing shared albums via methods such as `get`, `join`, `leave`, and `list`.\n"],null,["# REST Resource: sharedAlbums\n\n- [Resource: Album](#Album)\n - [JSON representation](#Album.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Album\n---------------\n\nRepresentation of an album in Google Photos. Albums are containers for media items. If an album has been shared by the application, it contains an extra `shareInfo` property.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"title\": string, \"productUrl\": string, \"isWriteable\": boolean, \"shareInfo\": { object (/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo) }, \"mediaItemsCount\": string, \"coverPhotoBaseUrl\": string, \"coverPhotoMediaItemId\": string } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album. |\n| `title` | `string` Name of the album displayed to the user in their Google Photos account. This string shouldn't be more than 500 characters. |\n| `productUrl` | `string` \\[Output only\\] Google Photos URL for the album. The user needs to be signed in to their Google Photos account to access this link. |\n| `isWriteable` | `boolean` \\[Output only\\] True if you can create media items in this album. This field is based on the scopes granted and permissions of the album. If the scopes are changed or permissions of the album are changed, this field is updated. |\n| `shareInfo` | `object (`[ShareInfo](/photos/library/legacy/reference/rest/v1/albums#Album.ShareInfo)`)` \\[Output only\\] Information related to shared albums. This field is only populated if the album is a shared album, the developer created the album and the user has granted the `photoslibrary.sharing` scope. |\n| `mediaItemsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` \\[Output only\\] The number of media items in the album. |\n| `coverPhotoBaseUrl` | `string` \\[Output only\\] A URL to the cover photo's bytes. This shouldn't be used as is. Parameters should be appended to this URL before use. See the [developer documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls) for a complete list of supported parameters. For example, `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of 2048 px and height of 1024 px. |\n| `coverPhotoMediaItemId` | `string` Identifier for the media item associated with the cover photo. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| ### [get](/photos/library/legacy/reference/rest/v1/sharedAlbums/get) | Returns the album based on the specified `shareToken`. |\n| ### [join](/photos/library/legacy/reference/rest/v1/sharedAlbums/join) | Joins a shared album on behalf of the Google Photos user. |\n| ### [leave](/photos/library/legacy/reference/rest/v1/sharedAlbums/leave) | Leaves a previously-joined shared album on behalf of the Google Photos user. |\n| ### [list](/photos/library/legacy/reference/rest/v1/sharedAlbums/list) | Lists all shared albums available in the Sharing tab of the user's Google Photos app. |"]]