Enumeración de miniaturas para un driveItem
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta
de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Recupere una colección de recursos thumbnailSet para un recurso driveItem .
Cero o más recursos thumbnailSet pueden representar un driveItem.
Cada thumbnailSet puede tener uno o varios objetos en miniatura, que son imágenes que representan el elemento.
Por ejemplo, un thumbnailSet puede incluir objetos en miniatura, los más comunes son small
, medium
o large
.
Hay muchas maneras de trabajar con miniaturas en OneDrive. Aquí tiene las más comunes:
- Enumerar las miniaturas disponibles para un elemento
- Recuperar una sola miniatura para un elemento
- Recuperar el contenido de miniaturas
- Recuperar miniaturas para varios elementos en una sola solicitud
- Recuperar los tamaños personalizados de miniaturas
- Cargar una miniatura personalizada para un elemento
- Determinar si existe una miniatura cargada personalizada
Esta API está disponible en las siguientes implementaciones nacionales de nube.
Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
Tipo de permiso | Permisos con privilegios mínimos | Permisos con privilegios más altos |
---|---|---|
Delegado (cuenta profesional o educativa) | Files.Read | Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Delegado (cuenta personal de Microsoft) | Files.Read | Files.Read.All, Files.ReadWrite, Files.ReadWrite.All |
Aplicación | Files.Read.All | Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Solicitud HTTP
GET /drives/{drive-id}/items/{item-id}/thumbnails
GET /groups/{group-id}/drive/items/{item-id}/thumbnails
GET /me/drive/items/{item-id}/thumbnails
GET /sites/{site-id}/drive/items/{item-id}/thumbnails
GET /users/{user-id}/drive/items/{item-id}/thumbnails
Parámetros de consulta opcionales
Este método admite el $select
parámetro de consulta OData para personalizar la respuesta.
Además, este método admite la recuperación de la miniatura con el valor EXIF de orientación original y sin la rotación aplicada anexando el parámetro de originalOrientation=true
consulta.
Actualmente solo se admite en OneDrive Personal.
Respuesta
Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK
y la colección de objetos ThumbnailSet en el cuerpo de la respuesta.
Ejemplo
En el ejemplo siguiente se muestra una solicitud que recupera las miniaturas disponibles para un elemento de OneDrive del usuario actual.
GET /me/drive/items/{item-id}/thumbnails
Devuelve una matriz de thumbnailSets disponibles para el elemento. Cualquier elemento de una unidad puede tener cero o más miniaturas.
Nota: Puede usar el parámetro de cadena de consulta select para controlar qué tamaños de miniatura se devuelven en ThumbnailSet.
Por ejemplo, /thumbnails?select=medium
recupera solo las miniaturas medianas.
Respuesta
En el ejemplo siguiente se muestra la respuesta.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "0",
"small": { "height": 64, "width": 96, "url": "https://sn3302files..."},
"medium": { "height": 117, "width": 176, "url": "https://sn3302files..."},
"large": { "height": 533, "width": 800, "url": "https://sn3302files..."}
}
]
}
Obtener una única miniatura
Recupere los metadatos de una sola miniatura y un tamaño solicitándolo directamente en una solicitud.
Solicitud HTTP
GET /me/drive/items/{item-id}/thumbnails/{thumb-id}/{size}
Parámetros de ruta de acceso
Nombre | Tipo | Descripción |
---|---|---|
item-id | string | El identificador único para el elemento al que se hace referencia. |
thumb-id | número | El índice de la miniatura, normalmente de 0 a 4. Si hay una miniatura personalizada, su índice es 0. |
size | cadena | El tamaño de la miniatura solicitada. Puede ser uno de los tamaños estándar que se enumeran a continuación o un tamaño personalizado. |
HTTP/1.1 200 OK
Content-Type: application/json
{
"width": 100,
"height": 100,
"url": "https://onedrive.com/asd123a/asdjlkasjdkasdjlk.jpg"
}
Recuperar el contenido binario de miniaturas
Puede recuperar directamente el contenido de la miniatura solicitando la propiedad content de la miniatura.
Solicitud HTTP
GET /me/drive/items/{item-id}/thumbnails/{thumb-id}/{size}/content
Respuesta
El servicio responde con un redireccionamiento a la dirección URL de la miniatura.
HTTP/1.1 302 Found
Location: https://b0mpua-by3301.files.1drv.com/y23vmagahszhxzlcvhasdhasghasodfi
Las direcciones URL de la miniatura son seguras en caché. La dirección URL cambia, si el elemento cambia de una manera que requiere que se genere una nueva miniatura.
Obtención de miniaturas al enumerar driveItems
Si va a recuperar una lista de recursos driveItem que se van a mostrar, puede usar el parámetro de cadena de consulta $expand para incluir también las miniaturas de esos recursos. Permite que la aplicación recupere miniaturas y elementos en una sola solicitud, en lugar de emitir muchas solicitudes.
Solicitud HTTP
GET /me/drive/items/{item-id}/children?$expand=thumbnails
Respuesta
Las respuestas del servicio con la lista de recursos DriveItem y sus miniaturas.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "182331E8-2788-4932-B52A-A6550577043F",
"name": "my photo.jpg",
"thumbnails": [
{
"small": { "width": 96,
"height": 96,
"url": "https://sn3302files..."
}
}
]
},
{
"id": "2D223953-A56B-4D9B-ADF3-13E7820673A2",
"name": "presentation.pptx",
"thumbnails": [
{
"small": { "width": 96,
"height": 96,
"url": "https://sn3302files..."
}
}
]
}
]
}
Valores de tamaño
Esta tabla define los tamaños posibles de las miniaturas. Puede solicitar cualquier tamaño de miniatura arbitrario, pero es probable que existan valores definidos y que se devuelva un valor rápidamente:
Nombre | Resolución | Relación de aspecto | Descripción |
---|---|---|---|
small |
borde más largo 96 | Original | Miniatura pequeña y muy comprimida recortada en una relación de aspecto cuadrada. |
medium |
borde más largo 176 | Original | Miniatura recortada al tamaño estándar del elemento para la vista web de OneDrive. |
large |
borde más largo 800 | Original | Miniatura con el borde más largo cambiado a un tamaño de 800 píxeles. |
smallSquare |
96x96 | Recorte cuadrado | Miniatura de cuadrado pequeño |
mediumSquare |
176x176 | Recorte cuadrado | Miniatura de cuadrado pequeño |
largeSquare |
800x800 | Recorte cuadrado | Miniatura de cuadrado grande |
Solicitar tamaños personalizados de miniaturas
Además de los tamaños definidos, la aplicación puede solicitar un tamaño de miniatura personalizado especificando las dimensiones de la miniatura prefijada con c
.
Por ejemplo, si su aplicación necesita miniaturas de tamaño 300x400, puede solicitar ese tamaño de esta forma:
GET /me/drive/items/{item-id}/thumbnails?select=c300x400_crop
Que responde solo con el tamaño de miniatura personalizado seleccionado:
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"id": "0",
"c300x400_crop": { "height": 300, "width": 400, "url": "https://sn3302files.onedrive.com/123"},
}
]
}
Puede especificar las siguientes opciones después del tamaño de la miniatura solicitado:
Ejemplos de identificadores personalizados
Identificador de miniatura | Resolución | Relación de aspecto | Descripción |
---|---|---|---|
c300x400 | Limitado por un cuadro de 300x400 | Original | Genera una miniatura que se adapta dentro de un cuadro de 300x400 píxeles, manteniendo la relación de aspecto |
c300x400_crop | 300x400 | Recortado | Genera una miniatura que tiene 300x400 píxeles. Funciona al cambiar el tamaño de la imagen para rellenar la caja de 300x400 y recortar lo que se derrame fuera de la caja. |
Nota: Es posible que la miniatura devuelta no coincida exactamente con las dimensiones de píxel solicitadas, pero sí con la relación de aspecto. En algunos casos, puede devolverse una miniatura más grande que la que se ha solicitado si la miniatura ya existe y se puede escalar fácilmente para ajustarse a la resolución solicitada.
Comentarios
Nota En OneDrive para la Empresa y en SharePoint:
El uso de estas llamadas para expandir la colección de miniaturas no funciona:
GET /drive/root:/{item-path}?expand=children(expand=thumbnails)
GET /drive/items/{item-id}/children?expand=thumbnails
Las miniaturas no se admiten en SharePoint Server 2016.
Respuestas de error
Consulte Respuestas de errores para obtener más información sobre cómo se devuelven los errores.