در Google Photos، میتوانید عکسها و دیگر فایلهای رسانهای را بااستفاده از آلبومها سازماندهی کنید. یک فایل رسانهای میتواند با یک یا چند آلبوم مرتبط باشد. برای شروع مرتبط کردن فایلهای رسانهای با آلبوم، ابتدا باید آلبوم را ایجاد کنید.
گسترههای مجوز لازم
برای ایجاد آلبوم، به دامنه photoslibrary.appendonly نیاز است.
تغییر دادن عنوان یا عکس جلد آلبومها پساز ایجاد آنها به گستره photoslibrary.edit.appcreateddata نیاز دارد.
برای اطلاعات بیشتر درباره دامنهها، به دامنههای مجوز مراجعه کنید.
ایجاد آلبوم جدید
برای ایجاد آلبوم،
albums.create را فراخوانی کنید و
title را اضافه کنید. توجه داشته باشید که title به ۵۰۰ نویسه محدود شده است.
این فراخوانی یک آلبوم برمیگرداند. برنامه شما میتواند شناسه آلبوم را از این اطلاعات ذخیره کند و از آن برای بارگذاری موارد رسانهای در آلبوم خاص استفاده کند.
استراحت
در اینجا سرایندی برای درخواست پست (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"
}بازیابی جزئیات آلبوم
برای بازیابی جزئیات آلبوم موجودی که توسط برنامه شما ایجاد شده است،
albums.get را فراخوانی کنید و
albumId آلبومی را که میخواهید واکشی کنید اضافه کنید.
این فراخوانی یک آلبوم برمیگرداند.
استراحت
در اینجا سرایندی برای درخواست GET آورده شده است:
GET https://photoslibrary.googleapis.com/v1/albums/{albumId}
Content-type: application/json
Authorization: Bearer oauth2-token
متن درخواست به این شکل است:
{
"albumId": album-id
}اگر موفقیتآمیز باشد، پاسخ یک آلبوم برمیگرداند:
{
"id": album-id,
"title": album-title,
"productUrl": album-product-url,
"mediaItemsCount": media-items-count,
"coverPhotoBaseUrl": cover-photo-base-url,
"coverPhotoMediaItemId": cover-photo-media-item-id
}تغییر عنوان آلبوم و عکسهای روی جلد آلبوم
برای تغییر دادن عنوان آلبوم یا عکس سرصفحه، album update
call را با شناسه آلبوم ایجاد کنید و عنوان جدید یا شناسه فایل رسانهای عکس سرصفحه جدید را در درخواست اضافه کنید. برای ایجاد تغییر باید از گستره photoslibrary.edit.appcreateddata
مجوز استفاده کنید.
طول عنوان آلبوم نباید بیشتر از ۵۰۰ نویسه باشد. فایلهای رسانهای جلد باید متعلق به مالک آلبوم باشند و به آلبومی تعلق داشته باشند که قرار است جلد آن باشند.
استراحت
در اینجا سرایند درخواست 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"
}افزودن فایلهای رسانهای به آلبوم
میتوانید موارد رسانهای ایجادشده توسط برنامهتان را با فراخوانی
albums.batchAddMediaItems
به آلبومهای ایجادشده توسط برنامهتان اضافه کنید.
فایلهای رسانهای به ترتیبی که در این تماس ارائه شده است به انتهای آلبوم اضافه میشوند.
اگر فایل رسانهای یا آلبوم نامعتبری مشخص شده باشد، کل درخواست ناموفق خواهد بود. موفقیت جزئی پشتیبانی نمیشود.
هر آلبوم میتواند حداکثر ۲۰٬۰۰۰ فایل رسانهای داشته باشد. درخواستهای افزودن موارد بیشتر که از این حد فراتر برود ناموفق خواهد بود.
برای افزودن فایلهای رسانهای به آلبوم،
albums.batchAddMediaItems
را با شناسههای فایلهای رسانهای و آلبوم فراخوانی کنید.
استراحت
در اینجا سرایندی برای درخواست پست (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 را برمیگرداند.
برداشتن فایلهای رسانهای از آلبوم
میتوانید با فراخوانی albums.batchRemoveMediaItems، فایلهای رسانهای ایجادشده توسط برنامهتان را از آلبومهای ایجادشده توسط برنامهتان بردارید.
اگر فایلهای رسانهای نامعتبر مشخص شده باشد، کل درخواست ناموفق خواهد بود. موفقیت جزئی پشتیبانی نمیشود.
برای برداشتن فایلهای رسانهای از آلبوم،
albums.batchRemoveMediaItems
را با شناسههای فایلهای رسانهای و آلبوم فراخوانی کنید.
استراحت
در اینجا سرایندی برای درخواست پست (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 را برمیگرداند.
جاوا
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 }