প্রয়োজনীয় অনুমোদনের স্কোপ
Google Photos Library API-তে একাধিক স্কোপ রয়েছে যা মিডিয়া আইটেম ও অ্যালবাম অ্যাক্সেস করতে ব্যবহার করা হয়। ডেভেলপার কোন স্কোপের জন্য অনুরোধ করেছেন তার উপর ভিত্তি করে বিভিন্ন কল থেকে ফেরত আসা মিডিয়া আইটেমগুলি আলাদা হয়।
photoslibrary.readonly স্কোপ ব্যবহারকারীর লাইব্রেরির সব মিডিয়া আইটেম অ্যাক্সেস করার অনুমতি দেয়। photoslibrary.readonly.appcreateddata স্কোপ শুধুমাত্র অ্যাপের মাধ্যমে তৈরি করা মিডিয়া আইটেম অ্যাক্সেস করার অনুমতি দেয়। আরও তথ্যের জন্য, অনুমোদনের স্কোপ দেখুন।
এক নজরে
API-এর একটি গুরুত্বপূর্ণ ব্যবহার হল ব্যবহারকারী Google Photos-এ ব্যাক-আপ নিয়েছেন এমন মিডিয়া আইটেমের তালিকা তৈরি করা। কোনও নির্দিষ্ট অ্যালবামের আইটেম বা ব্যবহারকারীর সম্পূর্ণ লাইব্রেরি (Google Photos অ্যাপে ডিফল্ট ভিউ) তালিকাভুক্ত করা যেতে পারে।
ব্যবহারকারীর লাইব্রেরি থেকে আইটেম তালিকাভুক্ত করার সময়, আপনি ফটো বেছে নেওয়ার জন্য ফিল্টার ব্যবহার করতে পারবেন যা নির্দিষ্ট তারিখ, কন্টেন্ট বিভাগ বা মিডিয়ার ধরনের সাথে মিলে যায়। অ্যালবাম থেকে আইটেম তালিকাভুক্ত করার সময় এই ফিচার কাজ করে না।
লাইব্রেরি ও অ্যালবাম কন্টেন্ট তালিকাভুক্ত করলে মিডিয়া আইটেমের তালিকা পাওয়া যায়।
অ্যালবামের অংশ হিসেবে থাকা এনরিচমেন্ট
অন্তর্ভুক্ত করা হয় না। মিডিয়া আইটেম কোনও ফটো, ভিডিও বা অন্যান্য মিডিয়াকে বর্ণনা করে। mediaItem-এ আইটেমের সরাসরি লিঙ্ক, Google Photos-এ আইটেমের লিঙ্ক এবং অন্যান্য প্রাসঙ্গিক মেটাডেটা অন্তর্ভুক্ত থাকে। আরও তথ্যের জন্য,
মিডিয়া আইটেম অ্যাক্সেস করুন এবং
mediaItems দেখুন।
অ্যালবাম তালিকাভুক্ত করা হচ্ছে
আপনি albums.list ব্যবহার করে ব্যবহারকারীর অ্যালবামের তালিকা ফিরিয়ে আনতে পারবেন।
বিশ্রাম
এখানে একটি স্যাম্পেল অনুরোধ দেওয়া হল:
GET https://photoslibrary.googleapis.com/v1/albums
অনুরোধের ফলে নিম্নলিখিত ফলাফল পাওয়া যায়:
{
"albums": [
{
"id": "album-id",
"title": "album-title",
"productUrl": "album-product-url",
"coverPhotoBaseUrl": "album-cover-base-url_do-not-use-directly",
"coverPhotoMediaItemId": "album-cover-media-item-id",
"isWriteable": "whether-you-can-write-to-this-album",
"mediaItemsCount": "number-of-media-items-in-album"
},
...
],
"nextPageToken": "token-for-pagination"
}Java
try { // Make a request to list all albums in the user's library // Iterate over all the albums in this list // Pagination is handled automatically ListAlbumsPagedResponse response = photosLibraryClient.listAlbums(); for (Album album : response.iterateAll()) { // Get some properties of an album String id = album.getId(); String title = album.getTitle(); String productUrl = album.getProductUrl(); String coverPhotoBaseUrl = album.getCoverPhotoBaseUrl(); // The cover photo media item id field may be empty String coverPhotoMediaItemId = album.getCoverPhotoMediaItemId(); boolean isWritable = album.getIsWriteable(); long mediaItemsCount = album.getMediaItemsCount(); } } catch (ApiException e) { // Handle error }
PHP
try { // Make a request to list all albums in the user's library // Iterate over all the albums in this list // Pagination is handled automatically $response = $photosLibraryClient->listAlbums(); foreach ($response->iterateAllElements() as $album) { // Get some properties of an album $albumId = $album->getId(); $title = $album->getTitle(); $productUrl = $album->getProductUrl(); $coverPhotoBaseUrl = $album->getCoverPhotoBaseUrl(); // The cover photo media item id field may be empty $coverPhotoMediaItemId = $album->getCoverPhotoMediaItemId(); $isWriteable = $album->getIsWriteable(); $totalMediaItems = $album->getTotalMediaItems(); } } catch (\Google\ApiCore\ApiException $e) { // Handle error }
ফিরে আসা প্রতিটি অ্যালবামের একটি আইডি থাকে যা অ্যালবামের কন্টেন্ট তালিকাভুক্ত করা-তে দেখানো অ্যালবামের কন্টেন্ট ফিরিয়ে আনতে ব্যবহার করা যেতে পারে। এছাড়াও, এতে মিডিয়া আইটেমের নাম ও সংখ্যা অন্তর্ভুক্ত থাকে।
productUrl Google Photos-এ অ্যালবামকে নির্দেশ করে যা ব্যবহারকারী
খুলতে পারেন।
coverPhotoMediaItemId-এ মিডিয়া আইটেম
আইডি থাকে যা
এই অ্যালবামের কভার ফটোকে দেখায়। এই কভার ছবি অ্যাক্সেস করতে,
coverPhotoBaseUrl ব্যবহার করুন। অতিরিক্ত
প্যারামিটার উল্লেখ না করে সরাসরি coverPhotoBaseUrl ব্যবহার করা উচিত নয়।
ব্যবহারকারীর অ্যাকাউন্টে তৈরি করা বা ব্যবহারকারীর অ্যাকাউন্টে যোগ করা এবং আপনার অ্যাপের শেয়ার করা অ্যালবামে একটি অতিরিক্ত shareInfo প্রপার্টি অন্তর্ভুক্ত থাকে।
আরও জানতে, মিডিয়া শেয়ার করুন দেখুন।
অ্যালবামে isWriteable ফ্ল্যাগও থাকতে পারে যা নির্দেশ করে যে আপনি অ্যালবামে মিডিয়া আইটেম তৈরি করতে পারবেন কিনা। এই ফ্ল্যাগটি ফেরত না দেওয়া হলে ডিফল্ট হিসেবে false হয়ে যায়। এটি
আপনার অ্যাপ্লিকেশনকে দেওয়া অ্যাক্সেসের উপর নির্ভর করে, যার মধ্যে নিম্নলিখিতগুলি অন্তর্ভুক্ত:
- কে অ্যালবামটি তৈরি করেছেন।
- এটি শেয়ার করা হয়েছে কিনা।
- ব্যবহারকারী কোন কোন স্কোপ অনুমোদন করেছেন।
এইসব মাপকাঠির মধ্যে কোনও একটি পরিবর্তন হলে, এই ফ্ল্যাগ পরিবর্তন হতে পারে। আরও জানতে,
অ্যালবাম তৈরি করুন দেখুন। উত্তরে
একটি nextPageToken-ও আছে। আরও তথ্যের জন্য,
পৃষ্ঠা সংখ্যা দেখুন।
খালি অ্যালবামের ক্ষেত্রে উত্তর আলাদা হয়, mediaItemsCount এবং
coverPhotoMediaItemId ডিফল্ট হিসেবে ০-তে সেট করা থাকে এবং REST
উত্তরে অন্তর্ভুক্ত করা হয় না। এছাড়াও মনে রাখবেন যে coverPhotoBaseUrl ডিফল্ট প্লেসহোল্ডার ইমেজকে
নির্দেশ করে।
লাইব্রেরি কন্টেন্ট তালিকাভুক্ত করা হচ্ছে
আপনি ব্যবহারকারীর Google Photos লাইব্রেরি থেকে সব মিডিয়া আইটেমের তালিকা তৈরি করতে পারবেন। এটি আর্কাইভ করা ও মুছে ফেলা আইটেম বাদ দেয়। ফিল্টার প্রয়োগ করে আপনি কন্টেন্ট, তারিখ ও অন্যান্য বৈশিষ্ট্যের ভিত্তিতে মিডিয়া আইটেমের তালিকা তৈরি করতে পারবেন। ব্যবহারকারী যদি তার Google Photos-এর শেয়ারিং ট্যাবে উপলভ্য কোনও আইটেম তার লাইব্রেরিতে যোগ না করে থাকেন, তাহলে সেই আইটেমটি এই তালিকায় অন্তর্ভুক্ত করা হয় না।
কোনও মিডিয়া আইটেম ফিরিয়ে আনতে, mediaItems.list কল করুন।
বিশ্রাম
এখানে একটি স্যাম্পেল অনুরোধ দেওয়া হল:
GET https://photoslibrary.googleapis.com/v1/mediaItems
Content-type: application/json
Authorization: Bearer oauth2-token
{
"pageSize": "100",
}GET অনুরোধ নিম্নলিখিত উত্তর প্রদান করে:
{
"mediaItems": [
...
],
"nextPageToken": "token-for-pagination"
}Java
try { // Make a request to list all media items in the user's library // Iterate over all the retrieved media items // Pagination is handled automatically ListMediaItemsPagedResponse response = photosLibraryClient.listMediaItems(); for (MediaItem item : response.iterateAll()) { // Get some properties of a media item String id = item.getId(); String description = item.getDescription(); String mimeType = item.getMimeType(); String productUrl = item.getProductUrl(); String filename = item.getFilename(); } } catch (ApiException e) { // Handle error }
PHP
try { // Make a request to list all media items in the user's library // Iterate over all the retrieved media items // Pagination is handled automatically $response = $photosLibraryClient->listMediaItems(); foreach ($response->iterateAllElements() as $item) { // Get some properties of a media item /* @var $item \Google\Photos\Library\V1\MediaItem */ $id = $item->getId(); $description = $item->getDescription(); $mimeType = $item->getMimeType(); $productUrl = $item->getProductUrl(); $filename = $item->getFilename(); } } catch (\Google\ApiCore\ApiException $e) { // Handle error }
উত্তরে মিডিয়া আইটেমের তালিকা রয়েছে, যা সবচেয়ে সাম্প্রতিক থেকে সবচেয়ে পুরনো হিসেবে সাজানো হয়েছে।
আরও তথ্যের জন্য,
mediaItems দেখুন। এছাড়াও, এতে
nextPageToken থাকে, যা পৃষ্ঠা সংখ্যা-এ আরও বিস্তারিতভাবে
বর্ণনা করা হয়েছে।
অ্যালবামের কন্টেন্ট তালিকাভুক্ত করা হচ্ছে
অ্যালবামে সব মিডিয়া আইটেমের তালিকা দেখতে, আপনার সার্চ অনুরোধে albumId ফিল্ড যোগ করুন। albumId সম্পর্কে আরও তথ্যের জন্য, অ্যালবাম
তালিকাভুক্ত করা এবং শেয়ার করা অ্যালবাম তালিকাভুক্ত করা দেখুন। albumId
ভুল হলে, Bad Request সমস্যা পাওয়া গেছে। আইডিটি সঠিক হলে,
কিন্তু যাচাই করা ব্যবহারকারীর জন্য অ্যালবামটি না থাকলে, একটি Not Found ত্রুটি
ফেরত দেওয়া হয়। সমস্যা ম্যানেজ করা সম্পর্কে আরও জানতে, পারফর্ম্যান্স
পরামর্শ এবং পেশাদার
পদ্ধতি দেখুন।
বিশ্রাম
এখানে একটি স্যাম্পেল অনুরোধ দেওয়া হল:
POST https://photoslibrary.googleapis.com/v1/mediaItems:search
Content-type: application/json
Authorization: Bearer oauth2-token
{
"pageSize": "100",
"albumId": "album-id"
}পোস্ট রিকোয়েস্ট নিম্নলিখিত উত্তর পাঠায়:
{
"mediaItems": [
...
],
"nextPageToken": "token-for-pagination"
}Java
try { // Make a request to list all media items in an album // Provide the ID of the album as a parameter in the searchMediaItems call // Iterate over all the retrieved media items SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(albumId); for (MediaItem item : response.iterateAll()) { // ... } } catch (ApiException e) { // Handle error }
PHP
try { // Make a request to list all media items in an album // Provide the ID of the album as a parameter in the searchMediaItems call // Iterate over all the retrieved media items $response = $photosLibraryClient->searchMediaItems(['albumId' => $albumId]); foreach ($response->iterateAllElements() as $item) { // ... } } catch (\Google\ApiCore\ApiException $e) { // Handle error }
উত্তরে একটি nextPageToken এবং মিডিয়া আইটেমের তালিকা রয়েছে। লাইব্রেরির কন্টেন্ট তালিকাভুক্ত করার সময় থেকে আলাদা, মিডিয়া আইটেমগুলি অ্যালবামে তাদের ক্রম অনুসারে ফেরত দেওয়া হয়। আরও জানতে,
mediaItems
এবং পৃষ্ঠা সংখ্যা দেখুন। ব্যবহারকারী Google Photos ইন্টারফেস থেকে
অর্ডার এডিট করতে পারবেন।
albumId সেট করা থাকলে, অ্যালবাম কন্টেন্ট তালিকাভুক্ত করার সময় আপনি ফিল্টার প্রয়োগ করতে পারবেন না।
এটি করলে Bad Request সমস্যা হয়।
শেয়ার করা অ্যালবামের তালিকা তৈরি করা হচ্ছে
ব্যবহারকারী শেয়ার করেছেন বা ব্যবহারকারীর সাথে শেয়ার করা হয়েছে এমন সব অ্যালবামের তালিকা আপনি পেতে পারেন। এটি Google Photos অ্যাপের শেয়ারিং ট্যাবের মতোই।
ব্যবহারকারী তার Google Photos লাইব্রেরিতে যোগ করেছেন এমন শেয়ার করা অ্যালবামও অ্যালবাম তালিকাভুক্ত করা কলের মাধ্যমে ফেরত পাঠানো হয়। Library API-এর মাধ্যমে শেয়ার করা অ্যালবামের তালিকা পেতে নিম্নলিখিত কল করুন:
বিশ্রাম
এখানে একটি স্যাম্পেল অনুরোধ দেওয়া হল:
GET https://photoslibrary.googleapis.com/v1/sharedAlbums
অনুরোধের ফলে নিম্নলিখিত ফলাফল পাওয়া যায়:
{
"sharedAlbums": [...]
"nextPageToken": "token-for-pagination"
}Java
try { // Make a request to list all albums that have been shared by the user // Iterate over all the albums in this list // Pagination is handled automatically ListSharedAlbumsPagedResponse response = photosLibraryClient.listSharedAlbums(); for (Album album : response.iterateAll()) { // .. } } catch (ApiException e) { // Handle error }
PHP
try { // Make a request to list all albums that have been shared by the user // Iterate over all the albums in this list // Pagination is handled automatically $response = $photosLibraryClient->listSharedAlbums(); foreach ($response->iterateAllElements() as $album) { // ... } } catch (\Google\ApiCore\ApiException $e) { // Handle error }
sharedAlbums-এ অ্যালবামের তালিকা অন্তর্ভুক্ত করা হয়েছে। আরও তথ্যের জন্য,
অ্যালবাম তালিকাভুক্ত করা দেখুন। উত্তরে একটি nextPageTokenও রয়েছে।
আরও তথ্যের জন্য, পৃষ্ঠা সংখ্যা দেখুন।
আপনার অ্যাপের তৈরি ও শেয়ার করা অ্যালবামে অতিরিক্ত shareInfo
প্রপার্টি অন্তর্ভুক্ত থাকে। আরও জানতে, মিডিয়া
শেয়ার করুন বিকল্প দেখুন।
অ্যাপের তৈরি করা অ্যালবাম তালিকাভুক্ত করা হচ্ছে
আপনি নিম্নলিখিত কলে excludeNonAppCreatedData-এর ভ্যালু true-এ সেট করে আপনার অ্যাপের মাধ্যমে তৈরি করা অ্যালবামের তালিকা তৈরি করতে পারেন:
বিশ্রাম
ব্যবহারকারীর Google Photos লাইব্রেরি থেকে শুধুমাত্র আপনার অ্যাপের মাধ্যমে তৈরি করা সব অ্যালবামের তালিকা পেতে GET অনুরোধ এখানে দেওয়া হল:
GET https://photoslibrary.googleapis.com/v1/albums?excludeNonAppCreatedData=true Content-type: application/json Authorization: Bearer oauth2-token
ব্যবহারকারীর Google Photos লাইব্রেরি থেকে শুধুমাত্র আপনার অ্যাপের মাধ্যমে তৈরি করা সব শেয়ার করা অ্যালবামের তালিকা পেতে GET অনুরোধ এখানে দেওয়া হল:
GET https://photoslibrary.googleapis.com/v1/sharedAlbums?excludeNonAppCreatedData=true Content-type: application/json Authorization: Bearer oauth2-token
Java
try { // Make a request to list all albums that have been created by your app boolean excludeNonAppCreatedData = true; // Iterate over all the albums in this list // Pagination is handled automatically ListAlbumsPagedResponse response = photosLibraryClient.listAlbums(excludeNonAppCreatedData); for (Album album : response.iterateAll()) { // .. } } catch (ApiException e) { // Handle error } try { // Make a request to list all shared albums that have been created by your app boolean excludeNonAppCreatedData = true; // Iterate over all the albums in this list // Pagination is handled automatically ListSharedAlbumsPagedResponse response = photosLibraryClient.listSharedAlbums(excludeNonAppCreatedData); for (Album album : response.iterateAll()) { // .. } } catch (ApiException e) { // Handle error }
PHP
try { // Make a request to list all albums that have been created by your app $response = $photosLibraryClient->listAlbums(['excludeNonAppCreatedData' => true]); // Iterate over all the albums in this list // Pagination is handled automatically foreach ($response->iterateAllElements() as $album) { // ... } } catch (\Google\ApiCore\ApiException $e) { // Handle error } try { // Make a request to list all shared albums that have been created by your app $response = $photosLibraryClient->listSharedAlbums(['excludeNonAppCreatedData' => true]); // Iterate over all the albums in this list // Pagination is handled automatically foreach ($response->iterateAllElements() as $album) { // ... } } catch (\Google\ApiCore\ApiException $e) { // Handle error }
REST-এর জন্য পৃষ্ঠার ক্রমসংখ্যা
পারফর্ম্যান্স উন্নত করতে, যেসব পদ্ধতি অনেক ফলাফল দেখায় (যেমন
তালিকা পদ্ধতি) সেগুলি উত্তরকে পেজিনেট করতে পারে। প্রতিটি পৃষ্ঠায় সর্বাধিক কতগুলি ফলাফল দেখানো হবে তা pageSize প্যারামিটার দ্বারা
নির্ধারিত হয়।
mediaItems:search এবং mediaItems:list-এ কলের জন্য, ডিফল্ট পৃষ্ঠার সাইজ হল
২৫টি আইটেম। আমরা এই পৃষ্ঠার সাইজ সাজেস্ট করি কারণ এটি রেসপন্সের সাইজ এবং ফিল রেটের মধ্যে
ভারসাম্য বজায় রাখে। মিডিয়া আইটেম সার্চ ও তালিকা সংক্রান্ত অনুরোধের জন্য
পৃষ্ঠার সর্বাধিক সাইজ হল ১০০টি আইটেম।
অ্যালবাম তালিকাভুক্ত করার সময় ডিফল্ট এবং সাজেস্ট করা পৃষ্ঠার সাইজ হল ২০টি অ্যালবাম, সর্বাধিক ৫০টি অ্যালবাম।
উপলভ্য ফলাফলের সংখ্যা পৃষ্ঠার সাইজের থেকে বেশি হলে, উত্তরে
nextPageToken অন্তর্ভুক্ত থাকে, যা আপনার অ্যাপ্লিকেশনকে ইঙ্গিত করে যে সার্ভার থেকে
আরও ফলাফল আনতে হবে।
উদাহরণ
আপনাকে অবশ্যই প্যারামিটার pageToken-এ পরবর্তী অনুরোধে nextPageToken যোগ করতে হবে,
যেমনটি নিম্নলিখিত উদাহরণে দেখানো হয়েছে। অনুরোধের বডিতে অথবা কোয়েরি প্যারামিটার হিসেবে, অপারেশনের জন্য প্রয়োজনীয় অন্যান্য প্যারামিটারের সাথে pageToken উল্লেখ করুন।
অনুরোধ #১
{
"pageSize": "5",
"filters": { … }
}উত্তর #১
{
"mediaItem": [ … ],
"nextPageToken": "next-page-token"
}অনুরোধ #২
{
"pageSize": "5",
"filters": { … },
"pageToken": "page-token"
}উত্তর #২
{
"mediaItem": [ … ],
"nextPageToken": "next-page-token"
}nextPageToken অবজেক্ট আর না থাকা পর্যন্ত এই প্যাটার্ন চালিয়ে যান।
nextPageToken শুধুমাত্র একই অনুরোধের জন্য প্রযোজ্য। কোনও প্যারামিটার পরিবর্তন করা হলে, একই অনুরোধে আগে ব্যবহার করা nextPageToken ব্যবহার করা উচিত নয়।