driveItem: PreviewdriveItem: preview

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

Importante

Las API de la /beta versión de Microsoft Graph están sujetas a cambios.APIs under the /beta version in Microsoft Graph are subject to change. No se admite el uso de estas API en aplicaciones de producción.Use of these APIs in production applications is not supported. Para determinar si una API está disponible en v 1.0, use el selector de versiones .To determine whether an API is available in v1.0, use the Version selector.

Esta acción le permite obtener direcciones URL incrustables de corta duración para un elemento a fin de representar una vista previa temporal.This action allows you to obtain short-lived embeddable URLs 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
lectorviewer cadenastring Opcional.Optional. Aplicación de vista previa que se va a usar.Preview app to use. onedrive o office.onedrive or office. Si es null, se elegirá automáticamente un visor adecuado.If null, a suitable viewer will be chosen automatically.
cromolesschromeless booleanboolean Opcional.Optional. Si true (valor predeterminado), la vista incrustada no incluirá ningún control.If true (default), the embedded view will not include any controls.
allowEditallowEdit booleanboolean Opcional.Optional. Si true , el archivo se puede editar desde la interfaz de usuario incrustada.If true, the file can be edited from the embedded UI.
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 cadenastring Dirección URL adecuada para la incrustación con HTTP GET (iframes, etc.)URL suitable for embedding using HTTP GET (iframes, etc.)
PosturapostUrl cadenastring 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 cadenastring 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

EspectadoresViewers

Nota: Este parámetro está en desuso y no estará disponible en el punto de conexión v 1.0.Note: This parameter is deprecated and will not be made available on the v1.0 endpoint.

Se permiten los siguientes valores para el parámetro Viewer .The following values are allowed for the viewer parameter.

Valor del tipoType value DescripciónDescription
que(null) Elige una aplicación adecuada para representar el archivo.Chooses an appropriate app for rendering the file. En la mayoría de los casos, esto usará el onedrive previsualizador, pero puede variar según el tipo de archivo.In most cases this will use the onedrive previewer, but may vary by file type.
onedrive Use la aplicación de vista previa de OneDrive para representar el archivo.Use the OneDrive previewer app to render the file.
office Use la versión Web de Office para representar el archivo.Use the web version of Office to render the file. Solo es válido para documentos de Office.Only valid for Office documents.

Chrome frente a ChromeChrome vs chromeless

Nota: Este parámetro está en desuso y no estará disponible en el punto de conexión v 1.0.Note: This parameter is deprecated and will not be made available on the v1.0 endpoint.

Si chromeless es true, la vista previa será una representación básica del archivo.If chromeless is true, the preview will be a bare rendering of the file. De lo contrario, es posible que se muestren botones o barras de herramientas adicionales para interactuar con el documento o la vista.Otherwise, there may be additional toolbars/buttons displayed for interacting with the document/view.

Ver o editarView/edit

Nota: Este parámetro está en desuso y no estará disponible en el punto de conexión v 1.0.Note: This parameter is deprecated and will not be made available on the v1.0 endpoint.

Si allowEdit es true, la interacción del usuario con la vista previa incrustada puede modificar el documento.If allowEdit is true, the document can be modified by user interaction with the embedded preview. Es posible que esta funcionalidad no esté disponible para todos los tipos de archivo o aplicaciones de vista previa.This capability may not be available for all preview apps or file types.

Página/zoomPage/zoom

Las page zoom Opciones y podrían no estar 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 might not be available for all preview apps, but will be applied if the preview app supports it.