driveItem: PreviewdriveItem: preview

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

Esta acción permite obtener una dirección URL incrustable de corta duración para un elemento a fin de representar una vista previa temporal.This action allows you to obtain a short-lived embeddable URL for an item in order to render a temporary preview.

Si desea obtener vínculos incrustables de larga duración, use la API CreateLink en su lugar.If you want to obtain long-lived embeddable links, use the createLink API instead.

Nota: Actualmente, la acción vista previa solo está disponible en SharePoint y OneDrive para la empresa.Note: The preview action is currently only available on SharePoint and OneDrive for Business.

PermisosPermissions

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permisoPermission type Permisos (de menos a más privilegiados)Permissions (from least to most privileged)
Delegado (cuenta profesional o educativa)Delegated (work or school account) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft)Delegated (personal Microsoft account) No admitida.Not supported.
AplicaciónApplication Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Solicitud HTTPHTTP request

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

Cuerpo de la solicitudRequest body

El cuerpo de la solicitud define las propiedades de la dirección URL incrustable que la aplicación está solicitando.The body of the request defines properties of the embeddable URL your application is requesting. La solicitud debe ser un objeto JSON con las siguientes propiedades.The request should be a JSON object with the following properties.

NombreName TipoType DescriptionDescription
pagepage cadena o númerostring/number Opcional.Optional. Número de página del documento que se va a iniciar, si procede.Page number of document to start at, if applicable. Especificado como String para los casos de uso futuros alrededor de tipos de archivo como ZIP.Specified as string for future use cases around file types such as ZIP.
zoomzoom numbernumber Opcional.Optional. Nivel de zoom para empezar, si procede.Zoom level to start at, if applicable.

RespuestaResponse

{
    "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 respuesta será un objeto JSON que contiene las siguientes propiedades:The response will be a JSON object containing the following properties:

NombreName TipoType DescriptionDescription
getUrlgetUrl stringstring Dirección URL adecuada para la incrustación con HTTP GET (iframes, etc.)URL suitable for embedding using HTTP GET (iframes, etc.)
PosturapostUrl stringstring Dirección URL adecuada para incrustar mediante HTTP POST (formulario post, JS, etc.)URL suitable for embedding using HTTP POST (form post, JS, etc.)
postparámetrospostParameters stringstring Parámetros POST para incluir si se usa posturalPOST parameters to include if using postUrl

Puede que se devuelva getUrl, postura o ambos según el estado actual de la compatibilidad con embed para las opciones especificadas.Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options.

Parameters es una cadena con formato como application/x-www-form-urlencoded y, si se realiza una publicación en la postura, el tipo de contenido debe establecerse en consecuencia.postParameters is a string formatted as application/x-www-form-urlencoded, and if performing a POST to the postUrl the content-type should be set accordingly. Por ejemplo:For example:

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

param1=value&param2=another%20value

Página/zoomPage/zoom

Es posible que las opciones "página" y "zoom" no estén disponibles para todas las aplicaciones de vista previa, pero se aplicarán si la aplicación de vista previa la admite.The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it.