Google Photos Library API の以前のドキュメントを表示しています。

このページは Cloud Translation API によって翻訳されました。

アルバムを管理する

Google フォトでは、アルバムを使用して写真やその他のメディアアイテムを整理できます。メディアアイテムは 1 つ以上のアルバムに関連付けることができます。関連付けを始めるにはメディアアイテムをアルバムに追加する場合は、まずアルバムを作成する必要があります。

必要な認可スコープ

アルバムを作成するには、アプリで次のうち少なくとも 1 つをリクエストする必要があります認可スコープ:

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"
  }
}

成功した場合、レスポンスは Album:

{
  "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 です。使用するには photoslibrary.edit.appcreateddata authorization スコープで変更が行われます。

アルバムタイトルは 500 文字以内で指定してください。メディアアイテムをカバーするアルバムのオーナーがオーナーで、カバーとなるアルバムに属しているできます。

REST

アルバムの title を更新するための PATCH リクエストヘッダーは次のとおりです。 coverPhotomediaItemId。

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

このリクエストにより、 updateMask パラメータで指定されるフィールドマスク URL を入力します。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
}

アルバムを管理する

必要な認可スコープ

新しいアルバムを作成する

REST

Java

PHP

アルバムのタイトルとカバー写真を変更する

REST

Java

PHP

アルバムにメディア アイテムを追加する

REST

Java

PHP

アルバムからメディア アイテムを削除する

REST

Java

PHP

アルバムにメディアアイテムを追加する

アルバムからメディアアイテムを削除する