driveItem : aperçu

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 .

Cette action vous permet d’obtenir des URL intégrables de courte durée pour un élément afin de restituer un aperçu temporaire.

Si vous souhaitez obtenir des liens intégrables de longue durée, utilisez plutôt l’API createLink .

Remarque

L’action d’aperçu est actuellement disponible uniquement sur SharePoint et OneDrive Entreprise.

Attention

L’URL d’aperçu est destinée à l’usage personnel de l’appelant et ne doit pas être partagée avec d’autres utilisateurs. L’aperçu s’affiche au nom de l’identité d’appel, et toute personne qui accède à l’URL agit en tant qu’appelant avec les autorisations de l’appelant. Cela est particulièrement important dans les scénarios d’autorisation d’application où votre application a read-write accès au fichier, mais vous avez l’intention de fournir un accès aux utilisateurs read-only finaux. Dans de tels cas, prenez des précautions telles que limiter l’accès DOM aux pages internes et obtenir l’URL d’aperçu à l’aide d’une identité d’application avec accès en lecture seule.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
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) Non prise en charge. Non prise en charge.
Application Files.Read.All Files. ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Remarque

SharePoint Embedded nécessite l’autorisation FileStorageContainer.Selected pour accéder au contenu du conteneur. Cette autorisation est différente de celles mentionnées précédemment. Outre les autorisations Microsoft Graph, votre application doit disposer des autorisations de type conteneur nécessaires pour appeler cette API. Pour plus d’informations, consultez Authentification et autorisation SharePoint Embedded.

Requête HTTP

POST /drives/{driveId}/items/{itemId}/preview
POST /groups/{groupId}/drive/items/{itemId}/preview
POST /me/drive/items/{itemId}/preview
POST /sites/{siteId}/drive/items/{itemId}/preview
POST /users/{userId}/drive/items/{itemId}/preview
POST /shares/{shareId}/driveItem/preview

Corps de la demande

Le corps de la demande définit les propriétés de l’URL incorporable demandée par votre application. La demande doit être un objet JSON qui possède les propriétés suivantes :

Nom Type Description
Visionneuse string Facultatif. Préversion de l’application à utiliser. onedrive ou office. Si la valeur est nulle, une visionneuse appropriée est choisie automatiquement.
sans chrome Boolean Facultatif. Si true (par défaut), la vue incorporée n’inclut aucun contrôle.
allowEdit Boolean Facultatif. Si true, le fichier peut être modifié à partir de l’interface utilisateur incorporée.
page chaîne/numéro Facultatif. Numéro de page du document à partir duquel commencer, le cas échéant. Spécifié sous forme de chaîne pour les cas d’utilisation futurs concernant des types de fichiers tels que ZIP.
zoom number Facultatif. Niveau de zoom à partir de, le cas échéant.

Réponse

{
    "getUrl": "https://www.onedrive.com/embed?foo=bar&bar=baz",
    "postParameters": "param1=value&param2=another%20value",
    "postUrl": "https://www.onedrive.com/embed_by_post"
}

La réponse sera un objet JSON contenant les propriétés suivantes :

Nom Type Description
getUrl string URL adaptée à l’incorporation à l’aide de HTTP GET (iframes, etc.)
postUrl string URL adaptée à l’intégration à l’aide de HTTP POST (form post, JS, etc.)
postParameters string Paramètres POST à inclure en cas d’utilisation de postUrl

getUrl, postUrl ou les deux peuvent être renvoyés en fonction de l’état actuel de la prise en charge d’incorporation pour les options spécifiées.

postParameters est une chaîne au format , application/x-www-form-urlencodedet si vous effectuez un POST sur postUrl, le type de contenu doit être défini en conséquence. Par exemple :

POST https://www.onedrive.com/embed_by_post
Content-Type: application/x-www-form-urlencoded

param1=value&param2=another%20value

Observateurs

Remarque : Ce paramètre est déconseillé et n’est pas disponible sur le point de terminaison v1.0.

Les valeurs suivantes sont autorisées pour le paramètre viewer .

Valeur du type Description
(null) Choisit une application appropriée pour le rendu du fichier. Dans la plupart des cas, il utilise l’outil d’aperçu, mais cela peut varier selon le type de onedrive fichier.
onedrive Utilisez l’application d’aperçu de OneDrive pour afficher le fichier.
office Utilisez la version web d’Office pour afficher le fichier. Valide uniquement pour les documents Office.

Chrome vs chromeless

Remarque : Ce paramètre est déconseillé et n’est pas disponible sur le point de terminaison v1.0.

Si chromeless la valeur est true, l’aperçu sera un rendu nu du fichier. Dans le cas contraire, des barres d’outils/boutons supplémentaires peuvent être affichés pour interagir avec le document/la vue.

Afficher/modifier

Remarque : Ce paramètre est déconseillé et n’est pas disponible sur le point de terminaison v1.0.

Si allowEdit la valeur est true, le document peut être modifié par l’interaction de l’utilisateur avec l’aperçu intégré. Cette fonctionnalité n’est peut-être pas disponible pour toutes les applications ou tous les types de fichiers en préversion.

Page/zoom

Les page options et zoom peuvent ne pas être disponibles pour toutes les applications de préversion, mais seront appliquées si l’application de préversion les prend en charge.

  • Last updated on