Cakupan otorisasi yang diperlukan
Cakupan photoslibrary.readonly
memungkinkan akses ke semua item media di
library pengguna.
Menelusuri dan menerapkan filter ke konten buatan aplikasi memerlukan cakupan
photoslibrary.readonly.appcreateddata
. Untuk informasi selengkapnya tentang cakupan,
lihat Cakupan otorisasi.
Filter yang tersedia
Anda dapat menelusuri jenis media tertentu di library item media yang dibuat aplikasi pengguna. Misalnya, Anda mungkin hanya menginginkan item yang berisi hewan, dari hari tertentu, atau Anda mungkin ingin mengecualikan foto tanda terima. Anda dapat mengecualikan atau menyertakan item tertentu dengan menerapkan filter ke listingan album atau library. Ada lima filter yang tersedia berdasarkan properti item media:
- Kategori konten (
includedContentCategories
,excludedContentCategories
) - Tanggal dan rentang tanggal (
dates
,ranges
) - Fitur (
featureFilter
) - Jenis media (
mediaTypeFilter
) - Status diarsipkan (
includeArchivedMedia
)
Filter tidak boleh digunakan dalam permintaan mediaItems.search
jika albumId
ditetapkan. Jika filter digunakan saat albumId ditetapkan, error INVALID_ARGUMENT
(400) akan ditampilkan.
Hasil diurutkan sesuai dengan waktu pembuatan item media. Urutan pengurutan dapat diubah untuk kueri yang menggunakan filter tanggal.
Perlu waktu beberapa saat agar media yang baru diupload muncul dalam penelusuran Anda. Media tersebut akan langsung muncul dalam penelusuran yang tidak difilter.
Item media yang memiliki tanggal di masa mendatang tidak akan muncul di penelusuran yang difilter. Video ini muncul dalam penelusuran dan penelusuran album yang tidak difilter.
Menerapkan filter
Untuk menerapkan filter, panggil
mediaItems.search
dan
tentukan properti filter
.
REST
Berikut adalah permintaan POST:
POST https://photoslibrary.googleapis.com/v1/mediaItems:search Content-type: application/json Authorization: Bearer oauth2-token { "pageSize": "100", "filters": { ... } }
Permintaan POST menampilkan respons berikut:
{ "mediaItems": [ ... ], "nextPageToken": "token-for-pagination" }
Java
try { // Create a new Filter object Filters filters = Filters.newBuilder() // .setContentFilter(...) // .setDateFilter(...) // ... .build(); // Specify the Filter object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters); for (MediaItem item : response.iterateAll()) { // ... } } catch (ApiException e) { // Handle error }
PHP
try { $filtersBuilder = new FiltersBuilder(); // $filtersBuilder->addIncludedCategory(...); // $filtersBuilder->addDate(...); // ... // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] ); foreach ($response->iterateAllElements() as $element) { // ... } } catch (\Google\ApiCore\ApiException $e) { // Handle error }
Untuk mengetahui detailnya, lihat Mencantumkan konten library, album, dan item media.
Kategori konten
Semua item media diproses dan diberi label. Anda dapat menyertakan dan mengecualikan salah satu kategori berikut.
ANIMALS |
FASHION |
LANDMARKS |
RECEIPTS |
WEDDINGS |
ARTS |
FLOWERS |
LANDSCAPES |
SCREENSHOTS |
WHITEBOARDS |
BIRTHDAYS |
FOOD |
NIGHT |
SELFIES |
|
CITYSCAPES |
GARDENS |
PEOPLE |
SPORT |
|
CRAFTS |
HOLIDAYS |
PERFORMANCES |
TRAVEL |
|
DOCUMENTS |
HOUSES |
PETS |
UTILITY |
Foto utilitas mencakup berbagai media. Kategori ini umumnya mencakup item yang telah diambil pengguna untuk melakukan beberapa tugas dan tidak mungkin diinginkan setelah tugas tersebut selesai. Item tersebut mencakup dokumen, tanda terima, screenshot, catatan tempel, menu, dan item media serupa lainnya.
Kategori hanya seakurat label yang setara di Google Foto. Terkadang, item mungkin salah diberi label, sehingga kami tidak menjamin akurasi filter kategori konten.
Menyertakan kategori
Jika Anda menyertakan beberapa kategori, item media yang cocok dengan salah satu
kategori akan disertakan. Maksimum 10 kategori dapat disertakan per permintaan.
Contoh filter ini menampilkan item LANDSCAPES
atau LANDMARKS
.
REST
{ "filters": { "contentFilter": { "includedContentCategories": [ "LANDSCAPES", "LANDMARKS" ] } } }
Java
// Create a content filter that includes landmarks and landscapes ContentFilter contentFilter = ContentFilter.newBuilder() .addIncludedContentCategories(ContentCategory.LANDMARKS) .addIncludedContentCategories(ContentCategory.LANDSCAPES) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setContentFilter(contentFilter) .build(); // Specify the Filter object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a content filter that includes landmarks and landscapes $filtersBuilder = new FiltersBuilder(); $filtersBuilder->addIncludedCategory(ContentCategory::LANDMARKS); $filtersBuilder->addIncludedCategory(ContentCategory::LANDSCAPES); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Mengecualikan kategori
Hanya item media yang tidak cocok dengan kategori yang dikecualikan yang akan ditampilkan. Serupa dengan kategori yang disertakan, maksimal 10 kategori dapat dikecualikan per permintaan.
Filter ini menampilkan item apa pun yang bukan PEOPLE
atau SELFIES
:
REST
{ "filters": { "contentFilter": { "excludedContentCategories": [ "PEOPLE", "SELFIES" ] } } }
Java
// Create a content filter that excludes people and selfies ContentFilter contentFilter = ContentFilter.newBuilder() .addExcludedContentCategories(ContentCategory.PEOPLE) .addExcludedContentCategories(ContentCategory.SELFIES) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setContentFilter(contentFilter) .build(); // Specify the Filter object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a content filter that excludes people and selfies $filtersBuilder = new FiltersBuilder(); $filtersBuilder->addExcludedCategory(ContentCategory::PEOPLE); $filtersBuilder->addExcludedCategory(ContentCategory::SELFIES); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Menyertakan dan mengecualikan beberapa kategori
Anda dapat menyertakan beberapa kategori dan mengecualikan kategori lainnya. Contoh berikut
menampilkan LANDSCAPES
dan LANDMARKS
, tetapi menghapus item media apa pun yang berisi
PEOPLE
atau SELFIES
:
REST
{ "filters": { "contentFilter": { "includedContentCategories": [ "LANDSCAPES", "LANDMARKS" ], "excludedContentCategories": [ "PEOPLE", "SELFIES" ] } } }
Java
// Create a content filter that excludes people and selfies and includes landmarks and landscapes ContentFilter contentFilter = ContentFilter.newBuilder() .addIncludedContentCategories(ContentCategory.LANDSCAPES) .addIncludedContentCategories(ContentCategory.LANDMARKS) .addExcludedContentCategories(ContentCategory.PEOPLE) .addExcludedContentCategories(ContentCategory.SELFIES) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setContentFilter(contentFilter) .build(); // Specify the Filters object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a content filter that excludes people and selfies and includes landmarks and landscapes $filtersBuilder = new FiltersBuilder(); $filtersBuilder->addIncludedCategory(ContentCategory::LANDMARKS); $filtersBuilder->addIncludedCategory(ContentCategory::LANDSCAPES); $filtersBuilder->addExcludedCategory(ContentCategory::PEOPLE); $filtersBuilder->addExcludedCategory(ContentCategory::SELFIES); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Tanggal dan rentang tanggal
Filter tanggal membatasi tanggal hasil yang ditampilkan ke kumpulan hari yang ditentukan. Ada dua cara untuk menentukan filter tanggal: tanggal, atau rentang. Tanggal dan rentang dapat digunakan bersama. Item media yang cocok dengan salah satu tanggal atau rentang tanggal akan ditampilkan. Secara opsional, urutan pengurutan hasil dapat diubah.
Tanggal
Tanggal berisi tahun, bulan, dan hari. Format berikut dapat diterima:
- Tahun
- Tahun, bulan
- Tahun, bulan, tanggal
- Bulan, hari
- Bulan
Jika komponen tanggal kosong atau ditetapkan ke nol, komponen tersebut akan diperlakukan sebagai karakter pengganti. Misalnya, jika Anda menetapkan hari dan bulan, tetapi tidak menetapkan tahun, Anda akan meminta item dari hari dan bulan tersebut pada tahun mana pun:
REST
{ "filters": { "dateFilter": { "dates": [ { "month": 2, "day": 15 } ] } } }
Java
// Create a new com.google.type.Date object using a builder // Note that there are different valid combinations as described above Date dayFebruary15 = Date.newBuilder() .setDay(15) .setMonth(2) .build(); // Create a new dateFilter. You can also set multiple dates here DateFilter dateFilter = DateFilter.newBuilder() .addDates(dayFebruary15) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setDateFilter(dateFilter) .build(); // Specify the Filters object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a new Google\Type\Date object with a day and a month // Note that there are different valid combinations as described above $dateFebruary15 = new Date(); $dateFebruary15->setDay(15); $dateFebruary15->setMonth(2); $filtersBuilder = new FiltersBuilder(); // Add the date to the filter. You can also set multiple dates here $filtersBuilder->addDate($dateFebruary15); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Rentang tanggal
Rentang tanggal memberikan fleksibilitas yang lebih besar daripada tanggal. Misalnya, daripada menambahkan beberapa tanggal, rentang tanggal dapat digunakan untuk melihat serangkaian hari dalam sebulan.
Rentang tanggal memiliki startDate
dan endDate
, yang keduanya harus ditetapkan. Setiap
tanggal dalam rentang memiliki batasan format yang sama seperti yang dijelaskan dalam
Tanggal. Tanggal harus memiliki format yang sama: jika tanggal mulai adalah
tahun dan bulan, tanggal akhir juga harus tahun dan bulan. Rentang diterapkan secara inklusif, tanggal mulai dan akhir disertakan dalam filter yang diterapkan:
REST
{ "filters": { "dateFilter": { "ranges": [ { "startDate": { "year": 2014, "month": 6, "day": 12 }, "endDate": { "year": 2014, "month": 7, "day": 13 } } ] } } }
Java
// Create new com.google.type.Date objects for two dates Date day2014June12 = Date.newBuilder() .setDay(12) .setMonth(6) .setYear(2014) .build(); Date day2014July13 = Date.newBuilder() .setDay(13) .setMonth(7) .setYear(2014) .build(); // Create a DateRange from these two dates DateRange dateRange = DateRange.newBuilder() .setStartDate(day2014June12) .setEndDate(day2014July13) .build(); // Create a new dateFilter with the date range. You can also set multiple date ranges here DateFilter dateFilter = DateFilter.newBuilder() .addRanges(dateRange) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setDateFilter(dateFilter) .build(); // Specify the Filters object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create two new Google\Type\Date objects $date2014June12 = new Date(); $date2014June12->setDay(12); $date2014June12->setMonth(6); $date2014June12->setYear(2014); $date2014July13 = new Date(); $date2014July13->setDay(13); $date2014July13->setMonth(7); $date2014July13->setYear(2014); // Add the two dates as a date range to the filter // You can also set multiple date ranges here $filtersBuilder = new FiltersBuilder(); $filtersBuilder->addDateRange($date2014June12, $date2014July13); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Menggabungkan tanggal dan rentang tanggal
Anda dapat menggunakan beberapa tanggal dan beberapa rentang tanggal secara bersamaan. Item yang termasuk dalam salah satu tanggal tersebut disertakan dalam hasil. Tanggal dan rentang tanggal terpisah tidak perlu mengikuti format yang sama, tetapi tanggal mulai dan akhir setiap rentang harus mengikuti format yang sama:
REST
{ "filters": { "dateFilter": { "dates": [ { "year": 2013 }, { "year": 2011, "month": 11 } ], "ranges": [ { "startDate": { "month": 1 }, "endDate": { "month": 3 } }, { "startDate": { "month": 3, "day": 24 }, "endDate": { "month": 5, "day": 2 } } ] } } }
Java
// Create a new com.google.type.Date object for the year 2013 Date day2013 = Date.newBuilder() .setYear(2013) .build(); // Create a new com.google.type.Date object for November 2011 Date day2011November = Date.newBuilder() .setMonth(11) .setYear(2011) .build(); // Create a date range for January to March DateRange dateRangeJanuaryToMarch = DateRange.newBuilder() .setStartDate(Date.newBuilder().setMonth(1).build()) .setEndDate(Date.newBuilder().setMonth(3).build()) .build(); // Create a date range for March 24 to May 2 DateRange dateRangeMarch24toMay2 = DateRange.newBuilder() .setStartDate(Date.newBuilder().setMonth(3).setDay(24).build()) .setEndDate(Date.newBuilder().setMonth(5).setDay(2).build()) .build(); // Create a new dateFilter with the dates and date ranges DateFilter dateFilter = DateFilter.newBuilder() .addDates(day2013) .addDates(day2011November) .addRanges(dateRangeJanuaryToMarch) .addRanges(dateRangeMarch24toMay2) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setDateFilter(dateFilter) .build(); // Specify the Filter object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a new Google\Type\Date object for the year 2013 $date2013 = new Date(); $date2013->setYear(2013); // Create a new Google\Type\Date object for November 2011 $dateNovember2011 = new Date(); $dateNovember2011->setMonth(11); $dateNovember2011->setYear(2011); $filtersBuilder = new FiltersBuilder(); // Create a date range for January to March $filtersBuilder->addDateRange((new Date())->setMonth(1), (new Date())->setMonth(3)); // Create a date range for March 24 to May 2 $filtersBuilder->addDateRange((new Date())->setMonth(3)->setDay(24), (new Date())->setMonth(5)->setDay(2)); $filtersBuilder->addDate($date2013); $filtersBuilder->addDate($dateNovember2011); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Fitur item media
Filter fitur membatasi hasil ke item yang memiliki fitur tertentu, misalnya, yang telah ditandai sebagai favorit di aplikasi Google Foto.
Favorit
Sertakan fitur item
FAVORITES
di
FeatureFilter
agar hanya menampilkan item media yang telah ditandai sebagai favorit oleh pengguna:
REST
{ "filters" : { "featureFilter": { "includedFeatures": [ "FAVORITES" ] } } }
Java
// Create a new FeatureFilter for favorite media items FeatureFilter featureFilter = FeatureFilter.newBuilder() .addIncludedFeatures(Feature.FAVORITES) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setFeatureFilter(featureFilter) .build(); // Specify the Filters object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a new FeatureFilter for favorite media items $filtersBuilder = new FiltersBuilder(); $filtersBuilder->addIncludedFeature(Feature::FAVORITES); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Jenis media
Anda dapat membatasi hasil berdasarkan jenis media: foto atau video.
Foto
PHOTO
dapat berupa salah satu dari beberapa format gambar:
BMP | JPG |
GIF | PNG |
HEIC | TIFF |
ICO | WEBP |
Ini juga menyertakan jenis foto khusus seperti foto live iOS, foto motion, panorama, photo sphere, dan foto VR.
Video
VIDEO
dapat berupa berbagai format video:
3GP | MMV |
3G2 | MOD |
ASF | MOV |
AVI | MP4 |
DIVX | MPG |
M2T | MTS |
M2TS | TOD |
M4V | WMV |
MKV |
VIDEO
juga mencakup format video khusus seperti berikut: video VR,
video slow motion, dan animasi yang dibuat di aplikasi
Google Foto.
Contoh berikut memfilter menurut PHOTO
:
REST
{ "filters": { "mediaTypeFilter": { "mediaTypes": [ "PHOTO" ] } } }
Java
// Create a new MediaTypeFilter for Photo media items MediaTypeFilter mediaType = MediaTypeFilter.newBuilder() .addMediaTypes(MediaType.PHOTO) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setMediaTypeFilter(mediaType) .build(); // Specify the Filters object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a new MediaTypeFilter for Photo media items $filtersBuilder = new FiltersBuilder(); $filtersBuilder->setMediaType(MediaType::PHOTO); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Beberapa filter jenis media tidak dapat digabungkan.
Status diarsipkan
Pengguna Anda mungkin telah mengarsipkan beberapa foto mereka. Secara default, foto yang diarsipkan tidak ditampilkan dalam penelusuran. Untuk menyertakan item yang diarsipkan, Anda dapat menetapkan tanda di filter seperti yang ditunjukkan dalam contoh berikut:
REST
{ "filters": { "includeArchivedMedia": true } }
Java
// Create a new Filters object that includes archived media Filters filters = Filters.newBuilder() .setIncludeArchivedMedia(true) .build(); // Specify the Filters object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a new Filters object that includes archived media $filtersBuilder = new FiltersBuilder(); $filtersBuilder->setIncludeArchivedMedia(true); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Menggabungkan filter
Berbagai jenis filter dapat digabungkan. Hanya item yang cocok dengan semua fitur yang diminta yang akan ditampilkan.
Saat menggabungkan filter, batasan pemformatan untuk setiap jenis filter sama dengan saat filter digunakan satu per satu. Dalam contoh berikut, hanya foto
yang telah dikategorikan sebagai SPORT
dan yang berasal dari tahun 2014 atau 2010 yang
ditampilkan:
REST
{ "filters": { "contentFilter": { "includedContentCategories": [ "SPORT" ] }, "dateFilter": { "dates": [ { "year": 2014 }, { "year": 2010 } ] }, "mediaTypeFilter": { "mediaTypes": [ "PHOTO" ] } } }
Java
// Create a new ContentFilter that only includes SPORT items ContentFilter contentFilter = ContentFilter.newBuilder() .addIncludedContentCategories(ContentCategory.SPORT) .build(); // Create a new media type filter that only includes PHOTO media items MediaTypeFilter mediaTypeFilter = MediaTypeFilter.newBuilder() .addMediaTypes(MediaType.PHOTO) .build(); // Create a new DateFilter that only includes items from 2010 or 2014 Date year2014 = Date.newBuilder().setYear(2014).build(); Date year2010 = Date.newBuilder().setYear(2010).build(); DateFilter dateFilter = DateFilter.newBuilder() .addDates(year2010) .addDates(year2014) .build(); // Create a new Filters object combining these filters Filters filters = Filters.newBuilder() .setDateFilter(dateFilter) .setMediaTypeFilter(mediaTypeFilter) .setContentFilter(contentFilter) .build(); // Specify the Filter object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a new ContentFilter $filtersBuilder = new FiltersBuilder(); // Only include SPORT items $filtersBuilder->addIncludedCategory(ContentCategory::SPORT); // Only include PHOTO media items $filtersBuilder->setMediaType(MediaType::PHOTO); // Only include items from 2010 or 2014 $year2014 = new Date(); $year2014->setYear(2014); $year2010 = new Date(); $year2010->setYear(2010); $filtersBuilder->addDateRange($year2010, $year2014); // Make a search call with the options set in the filters builder // Filters have been combined in the filter builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Mengurutkan hasil
Hanya kueri yang menggunakan filter tanggal yang dapat diurutkan.
Jika Anda tidak menentukan opsi pengurutan, hasil akan diurutkan dalam urutan menurun (terbaru dulu).
Tabel ini menunjukkan opsi yang didukung untuk parameter orderBy
:
Parameter orderBy |
|
---|---|
MediaMetadata.creation_time desc |
Menampilkan item media dalam urutan menurun (item terbaru terlebih dahulu) |
MediaMetadata.creation_time |
Menampilkan item media dalam urutan menaik (item terlama terlebih dahulu) |
Contoh berikut menampilkan semua item media dari tahun 2017 dengan menampilkan yang terlama pertama dan terbaru terakhir.
REST
{ "filters": { "dateFilter": { "dates": [ { "year": 2017 } ] } }, "orderBy": "MediaMetadata.creation_time" }
Java
// Create a new dateFilter for the year 2017. DateFilter dateFilter = DateFilter.newBuilder() .addDates(Date.newBuilder().setYear(2017)) .build(); // Create a new Filters object Filters filters = Filters.newBuilder() .setDateFilter(dateFilter) .build(); // Sort results by oldest item first. final OrderBy newestFirstOrder = OrderBy.MEDIAMETADATA_CREATION_TIME; // Specify the filter and sort order in the searchMediaItems call. SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters, newestFirstOrder);
PHP
// Create a new dateFilter for the year 2017. $filtersBuilder = new FiltersBuilder(); $filtersBuilder->addDate((new Date())->setYear(2017)); // Make a search call with the options set in the filters builder and sort // the results by oldest item first. $response = $photosLibraryClient->searchMediaItems( [ 'filters' => $filtersBuilder->build(), 'orderBy' => OrderBy::MEDIAMETADATA_CREATION_TIME ] );