Dresser une liste des miniatures d’un objet « DriveItem »

Article
10/02/2023

Espace de noms: microsoft.graph

Récupérez une collection de ressources ThumbnailSet pour une ressource DriveItem.

Un objet « DriveItem » peut être représenté par au moins une ressource ThumbnailSet. 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 plusieurs manières de travailler avec 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 $selectparamè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. Ceci est pris en charge actuellement sur OneDrive Personnel uniquement.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].Thumbnails.GetAsync();



mgc drives items thumbnails list --drive-id {drive-id} --drive-item-id {driveItem-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
thumbnails, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Thumbnails().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ThumbnailSetCollectionResponse result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").thumbnails().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let thumbnails = await client.api('/me/drive/items/{item-id}/thumbnails')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->thumbnails()->get()->wait();


Import-Module Microsoft.Graph.Files

Get-MgDriveItemThumbnail -DriveId $driveId -DriveItemId $driveItemId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').thumbnails.get()

Renvoie un tableau des objets ThumbnailSet disponibles pour l’élément. Tous les éléments d’un lecteur peuvent avoir zéro, une ou plusieurs miniatures.

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

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}

Snippet not available

Snippet not available

Snippet not available

Snippet not available


const options = {
	authProvider,
};

const client = Client.init(options);

let response = await client.api('/me/drive/items/{item-id}/thumbnails/{thumb-id}/{size}')
	.get();

Snippet not available

Snippet not available

Snippet not available

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 affiché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

Snippet not available

Snippet not available

Snippet not available

Snippet not available


const options = {
	authProvider,
};

const client = Client.init(options);

let content = await client.api('/me/drive/items/{item-id}/thumbnails/{thumb-id}/{size}/content')
	.get();

Snippet not available

Snippet not available

Snippet not available

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 est modifié d’une manière qui nécessite la génération d’une nouvelle miniature.

Obtention de miniatures pendant l’énumération des ressources 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 également inclure les miniatures de ces ressources. Ainsi, votre application peut récupérer les miniatures et les éléments en une seule requête, au lieu d’en émettre plusieurs.

Requête HTTP

GET /me/drive/items/{item-id}/children?$expand=thumbnails


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].Children.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Expand = new string []{ "thumbnails" };
});



mgc drives items children list --drive-id {drive-id} --drive-item-id {driveItem-id} --expand "thumbnails"



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdrives "github.com/microsoftgraph/msgraph-sdk-go/drives"
	  //other-imports
)

requestParameters := &graphdrives.DriveItemItemItemChildrenRequestBuilderGetQueryParameters{
	Expand: [] string {"thumbnails"},
}
configuration := &graphdrives.DriveItemItemItemChildrenRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
children, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Children().Get(context.Background(), configuration)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DriveItemCollectionResponse result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").children().get(requestConfiguration -> {
	requestConfiguration.queryParameters.expand = new String []{"thumbnails"};
});


const options = {
	authProvider,
};

const client = Client.init(options);

let children = await client.api('/me/drive/items/{item-id}/children')
	.expand('thumbnails')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Drives\Item\Items\Item\Children\ChildrenRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new ChildrenRequestBuilderGetRequestConfiguration();
$queryParameters = ChildrenRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->expand = ["thumbnails"];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->children()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Files

Get-MgDriveItemChild -DriveId $driveId -DriveItemId $driveItemId -ExpandProperty "thumbnails"


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.drives.item.items.item.children.children_request_builder import ChildrenRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = ChildrenRequestBuilder.ChildrenRequestBuilderGetQueryParameters(
		expand = ["thumbnails"],
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').children.get(request_configuration = request_configuration)

Réponse

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..."
                   }
        }
      ]
    }
  ]
}

Options 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


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].Thumbnails.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "c300x400_crop" };
});



mgc drives items thumbnails list --drive-id {drive-id} --drive-item-id {driveItem-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdrives "github.com/microsoftgraph/msgraph-sdk-go/drives"
	  //other-imports
)

requestParameters := &graphdrives.DriveItemItemItemThumbnailsRequestBuilderGetQueryParameters{
	Select: [] string {"c300x400_crop"},
}
configuration := &graphdrives.DriveItemItemItemThumbnailsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
thumbnails, err := graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Thumbnails().Get(context.Background(), configuration)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ThumbnailSetCollectionResponse result = graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").thumbnails().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"c300x400_crop"};
});


const options = {
	authProvider,
};

const client = Client.init(options);

let thumbnails = await client.api('/me/drive/items/{item-id}/thumbnails?select=c300x400_crop')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Drives\Item\Items\Item\Thumbnails\ThumbnailsRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new ThumbnailsRequestBuilderGetRequestConfiguration();
$queryParameters = ThumbnailsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["c300x400_crop"];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->thumbnails()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Files

Get-MgDriveItemThumbnail -DriveId $driveId -DriveItemId $driveItemId -Property "c300x400_crop"


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.drives.item.items.item.thumbnails.thumbnails_request_builder import ThumbnailsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = ThumbnailsRequestBuilder.ThumbnailsRequestBuilderGetQueryParameters(
		select = ["c300x400_crop"],
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').thumbnails.get(request_configuration = request_configuration)

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. Redimensionne l’image pour remplir la zone de 300 x 400 et rogne tout ce qui dépasse de la zone.

Remarque : la miniature renvoyée peut avoir une résolution différente de celle demandée, tout en respectant les 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 des appels suivants pour développer la collection de miniatures ne fonctionnera 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 dans SharePoint Server 2016.

Réponses d’erreur

Pour plus d’informations sur la façon dont les erreurs sont renvoyées, voir Réponses d’erreur.

Partager via

Dresser une liste des miniatures d’un objet « DriveItem »

Autorisations

Requête HTTP

Paramètres facultatifs de la requête

En-têtes de demande

Réponse

Exemple

Réponse

Récupérer une seule miniature

Requête HTTP

Paramètres du chemin d’accès

Récupérer le contenu binaire d’une miniature

Requête HTTP

Réponse

Obtention de miniatures pendant l’énumération des ressources DriveItems

Requête HTTP

Réponse

Options de taille

Demande des tailles de miniatures personnalisées

Exemples d’identificateurs personnalisés

Remarques

Réponses d’erreur

Commentaires

Ressources supplémentaires