Permisos de autorización obligatorios
La API de la Biblioteca de Google Fotos contiene varios permisos que se usan para acceder a elementos multimedia y álbumes. Los elementos multimedia que se muestran de varias llamadas difieren según los alcances que el desarrollador haya solicitado.
El permiso photoslibrary.readonly
permite acceder a todos los elementos multimedia del
biblioteca del usuario. El permiso photoslibrary.readonly.appcreateddata
permite el acceso
solo a elementos multimedia creados por la app. Para obtener más información, consulta
Permisos de autorización.
Filtros disponibles
Puedes buscar tipos específicos de contenido multimedia en la biblioteca de un usuario. Por ejemplo, puede que solo quieras elementos que son de animales de un día determinado, o quizás desees para excluir fotos de recibos. Para excluir o incluir elementos específicos, puedes hacer lo siguiente: aplicar filtros a una ficha de álbum o biblioteca. Hay cinco disponibles Filtros basados en las propiedades de los elementos multimedia:
- Categorías de contenido (
includedContentCategories
,excludedContentCategories
) - Períodos y fechas (
dates
,ranges
) - Funciones (
featureFilter
) - Media types (
mediaTypeFilter
) - Estado de archivo (
includeArchivedMedia
)
No se deben usar filtros en una solicitud mediaItems:search
si el albumId
es
automático. Si se usa un filtro cuando se establece el ID del álbum, se mostrará un error INVALID_ARGUMENT
.
(400).
Los resultados se ordenan según la hora de creación del elemento multimedia. El se puede modificar el orden de clasificación para las consultas con filtros de fecha.
Espera un tiempo para que los medios subidos recientemente aparezcan en tus búsquedas. Los medios de comunicación aparece de inmediato en las búsquedas sin filtros.
Los elementos multimedia que tienen una fecha futura no aparecen en las búsquedas filtradas. Aparecen en búsquedas sin filtro y en búsquedas de álbumes.
Aplicar un filtro
Para aplicar un filtro, llama a
mediaItems.search
y
especifica la propiedad filter
.
REST
Esta es una solicitud POST:
POST https://photoslibrary.googleapis.com/v1/mediaItems:search Content-type: application/json Authorization: Bearer oauth2-token { "pageSize": "100", "filters": { ... } }
La solicitud POST muestra la siguiente respuesta:
{ "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 }
Para obtener más información, consulta Muestra una lista del contenido de la biblioteca, los álbumes y los elementos multimedia.
Categorías de contenido
Todos los elementos multimedia se procesan y se asignan etiquetas. Puedes incluir y excluir cualquiera de las siguientes categorías.
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 |
Las fotos de utilidad abarcan una amplia variedad de contenido multimedia. Por lo general, esta categoría incluye elementos que el usuario capturó para realizar alguna tarea y que es poco probable que quiera después se haya completado la tarea. Incluye documentos, recibos, capturas de pantalla, notas notas, menús y otros elementos multimedia similares.
Las categorías son precisas solo como las etiquetas equivalentes de Google Fotos. En ocasiones, es posible que los artículos estén mal etiquetados, por lo que no garantizamos la precisión de los filtros de categoría de contenido.
Se incluyen las categorías
Cuando incluyes varias categorías, los elementos multimedia que coinciden con cualquiera de
categorías. Se puede incluir un máximo de 10 categorías por solicitud.
Este filtro de ejemplo muestra todos los elementos de LANDSCAPES
o 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()] );
Exclusión de categorías
Solo se muestran los elementos multimedia que no coinciden con ninguna de las categorías excluidas. Al igual que con las categorías incluidas, se puede excluir un máximo de 10 categorías. por solicitud.
Este filtro muestra los elementos que no son PEOPLE
ni 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()] );
Cómo incluir y excluir varias categorías
Puede incluir algunas categorías y excluir otras. El siguiente ejemplo
muestra LANDSCAPES
y LANDMARKS
, pero quita cualquier elemento multimedia que contenga
PEOPLE
o 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()] );
Fechas e períodos
Los filtros de fecha restringen la fecha de los resultados devueltos a un conjunto específico de días. Existen dos maneras de especificar un filtro de fechas: fechas o períodos. Fechas y rangos se pueden usar juntos. Elementos multimedia que coinciden con cualquiera de las fechas los rangos de destino. Opcionalmente, el orden de resultados de los resultados se pueden modificar.
Fechas
Una fecha contiene un año, un mes y un día. Se aceptan los siguientes formatos:
- Año
- Año, mes
- Año, mes, día
- Día, mes
- Mes
Cuando un componente de la fecha está vacío o establecido en cero, se trata como un . Por ejemplo, si configuras el día y el mes, pero no el año, solicitar artículos de ese día y mes de cualquier año:
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()] );
Intervalos de fechas
Los períodos ofrecen más flexibilidad que las fechas. Por ejemplo, en lugar de agregar varias fechas, se puede utilizar un período para ver una serie de días dentro de un mes.
Un período tiene un startDate
y un endDate
, que se deben configurar. Cada
la fecha en el rango tiene las mismas restricciones de formato que se describen en
Fechas: Las fechas deben tener el mismo formato: si la fecha de inicio es un
año y mes, la fecha de finalización también debe ser un año y un mes. Los rangos son
Si se aplican todas las políticas, las fechas de inicio y finalización también se incluyen en el filtro aplicado:
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()] );
Cómo combinar fechas y períodos
Puedes utilizar varias fechas y varios períodos al mismo tiempo. Elementos que que pertenezcan a alguna de estas fechas se incluyen en los resultados. Separa las fechas y no es necesario que sigan el mismo formato, pero las fechas de inicio y de finalización de los rangos individuales hacen lo siguiente:
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()] );
Funciones del elemento multimedia
Los filtros de funciones restringen los resultados a elementos que tienen funciones específicas, por ejemplo que se marcaron como favoritos en la aplicación Google Fotos.
Favoritos
Incluye el
FAVORITES
elemento
en la
FeatureFilter
para mostrar solo elementos multimedia que el usuario marcó como favoritos:
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()] );
Tipos de medios
Puedes limitar los resultados al tipo de contenido multimedia: foto o video.
Foto
Un PHOTO
puede ser cualquiera de varios formatos de imagen:
BMP | JPG |
GIF | PNG |
HEIC | TIFF |
ICO | WEBP |
También incluye tipos de fotos especiales, como fotos en vivo o en movimiento de iOS, panorámicas, fotos esféricas y en RV.
Video
Un VIDEO
puede tener varios formatos de video:
3GP | MMV |
3G2 | MOD |
ASF | MOV |
AVI | MP4 |
DIVX | MPG |
M2T | MTS |
M2TS | TOD |
M4V | WMV |
MKV |
VIDEO
también incluye formatos de video especiales, como los siguientes: videos de RV,
videos en cámara lenta y animaciones creadas en Google Fotos
y mantener la integridad de su aplicación.
En el siguiente ejemplo, se filtra por 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()] );
No se pueden combinar varios filtros de tipos de medios.
Excluir los datos no creados por la app
Para excluir los elementos multimedia que tu app no creó, puedes establecer
el filtro excludeNonAppCreatedData
, como se muestra en el siguiente ejemplo:
REST
{ "filters": { "excludeNonAppCreatedData": true } }
Java
// Create a new Filters object that excludes media not created by your app Filters filters = Filters.newBuilder() .setExcludeNonAppCreatedData(true) .build(); // Specify the Filters object in the searchMediaItems call SearchMediaItemsPagedResponse response = photosLibraryClient.searchMediaItems(filters);
PHP
// Create a new Filters object that excludes media not created by your app $filtersBuilder = new FiltersBuilder(); $filtersBuilder->setExcludeNonAppCreatedData(true); // Make a search call with the options set in the filters builder $response = $photosLibraryClient->searchMediaItems( ['filters' => $filtersBuilder->build()] );
Ten en cuenta que si utilizas el
.readonly.appcreateddata
permiso, se ignora este filtro.
Estado de archivo
Es posible que sus usuarios hayan archivado algunas de sus fotos. De forma predeterminada, las fotos archivadas no se devuelven en las búsquedas. Para incluir elementos archivados, puedes establecer una marca en el filtro, como se muestra en el siguiente ejemplo:
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()] );
Filtros combinados
Se pueden combinar diferentes tipos de filtros. Solo los elementos que coincidan con las funciones solicitadas.
Cuando se combinan filtros, las restricciones de formato de cada tipo de filtro son
que cuando se usan individualmente. En el siguiente ejemplo, solo las fotos
que se hayan categorizado como SPORT
y que sean de 2014 o 2010 se
devuelto:
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()] );
Ordenar resultados
Solo se pueden ordenar las consultas que usan filtros de fecha.
Si no especificas una opción de orden, los resultados se ordenarán de orden descendente (más recientes primero).
En esta tabla, se muestran las opciones compatibles para el parámetro orderBy
:
Parámetro orderBy |
|
---|---|
MediaMetadata.creation_time desc |
Devuelve los elementos multimedia en orden descendente (los elementos más recientes primero). |
MediaMetadata.creation_time |
Devuelve los elementos multimedia en orden ascendente (los elementos más antiguos primero) |
En el siguiente ejemplo, se muestran todos los elementos multimedia de 2017 y se muestran los más antiguos y lo más reciente al final.
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 ] );