您正在查看 Google Photos Library API 的旧版文档。
管理媒体内容
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
除了访问媒体内容之外,
上传后,您可以
也会更改其说明
所需的授权范围
如需在创建媒体项后更改其说明,请使用
photoslibrary.edit.appcreateddata
范围。
要更改媒体项的说明,请
media items update call
媒体项的标识符,并将新说明添加到
请求。
如需更改媒体项的说明,您的应用必须已上传媒体项
项,并且当前经过身份验证的用户必须为其所有者。广告内容描述可以
长度不超过 1,000 个字符。
REST
以下是用于更新媒体内容说明的 PATCH 请求标头:
PATCH https://photoslibrary.googleapis.com/v1/mediaItems/media-item-id?updateMask=description
此请求通过添加
字段掩码,由网址中的 updateMask
参数指示。
在请求的正文中添加新的说明:
{
"description": "new-media-item-description"
}
如果成功,响应将返回更新后的媒体内容:
{
"id": "media-item-id",
"description": "new-media-item-description",
"productUrl": "media-item-product-url",
"baseUrl": "media-items-in-album",
"mimeType": "mime-type-of-media",
"mediaMetadata": {
...
},
"contributorInfo": {
...
},
"fileName": "item-filename"
}
Java
try {
// Update the description of the media item.
// The new description must not be null.
MediaItem updatedItem = photosLibraryClient.updateMediaItemDescription(mediaItem, "new-media-item-description");
} catch (ApiException e) {
// Handle error
}
PHP
try {
// ID of the media item to update.
$mediaItemId = "MEDIA_ITEM_ID";
// New description of the media item.
$newDescription = "new-media-item-description";
// Update the description of the media item identified.
$mediaItem = $photosLibraryClient->updateMediaItemDescription($mediaItemId, $newDescription);
} catch (\Google\ApiCore\ApiException $e) {
// Handle error
}
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-08-29。
[null,null,["最后更新时间 (UTC):2025-08-29。"],[[["\u003cp\u003eYou can update descriptions of media items uploaded by your app using the \u003ccode\u003ephotoslibrary.edit.appcreateddata\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eTo update a description, send a PATCH request to the media item's endpoint with the \u003ccode\u003eupdateMask\u003c/code\u003e parameter set to \u003ccode\u003edescription\u003c/code\u003e and the new description in the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe authenticated user must be the owner of the media item to modify its description, and descriptions are limited to 1,000 characters.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful updates return the entire updated media item resource, including the new description.\u003c/p\u003e\n"],["\u003cp\u003eCode samples for Java and PHP demonstrate how to programmatically update media item descriptions.\u003c/p\u003e\n"]]],["Media item descriptions can be modified after upload using the `photoslibrary.edit.appcreateddata` scope. This is done via a `mediaItems update call` (PATCH request) that includes the media item's ID and the new description in the request body. The authenticated user must be the owner and have uploaded the item. Descriptions can have a maximum of 1,000 characters. A field mask in the URL determines properties to be updated. Sample code snippets in REST, Java, and PHP are provided.\n"],null,["# Manage media items\n\nIn addition to [accessing](/photos/library/guides/access-media-items) media\nitems after you [upload](/photos/library/guides/upload-media) them, you can\nalso change their descriptions.\n\nRequired authorization scope\n----------------------------\n\nTo change the descriptions of media items after their creation, use the\n`photoslibrary.edit.appcreateddata` scope.\n\nChanging media item descriptions\n--------------------------------\n\nTo change a media item's description, make a\n[`media items update call`](/photos/library/legacy/reference/rest/v1/mediaItems/patch)\nwith the identifier of the media item, and include the new description in the\nrequest.\n\nTo change a media item's description, your app must have uploaded the media\nitem, and the currently authenticated user must be the owner. Descriptions can\nbe no more than 1,000 characters in length. \n\n### REST\n\nHere's a PATCH request header to update a media item description: \n\n```\nPATCH https://photoslibrary.googleapis.com/v1/mediaItems/media-item-id?updateMask=description\n```\n\nThis request determines what properties are being updated by including a\nfield mask, indicated by the `updateMask` parameter in the URL.\n\nInclude the new description in the body of the request: \n\n```restructuredtext\n{\n \"description\": \"new-media-item-description\"\n}\n```\n\nIf successful, the response returns the updated media item: \n\n```restructuredtext\n{\n \"id\": \"media-item-id\",\n \"description\": \"\u003cvar translate=\"no\"\u003enew-media-item-description\u003c/var\u003e\",\n \"productUrl\": \"media-item-product-url\",\n \"baseUrl\": \"media-items-in-album\",\n \"mimeType\": \"mime-type-of-media\",\n \"mediaMetadata\": {\n ...\n },\n \"contributorInfo\": {\n ...\n },\n \"fileName\": \"\u003cvar translate=\"no\"\u003eitem-filename\u003c/var\u003e\"\n}\n```\n\n### Java\n\n```java\ntry {\n // Update the description of the media item.\n // The new description must not be null.\n MediaItem updatedItem = photosLibraryClient.updateMediaItemDescription(mediaItem, \"new-media-item-description\");\n} catch (ApiException e) {\n // Handle error\n}\n```\n\n### PHP\n\n```php\ntry {\n\n // ID of the media item to update.\n $mediaItemId = \"MEDIA_ITEM_ID\";\n\n // New description of the media item.\n $newDescription = \"new-media-item-description\";\n\n // Update the description of the media item identified.\n $mediaItem = $photosLibraryClient-\u003eupdateMediaItemDescription($mediaItemId, $newDescription);\n\n} catch (\\Google\\ApiCore\\ApiException $e) {\n // Handle error\n}\n```"]]