您正在查看 Google Photos Library API 的旧版文档。

此页面由 Cloud Translation API 翻译。

管理影集

在 Google 相册中，您可以使用影集整理照片和其他媒体内容。媒体内容可与一个或多个影集关联。开始关联媒体内容，则您需要先创建影集。

必需的授权范围

如需创建影集，您的应用必须至少请求以下一项：授权范围：

photoslibrary.appendonly
photoslibrary.sharing

要在创建影集后更改其标题或封面照片，请使用 photoslibrary.edit.appcreateddata 范围。

创建新影集

要创建相册，请调用 albums.create 并包含 title。请注意，title 不得超过 500 个字符。

该调用会返回专辑。您的应用可以存储此信息中的影集 ID，并将其用于上传媒体内容特定影集。

REST

以下是 POST 请求的标头：

POST https://photoslibrary.googleapis.com/v1/albums
Content-type: application/json
Authorization: Bearer oauth2-token

请求正文如下所示：

{
  "album": {
    "title": "new-album-title"
  }
}

如果成功，响应将返回一个专辑：

{
  "productUrl": "album-product-url",
  "id": "album-id",
  "title": "album-title",
  "isWriteable": "whether-you-can-write-to-this-album"
}

Java

try {
  Album createdAlbum = photosLibraryClient.createAlbum("My Album");
  // The createdAlbum object contains properties of an album
  String productUrl = createdAlbum.getProductUrl();
  // coverPhotoBaseUrl shouldn't be used as is. Append parameters to base URLs before use
  String albumCoverImage = createdAlbum.getCoverPhotoBaseUrl() + "=w2048-h1024";
  boolean isWriteable = createdAlbum.getIsWriteable();
} catch (ApiException e) {
  // Handle error
}

PHP

try {
    $newAlbum = PhotosLibraryResourceFactory::album("My Album");
    $createdAlbum = $photosLibraryClient->createAlbum($newAlbum);
    // The createdAlbum object contains properties of an album
    $albumId = $createdAlbum->getId();
    $productUrl = $createdAlbum->getProductUrl();
    // coverPhotoBaseUrl shouldn't be used as is. Append parameters to base URLs before use
    $albumCoverImage = $createdAlbum->getCoverPhotoBaseUrl() . '=w2048-h1024';
    $isWriteable = $createdAlbum->getIsWriteable();
} catch (\Google\ApiCore\ApiException $e) {
    // Handle error
}

更改影集标题和封面照片

要更改影集标题或封面照片，请创建带有以下参数的 album update call：影集的 ID，并加入新标题或新封面照片的媒体项 ID。您将需要使用 photoslibrary.edit.appcreateddata 授权范围进行更改。

专辑标题的长度不得超过 500 个字符。封面媒体项必须归影集所有者所有，并且属于该影集，它们将是封面。

REST

下面是一个 PATCH 请求标头，用于更新专辑的 title 和 coverPhotomediaItemId。

PATCH https://photoslibrary.googleapis.com/v1/albums/album-id?updateMask=title&updateMask=coverPhotoMediaItemId

此请求通过将字段掩码，由updateMask 网址。updateMask 参数需要为每个要更新的影集属性。

对于要更新的每项房源，请在以下位置包含其详细信息：请求的正文部分：

{
  "title": "new-album-title",
  "coverPhotoMediaItemId": "new-cover-media-item-id"
}

如果成功，响应将返回更新后的 album 详细信息：

{
  "id": "album-id",
  "title": "new-album-title",
  "productUrl": "album-product-url",
  "isWriteable": "true-if-user-can-write-to-this-album",
  "mediaItemsCount": "number-of-media-items-in-album",
  "coverPhotoBaseUrl": "cover-photo-base-url_use-only-with-parameters",
  "coverPhotoMediaItemId": "new-cover-media-item-id"
}

Java

try {
  // Update the cover photo of the album given a MediaItem object.
  Album updatedAlbum = photosLibraryClient.updateAlbumCoverPhoto(album, newCoverMediaItem);

  // Alternatively, you can update the cover photo of the album given a media item ID.
  // The specified media item identifier must be not null or empty.
  // Album updatedAlbum = photosLibraryClient.updateAlbumCoverPhoto(album, "new-cover-media-item-id");
} catch (ApiException e) {
  // Handle error
}
try {
  // Update the title of the album.
  // The new title must not be null or empty.
  Album updatedAlbum = photosLibraryClient.updateAlbumTitle(album, "new-album-title");
} catch (ApiException e) {
  // Handle error
}

PHP

