Method: albums.patch
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
指定された id
を使用して、アプリが作成したアルバムを更新します。アルバムの id
、title
、coverPhotoMediaItemId
フィールドのみが読み取られます。アルバムは、デベロッパーによって API で作成されたものである必要があります。
HTTP リクエスト
PATCH https://photoslibrary.googleapis.com/v1/albums/{album.id}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
album.id |
string
アルバムの識別子。これは、セッション間でこのアルバムを識別するために使用できる永続的な ID です。
|
クエリ パラメータ
パラメータ |
updateMask |
string (FieldMask format)
必須。指定されたアルバムのどのフィールドを更新するかを指定します。有効な値は title と coverPhotoMediaItemId のみです。 完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo" 。
|
リクエストの本文
リクエストの本文には Album
のインスタンスが含まれます。
レスポンスの本文
成功した場合、レスポンスの本文には Album
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["必要な情報がない","missingTheInformationINeed","thumb-down"],["複雑すぎる / 手順が多すぎる","tooComplicatedTooManySteps","thumb-down"],["最新ではない","outOfDate","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["サンプル / コードに問題がある","samplesCodeIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eThis endpoint allows you to update an album's \u003ccode\u003etitle\u003c/code\u003e and \u003ccode\u003ecoverPhotoMediaItemId\u003c/code\u003e using a \u003ccode\u003ePATCH\u003c/code\u003e request to \u003ccode\u003ehttps://photoslibrary.googleapis.com/v1/albums/{album.id}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe album must have been created by the developer via the API and be owned by the user.\u003c/p\u003e\n"],["\u003cp\u003eYou need to specify the fields to be updated using the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter and provide the updated album data in the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/photoslibrary.edit.appcreateddata\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["To update an album, use a `PATCH` request to the specified URL, including the `album.id` as a path parameter. The `updateMask` query parameter is required to specify fields to update, which can be `title` or `coverPhotoMediaItemId`. The request body contains the album data. The response body returns the updated album. Authorization requires the `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata` scope. The provided album must have been created by the developer via the API and owned by the user.\n"],null,["# Method: albums.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdate the app created album with the specified `id`. Only the `id`, `title` and `coverPhotoMediaItemId` fields of the album are read. The album must have been created by the developer via the API.\n\n### HTTP request\n\n`PATCH https://photoslibrary.googleapis.com/v1/albums/{album.id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------|\n| `album.id` | `string` Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. Indicate what fields in the provided album to update. The only valid values are `title` and `coverPhotoMediaItemId`. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Album](/photos/library/reference/rest/v1/albums#Album).\n\n### Response body\n\nIf successful, the response body contains an instance of [Album](/photos/library/reference/rest/v1/albums#Album).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata`"]]