您正在查看 Google Photos Library API 的旧版文档。
Method: albums.patch
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
使用指定的 id
更新影集。系统只会读取影集的 id
、title
和 coverPhotoMediaItemId
字段。影集必须由开发者通过 API 创建,并且必须归用户所有。
HTTP 请求
PATCH https://photoslibrary.googleapis.com/v1/albums/{album.id}
网址采用 gRPC 转码语法。
路径参数
参数 |
album.id |
string
影集的标识符。这是一个永久标识符,可用于在会话之间标识此影集。
|
查询参数
参数 |
updateMask |
string (FieldMask format)
必需。指明所提供影集中要更新的字段。有效值为 title 和 coverPhotoMediaItemId 。 这是完全限定字段名称的逗号分隔列表。示例:"user.displayName,photo" 。
|
响应正文
如果成功,则响应正文包含一个 Album
实例。
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eThis API updates an album with a specified ID, modifying only the title and cover photo, if provided in the request.\u003c/p\u003e\n"],["\u003cp\u003eThe album being updated must have been created by the developer via the API and be owned by the user.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003ePATCH\u003c/code\u003e request is used, targeting the album's ID in the URL.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eupdateMask\u003c/code\u003e query parameter is required to specify which album fields (title, coverPhotoMediaItemId) are being updated.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain an \u003ccode\u003eAlbum\u003c/code\u003e object with the updated fields, and the response, if successful, also contains an \u003ccode\u003eAlbum\u003c/code\u003e object.\u003c/p\u003e\n"]]],["This describes updating an album using a PATCH request to `https://photoslibrary.googleapis.com/v1/albums/{album.id}`. The `album.id` path parameter identifies the target album. The `updateMask` query parameter, with values `title` or `coverPhotoMediaItemId`, specifies which album fields to update. The request body contains the updated album information, while the successful response body returns the updated album. This operation requires the `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata` authorization scope. Only albums created via the API and owned by the user can be modified.\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 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 and must be owned by the user.\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://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` 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/legacy/reference/rest/v1/albums#Album).\n\n### Response body\n\nIf successful, the response body contains an instance of [Album](/photos/library/legacy/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`"]]