Champs d'application d'autorisation requis
Le champ d'application photoslibrary.readonly
permet d'accéder à tous les éléments multimédias de la bibliothèque de l'utilisateur.
La recherche et l'application de filtres au contenu créé par l'application nécessitent le champ d'application photoslibrary.readonly.appcreateddata
. Pour en savoir plus sur les champs d'application, consultez la section Champs d'application d'autorisation.
Filtres disponibles
Vous pouvez rechercher des types de contenus multimédias spécifiques dans la bibliothèque d'éléments multimédias créés par l'application d'un utilisateur. Par exemple, vous ne souhaitez peut-être afficher que des photos d'animaux, d'un certain jour ou d'autres photos que vous n'avez pas besoin de voir. Vous pouvez exclure ou inclure des éléments spécifiques en appliquant des filtres à une liste d'album ou de bibliothèque. Cinq filtres sont disponibles en fonction des propriétés des éléments multimédias :
- Catégories de contenu (
includedContentCategories
,excludedContentCategories
) - Dates et plages de dates (
dates
,ranges
) - Fonctionnalités (
featureFilter
) - Types de contenu (
mediaTypeFilter
) - État archivé (
includeArchivedMedia
)
Les filtres ne doivent pas être utilisés dans une requête mediaItems.search
si albumId
est défini. Si un filtre est utilisé lorsque l'albumId est défini, une erreur INVALID_ARGUMENT
(400) est renvoyée.
Les résultats sont triés en fonction de l'heure de création de l'élément multimédia. L'ordre de tri peut être modifié pour les requêtes utilisant des filtres de date.
Patientez un certain temps pour que les contenus multimédias nouvellement importés apparaissent dans vos recherches. Le contenu multimédia apparaît immédiatement dans les recherches non filtrées.
Les éléments multimédias associés à une date située dans le futur n'apparaissent pas dans les recherches filtrées. Ils apparaissent dans les recherches non filtrées et les recherches d'albums.
Appliquer un filtre
Pour appliquer un filtre, appelez mediaItems.search
et spécifiez la propriété filter
.
REST
Voici une requête POST :
POST https://photoslibrary.googleapis.com/v1/mediaItems:search Content-type: application/json Authorization: Bearer oauth2-token { "pageSize": "100", "filters": { ... } }
La requête POST renvoie la réponse suivante :
{ "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 }
Pour en savoir plus, consultez Lister le contenu, les albums et les éléments multimédias d'une bibliothèque.
Catégories de contenu
Tous les éléments multimédias sont traités et des libellés sont attribués. Vous pouvez inclure et exclure l'une des catégories suivantes.
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 |
Les photos d'utilité couvrent un large éventail de supports. Cette catégorie inclut généralement les éléments que l'utilisateur a capturés pour effectuer une tâche et qu'il est peu probable qu'il souhaite conserver une fois la tâche terminée. Cela inclut les documents, les reçus, les captures d'écran, les notes adhésives, les menus et d'autres éléments multimédias similaires.
Les catégories ne sont précises que si les libellés équivalents dans Google Photos le sont. Il est possible que des éléments soient mal catégorisés. Nous ne garantissons donc pas l'exactitude des filtres de catégorie de contenu.
y compris les catégories
Lorsque vous incluez plusieurs catégories, les éléments multimédias correspondant à l'une d'entre elles sont inclus. Vous pouvez inclure 10 catégories maximum par requête.
Cet exemple de filtre renvoie tous les éléments de LANDSCAPES
ou 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()] );
Exclure des catégories
Seuls les éléments multimédias qui ne correspondent à aucune des catégories exclues sont affichés. Comme pour les catégories incluses, vous pouvez exclure un maximum de 10 catégories par demande.
Ce filtre renvoie tous les éléments qui ne sont pas PEOPLE
ou 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()] );
Inclure et exclure plusieurs catégories
Vous pouvez inclure certaines catégories et en exclure d'autres. L'exemple suivant renvoie LANDSCAPES
et LANDMARKS
, mais supprime tous les éléments multimédias contenant PEOPLE
ou qui sont 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()] );
Dates et plages de dates
Les filtres de date limitent la date des résultats renvoyés à un ensemble de jours spécifié. Il existe deux façons de spécifier un filtre de date: les dates ou les plages. Les dates et les plages peuvent être utilisées ensemble. Les éléments multimédias correspondant à l'une des dates ou des plages de dates sont renvoyés. Vous pouvez éventuellement modifier l'ordre de tri des résultats.
Dates
Une date contient une année, un mois et un jour. Les formats suivants sont acceptés :
- Année
- Année, mois
- Année, mois, jour
- Mois, jour
- Mois
Lorsqu'un composant de la date est vide ou défini sur zéro, il est traité comme une valeur générique. Par exemple, si vous définissez le jour et le mois, mais pas l'année, vous demandez des éléments pour ce jour et ce mois de n'importe quelle année:
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()] );
Périodes
Les plages de dates offrent plus de flexibilité que les dates. Par exemple, plutôt que d'ajouter plusieurs dates, vous pouvez utiliser une plage de dates pour afficher un ensemble de jours dans un mois.
Une plage de dates comporte un champ startDate
et un champ endDate
, qui doivent tous deux être définis. Chaque date de la plage présente les mêmes contraintes de format que celles décrites dans la section Dates. Les dates doivent être au même format : si la date de début est un an et un mois, la date de fin doit également être un an et un mois. Les plages sont appliquées de manière inclusive. Les dates de début et de fin sont incluses dans le filtre appliqué :
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()] );
Combiner des dates et des plages de dates
Vous pouvez utiliser plusieurs dates et plages de dates simultanément. Les articles correspondant à l'une de ces dates sont inclus dans les résultats. Les dates et les plages de dates séparées n'ont pas besoin de suivre le même format, mais les dates de début et de fin des plages individuelles doivent l'être :
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()] );
Fonctionnalités de l'élément multimédia
Les filtres de fonctionnalités limitent les résultats aux éléments ayant des caractéristiques spécifiques, par exemple ceux qui ont été marqués comme favoris dans l'application Google Photos.
Favoris
Incluez la fonctionnalité d'élément FAVORITES
dans FeatureFilter
pour ne renvoyer que les éléments multimédias marqués comme favoris par l'utilisateur :
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()] );
Types de contenu
Vous pouvez limiter les résultats au type de contenu multimédia : photo ou vidéo.
Photo
Un PHOTO
peut être l'un des formats d'image suivants :
BMP | JPG |
GIF | PNG |
HEIC | TIFF |
ICO | WEBP |
Il inclut également des types de photos spéciaux, comme les photos en direct iOS, les photos animées, les panoramas, les photo-sphères et les photos en réalité virtuelle.
Vidéo
Un VIDEO
peut être de différents formats vidéo:
3GP | MMV |
3G2 | MOD |
ASF | MOV |
AVI | MP4 |
DIVX | L/100 km |
M2T | MTS |
M2TS | TOD |
M4V | WMV |
MKV |
VIDEO
inclut également des formats vidéo spéciaux, tels que les vidéos de RV, les vidéos au ralenti et les animations créées dans l'application Google Photos.
L'exemple suivant filtre par 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()] );
Vous ne pouvez pas combiner plusieurs filtres de types multimédias.
État archivé
Vos utilisateurs ont peut-être archivé certaines de leurs photos. Par défaut, les photos archivées ne s'affichent pas dans les recherches. Pour inclure des éléments archivés, vous pouvez définir un indicateur dans le filtre, comme illustré dans l'exemple suivant:
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()] );
Combiner des filtres
Vous pouvez combiner différents types de filtres. Seuls les éléments qui correspondent à toutes les caractéristiques demandées sont renvoyés.
Lorsque vous combinez des filtres, les restrictions de mise en forme pour chaque type de filtre sont les mêmes que lorsqu'ils sont utilisés individuellement. Dans l'exemple suivant, seules les photos appartenant à la catégorie SPORT
et provenant de 2014 ou de 2010 sont renvoyées:
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()] );
Tri des résultats
Seules les requêtes utilisant des filtres de date peuvent être triées.
Si vous ne spécifiez pas d'option de tri, vos résultats seront triés par ordre décroissant (les plus récents en premier).
Le tableau suivant présente les options acceptées pour le paramètre orderBy
:
Paramètre orderBy |
|
---|---|
MediaMetadata.creation_time desc |
Affiche les éléments multimédias par ordre décroissant (les plus récents en premier). |
MediaMetadata.creation_time |
Affiche les éléments multimédias dans l'ordre croissant (les éléments les plus anciens en premier). |
L'exemple suivant renvoie tous les éléments multimédias de 2017, en affichant les plus anciens en premier et les plus récents en dernier.
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 ] );