メディア アイテムを管理する

メディア アイテムをアップロードした後にaccessingするだけでなく、説明を変更することもできます。

必要な認可スコープ

メディア アイテムの作成後にその説明を変更するには、photoslibrary.edit.appcreateddata スコープを使用します。

メディア アイテムの説明の変更

メディア アイテムの説明を変更するには、そのメディア アイテムの ID を指定して media items update call を作成し、新しい説明をリクエストに含めます。

メディア アイテムの説明を変更するには、アプリがそのメディア アイテムをアップロード済みで、現在認証されているユーザーがオーナーである必要があります。説明の長さは 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
}