try {

    // ID of the album to update.
    $albumId = "ALBUM_ID";

    // Media item ID of the new cover photo.
    // Must not be null or empty.
    $newCoverMediaItemId = "new-cover-media-item-id";

    // Update the cover photo of the album.
    $mediaItem = $photosLibraryClient->updateAlbumCoverPhoto($albumId, $newCoverMediaItemId);

} catch (\Google\ApiCore\ApiException $e) {
    // Handle error
}
try {

    // ID of the album to update.
    $albumId = "ALBUM_ID";

    // New title of the album.
    // Must not be null or empty.
    $newTitle = "new-album-title";

    // Update the title of the album.
    $mediaItem = $photosLibraryClient->updateAlbumTitle($albumId, $newTitle);

} catch (\Google\ApiCore\ApiException $e) {
    // Handle error
}

将媒体内容添加到影集

您可以将用户 Google 相册媒体库中的媒体内容添加到影集，方法如下：呼叫 albums.batchAddMediaItems。媒体内容将按照此调用中指定的顺序添加到影集末尾。

如果指定无效的媒体内容或影集，则整个请求都将失败。不支持部分成功。

每个影集最多可包含 20,000 项媒体内容。请求添加更多就会失败

请注意，您只能添加从你的应用上传到您的应用程序中的相册已创建。媒体项还必须在用户的媒体库中。对于共享影集，其必须执行以下任一操作：用户或者用户必须是已经加入影集的协作者。

要将媒体内容添加到影集，请调用 albums.batchAddMediaItems 以及媒体内容和影集的标识符

REST

以下是 POST 请求的标头：

POST https://photoslibrary.googleapis.com/v1/albums/album-id:batchAddMediaItems
Content-type: application/json
Authorization: Bearer oauth2-token

请求正文如下所示：

{
   "mediaItemIds": [
     "media-item-id",
     "another-media-item-id",
     ...
   ]
}

如果成功，响应将返回一个空的 JSON 响应和 HTTP 成功状态。

Java

try {
  // List of media item IDs to add
  List<String> mediaItemIds = Arrays
      .asList("MEDIA_ITEM_ID", "ANOTHER_MEDIA_ITEM_ID");

  // ID of the album to add media items to
  String albumId = "ALBUM_ID";

  // Add all given media items to the album
  photosLibraryClient.batchAddMediaItemsToAlbum(albumId, mediaItemIds);

} catch (ApiException e) {
  // An exception is thrown if the media items could not be added
}

PHP

try {

    // List of media item IDs to add
    $mediaItemIds = ["MEDIA_ITEM_ID", "ANOTHER_MEDIA_ITEM_ID"];

    // ID of the album to add media items to
    $albumId = "ALBUM_ID";

    // Add all given media items to the album
    $response = $photosLibraryClient->batchAddMediaItemsToAlbum($albumId, $mediaItemIds);

} catch (\Google\ApiCore\ApiException $e) {
    // Handle Error
}

从影集中移除媒体内容

您可以调用 albums.batchRemoveMediaItems。

如果指定无效的媒体内容，则整个请求都将失败。部分支持不支持成功。

请注意，您只能从自己的应用中删除已添加到影集中或者曾经在影集中作为上传。专辑适用只有在以下情况下，您才能删除其他协作者添加的内容：是在代表所有者影集。

要从影集中移除媒体内容，请调用 albums.batchRemoveMediaItems 以及媒体内容和影集的标识符

REST

以下是 POST 请求的标头：

POST https://photoslibrary.googleapis.com/v1/albums/album-id:batchRemoveMediaItems
Content-type: application/json
Authorization: Bearer oauth2-token

请求正文如下所示：

{
   "mediaItemIds": [
     "media-item-id",
     "another-media-item-id",
     ...
   ]
}

如果成功，响应将返回一个空的 JSON 响应和 HTTP 成功状态。

Java

try {
  // List of media item IDs to remove
  List<String> mediaItemIds = Arrays
      .asList("MEDIA_ITEM_ID", "ANOTHER_MEDIA_ITEM_ID");

  // ID of the album to remove media items from
  String albumId = "ALBUM_ID";

  // Remove all given media items from the album
  photosLibraryClient.batchRemoveMediaItemsFromAlbum(albumId, mediaItemIds);

} catch (ApiException e) {
  // An exception is thrown if the media items could not be removed
}

PHP

try {

    // List of media item IDs to remove
    $mediaItemIds = ["MEDIA_ITEM_ID", "ANOTHER_MEDIA_ITEM_ID"];

    // ID of the album to remove media items from
    $albumId = "ALBUM_ID";

    // Remove all given media items from the album
    $response = $photosLibraryClient->batchRemoveMediaItemsFromAlbum($albumId, $mediaItemIds);

} catch (\Google\ApiCore\ApiException $e) {
    // Handle Error
}