Google Photos Library API の以前のドキュメントを表示しています。
メディア アイテムを管理する
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
メディアへのアクセスに加えて、
アップロードした後で、
説明も変更されます。
必要な承認スコープ
メディア アイテムの作成後にその説明を変更するには、
photoslibrary.edit.appcreateddata
スコープ。
メディア アイテムの説明を変更するには、
media items update call
をメディア アイテムの ID で置き換え、新しい説明を
リクエストできます。
メディア アイテムの説明を変更するには、アプリがメディアをアップロードした必要があります。
現在認証されているユーザーが所有者である必要があります。説明文は
長さは 1,000 文字以下にする必要があります。
REST
メディア アイテムの説明を更新するための PATCH リクエスト ヘッダーは次のとおりです。
PATCH https://photoslibrary.googleapis.com/v1/mediaItems/media-item-id?updateMask=description
このリクエストにより、
フィールド マスク(URL の 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 Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-08-29 UTC。
[null,null,["最終更新日 2025-08-29 UTC。"],[[["\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```"]]