Partager via

driveItem : préversion

  • Article

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 incorporées de courte durée pour un élément afin d’afficher un aperçu temporaire.

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

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

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) Non prise en charge. Non prise en charge.
Application Files.Read.All Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

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 que votre application demande. La demande doit être un objet JSON qui possède les propriétés suivantes :

Nom Type Description
spectateur string Facultatif. Aperçu de l’application à utiliser. onedrive ou office. Si la valeur est null, une visionneuse appropriée est choisie automatiquement.
chromeless Boolean Facultatif. Si true la valeur est (valeur par défaut), la vue incorporée n’inclut aucun contrôle.
allowModifier Boolean Facultatif. Si truela valeur est , le fichier peut être modifié à partir de l’interface utilisateur incorporée.
page chaîne/numéro Optional. Numéro de page du document à partir de laquelle commencer, le cas échéant. Spécifié en tant que chaîne pour les futurs cas d’usage autour des types de fichiers tels que ZIP.
zoom number Optional. Niveau de zoom à partir de laquelle commencer, 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 est 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’incorporation à l’aide de HTTP POST (formulaire post, JS, etc.)
postParameters chaîne Paramètres POST à inclure si vous utilisez postUrl

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

postParameters est une chaîne au application/x-www-form-urlencodedformat , et si vous effectuez un 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

Note: Ce paramètre est déconseillé et ne sera pas rendu 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, cela utilise l’aperçu onedrive , mais peut varier selon le type de fichier.
onedrive Utilisez l’application d’aperçu OneDrive pour afficher le fichier.
office Utilisez la version web d’Office pour afficher le fichier. Valide uniquement pour les documents Office.

Chrome et chromeless

Note: Ce paramètre est déconseillé et ne sera pas rendu disponible sur le point de terminaison v1.0.

Si chromeless a la valeur true, l’aperçu sera un rendu nu du fichier. Sinon, des barres d’outils/boutons supplémentaires peuvent s’afficher pour interagir avec le document/la vue.

Afficher/modifier

Note: Ce paramètre est déconseillé et ne sera pas rendu disponible sur le point de terminaison v1.0.

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

Page/zoom

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