Aperçus des fichiers incorporables

Article
04/08/2023

Cette action vous permet d’obtenir des URL incorporées de courte durée pour un élément.

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

Autorisations

L’une des autorisations suivantes est requise pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation	Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire)	Files.Read, Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All
Déléguée (compte Microsoft personnel)	Files.Read, Files.ReadWrite, Files.ReadWrite.All
Application	s/o

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	valeur booléenne	Facultatif. Si `true` la valeur est (valeur par défaut), la vue incorporée n’inclut aucun contrôle.
allowModifier	valeur booléenne	Facultatif. Si `true`la valeur est , 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 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	Facultatif. 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	chaîne	URL adaptée à l’incorporation à l’aide de HTTP GET (iframes, etc.)
postUrl	chaîne	URL adaptée à l’incorporation à l’aide de HTTP POST (formulaire post, JS, etc.)
postParameters	string	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

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

Valeur de la visionneuse	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 wac (Office online) pour afficher le fichier. Valide uniquement pour les documents Office.

Chrome et Chromeless

Si « chromeless » est 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

Si « edit » 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 options « page » et « zoom » ne sont peut-être pas disponibles pour toutes les applications en préversion, mais elles seront appliquées si l’application en préversion les prend en charge.

Share via