Répertorier les miniatures d’un objet driveItem
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta
dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Récupérez une collection de ressources thumbnailSet pour une ressource driveItem .
Zéro ou plusieurs ressources thumbnailSet peuvent représenter un objet driveItem.
Chaque élément thumbnailSet peut posséder un ou plusieurs objets thumbnail, qui sont des images représentant l’élément.
Par exemple, un élément thumbnailSet peut également inclure des objets thumbnail, notamment les plus courants, y compris small
, medium
ou large
.
Il existe de nombreuses façons d’utiliser des miniatures sur OneDrive. Voici les plus courantes :
- Énumérer les miniatures disponibles pour un élément
- Récupérer une seule miniature pour un élément
- Extraire le contenu des miniatures
- Récupérer les miniatures de plusieurs éléments dans une seule requête
- Récupérer des tailles de miniatures personnalisées
- Charger la miniature personnalisée d’un élément
- Déterminer s’il existe une miniature chargée personnalisée
Cette API est disponible dans les déploiements de cloud national suivants.
Service global | Gouvernement des États-Unis L4 | Us Government L5 (DOD) | Chine gérée par 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.
Type d’autorisation | Autorisations avec privilèges minimum | Autorisations privilégiées plus élevées |
---|---|---|
Déléguée (compte professionnel ou scolaire) | Files.Read | Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Déléguée (compte Microsoft personnel) | Files.Read | Files.Read.All, Files.ReadWrite, Files.ReadWrite.All |
Application | Files.Read.All | Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Requête 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
Paramètres facultatifs de la requête
Cette méthode prend en charge le $select
paramètre de requête OData pour personnaliser la réponse.
En outre, cette méthode prend en charge la récupération de la miniature avec la valeur EXIF d’orientation d’origine et sans la rotation appliquée en ajoutant le paramètre de originalOrientation=true
requête.
Il est actuellement pris en charge uniquement sur OneDrive Personnel.
Réponse
En cas de réussite, cette méthode renvoie un code de réponse 200 OK
et une collection d’objets ThumbnailSet dans le corps de la réponse.
Exemple
L’exemple suivant montre une requête qui récupère les miniatures disponibles pour un élément dans le OneDrive de l’utilisateur actuel.
GET /me/drive/items/{item-id}/thumbnails
Elle retourne un tableau de thumbnailSets disponibles pour l’élément. Tous les éléments d’un lecteur peuvent avoir zéro, une ou plusieurs miniature(s).
Remarque : vous pouvez utiliser le paramètre de chaîne de requête select pour contrôler la taille des miniatures renvoyées dans l’objet ThumbnailSet.
Par exemple, /thumbnails?select=medium
récupère uniquement les miniatures de taille moyenne.
Réponse
L’exemple suivant illustre la réponse.
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..."}
}
]
}
Récupérer une seule miniature
Vous pouvez récupérer les métadonnées d’une seule miniature et la taille en envoyant une demande.
Requête HTTP
GET /me/drive/items/{item-id}/thumbnails/{thumb-id}/{size}
Paramètres du chemin d’accès
Nom | Type | Description |
---|---|---|
item-id | chaîne | Identificateur unique de l’élément référencé. |
thumb-id | number | Index de la miniature, généralement 0-4. S’il existe une miniature personnalisée, son index est 0. |
size | chaîne | Taille de la miniature demandée. Il peut s’agir de l’une des tailles standard répertoriées ci-dessous ou d’une taille personnalisée. |
HTTP/1.1 200 OK
Content-Type: application/json
{
"width": 100,
"height": 100,
"url": "https://onedrive.com/asd123a/asdjlkasjdkasdjlk.jpg"
}
Récupérer le contenu binaire d’une miniature
Vous pouvez récupérer directement le contenu de la miniature en demandant la propriété content de la miniature.
Requête HTTP
GET /me/drive/items/{item-id}/thumbnails/{thumb-id}/{size}/content
Réponse
Le service répond avec une redirection vers l’URL de la miniature.
HTTP/1.1 302 Found
Location: https://b0mpua-by3301.files.1drv.com/y23vmagahszhxzlcvhasdhasghasodfi
Les URL des miniatures sont des URL de cache sécurisées. L’URL change si l’élément change d’une manière qui nécessite la génération d’une nouvelle miniature.
Obtention de miniatures lors de la liste des driveItems
Si vous récupérez une liste de ressources driveItem à afficher, vous pouvez utiliser le paramètre de chaîne de requête $expand pour inclure également les miniatures de ces ressources. Il permet à votre application de récupérer des miniatures et des éléments dans une seule requête, au lieu d’émettre de nombreuses demandes.
Requête HTTP
GET /me/drive/items/{item-id}/children?$expand=thumbnails
Réponse
Voici les réponses du service avec la liste des ressources DriveItem et leurs miniatures.
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..."
}
}
]
}
]
}
Valeurs de taille
Ce tableau définit les tailles de miniatures possibles. Bien que vous puissiez demander une taille de miniature arbitraire, les valeurs définies sont plus susceptibles d’exister réellement de renvoyer rapidement une valeur :
Nom | Solution | Proportions | Description |
---|---|---|---|
small |
96 plus long | Original | Miniature de petite taille, fortement compressée, rognée à des proportions carrées. |
medium |
176 plus long | Original | Rognée à la taille d’élément standard pour l’affichage web OneDrive. |
large |
800 plus long | Original | Miniature dont le bord le plus long est redimensionné à 800 pixels. |
smallSquare |
96x96 | Rognage carré | Petite miniature carrée |
mediumSquare |
176x176 | Rognage carré | Petite miniature carrée |
largeSquare |
800x800 | Rognage carré | Grande miniature carrée |
Demande des tailles de miniatures personnalisées
En plus des tailles définies, votre application peut demander une taille de miniature personnalisée en spécifiant ses dimensions, précédées de c
.
Par exemple, si votre application a besoin de miniatures au format 300 x 400, vous pouvez demander cette taille de la manière suivante :
GET /me/drive/items/{item-id}/thumbnails?select=c300x400_crop
Qui répond avec la taille de miniature personnalisée sélectionnée :
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"id": "0",
"c300x400_crop": { "height": 300, "width": 400, "url": "https://sn3302files.onedrive.com/123"},
}
]
}
Vous pouvez spécifier les options suivantes après la taille de miniature demandée :
Exemples d’identificateurs personnalisés
Identificateur de miniature | Résolution | Proportions | Description |
---|---|---|---|
c300x400 | Délimité par une zone de 300 x 400 | Original | Générer une miniature qui s’adapte à l’intérieur d’une zone de 300 x 400 pixels, en conservant les proportions |
c300x400_crop | 300x400 | Rognée | Générer une miniature de 300 x 400 pixels. Il fonctionne en redimensionnant l’image pour remplir la boîte de 300 x 400 et en rognant tout ce qui se déverse à l’extérieur de la boîte. |
Note: La miniature retournée peut ne pas correspondre exactement aux dimensions de pixel qui ont été demandées, mais elle correspond aux proportions. Dans certains cas, une plus grande miniature peut être renvoyée si la miniature existe déjà et peut être facilement adaptée pour obtenir la résolution demandée.
Remarques
Remarque : dans OneDrive Entreprise et SharePoint :
L’utilisation de ces appels pour développer la collection miniatures ne fonctionne pas :
GET /drive/root:/{item-path}?expand=children(expand=thumbnails)
GET /drive/items/{item-id}/children?expand=thumbnails
Les miniatures ne sont pas prises en charge sur SharePoint Server 2016.
Réponses d’erreur
Pour plus d’informations sur la façon dont les erreurs sont retournées, consultez Réponses d’erreur.