您目前查看的是 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
}
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-08-29 (世界標準時間)。
[null,null,["上次更新時間: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```"]]