Aperçus de fichiers in incorporer

Cette action vous permet d’obtenir des URL in incorporationnables à durée de vie courte pour un élément.

Si vous souhaitez obtenir des liens in incorporer à durée de vie longue, utilisez plutôt [l’API createLink.][]

Autorisations

L’une des autorisations suivantes est nécessaire 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 moins de privilèges à celle qui en offre le plus)
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 intégrable que votre application demande. La demande doit être un objet JSON qui possède les propriétés suivantes :

Nom	Type	Description
visionneuse	string	Facultatif. Prévisualiser l’application à utiliser. onedrive ou office. Si la valeur est Null, une visionneuse appropriée est choisie automatiquement.
chromeless	booléen	Facultatif. Si true (valeur par défaut), l’affichage incorporé n’inclut aucun contrôle.
allowEdit	booléen	Facultatif. Si true , le fichier peut être modifié à partir de l’interface utilisateur incorporée.
page	string/number	Facultatif. Numéro de page du document à partir du, le cas échéant. Spécifié en tant que chaîne pour les cas d’utilisation futurs autour 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’incorporation à l’aide de HTTP POST (billet de formulaire, JS, etc.)
postParameters	string	Paramètres POST à inclure si vous utilisez postUrl

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

postParameters est une chaîne mise en forme comme , et si vous effectuez une postUrl, le type de contenu doit application/x-www-form-urlencoded être définie 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 de visionneuse.

Valeur de la visionneuse	Description
(null)	Choisit une application appropriée pour le rendu du fichier. Dans la plupart des cas, l’aperçu est onedrive utilisé, mais il peut varier en fonction du type de fichier.
onedrive	Utilisez l’OneDrive d’aperçu pour afficher le fichier.
office	Utilisez le wac (Office en ligne) pour restituer le fichier. Valide uniquement pour Office documents.

Chrome et Chromeless

Si « chromeless » est vrai, l’aperçu sera un rendu complet du fichier. Dans le cas contraire, des barres d’outils/boutons supplémentaires peuvent s’afficher pour interagir avec le document/l’affichage.

Afficher/Modifier

Si « modifier » est vrai, 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 fichier ou applications d’aperçu.

Page/Zoom

Les options « page » et « zoom » peuvent ne pas être disponibles pour toutes les applications d’aperçu, mais elles seront appliquées si l’application d’aperçu la prend en charge.