Vistas previas de archivos incrustables

Artículo
04/08/2023

Esta acción le permite obtener direcciones URL insertables de corta duración para un elemento.

Si desea obtener vínculos incrustables de larga duración, use createLink API en su lugar.

Permisos

Se requiere uno de los permisos siguientes para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Tipo de permiso	Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa)	Files.Read, Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft)	Files.Read, Files.ReadWrite, Files.ReadWrite.All
Aplicación	N/D

Solicitud 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

Cuerpo de solicitud

El cuerpo de la solicitud define las propiedades de la dirección URL incrustable que la aplicación está solicitando. La solicitud debe ser un objeto JSON con las siguientes propiedades.

Nombre	Tipo	Descripción
Espectador	string	Opcional. Versión preliminar de la aplicación que se va a usar. `onedrive` o `office`. Si es null, se elegirá automáticamente un visor adecuado.
Chromeless	booleano	Opcional. Si `true` es (valor predeterminado), la vista incrustada no incluirá ningún control.
allowEdit	booleano	Opcional. Si `true`es , el archivo se puede editar desde la interfaz de usuario incrustada.
page	cadena/número	Opcional. Número de página del documento al que empezar, si procede. Se especifica como cadena para casos de uso futuros en torno a tipos de archivo como ZIP.
zoom	número	Opcional. Nivel de zoom en el que empezar, si procede.

Respuesta

{
    "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:

Nombre	Tipo	Descripción
Geturl	string	Dirección URL adecuada para la inserción mediante HTTP GET (iframes, etc.)
postUrl	string	Dirección URL adecuada para la inserción mediante HTTP POST (entrada de formulario, JS, etc.)
postParameters	string	Parámetros POST que se van a incluir si se usa postUrl

GetUrl, postUrl o ambos se pueden devolver en función del estado actual de compatibilidad con la inserción para las opciones especificadas.

postParameters es una cadena con application/x-www-form-urlencodedformato , y si se realiza una operación POST en postUrl, el tipo de contenido debe establecerse en consecuencia. Por ejemplo:

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

param1=value&param2=another%20value

Espectadores

Se permiten los siguientes valores para el parámetro viewer .

Valor del visor	Descripción
(null)	Elige una aplicación adecuada para representar el archivo. En la mayoría de los casos, se usará la `onedrive` vista previa, pero puede variar según el tipo de archivo.
`onedrive`	Use la aplicación de vista previa de OneDrive para representar el archivo.
`office`	Use WAC (Office online) para representar el archivo. Solo es válido para documentos de Office.

Chrome vs Chromeless

Si 'chromeless' es true, la vista previa será una representación sin sistema operativo del archivo. De lo contrario, puede haber barras de herramientas o botones adicionales para interactuar con el documento o la vista.

Ver o editar

Si 'edit' es true, el documento se puede modificar mediante la interacción del usuario con la vista previa incrustada. Es posible que esta funcionalidad no esté disponible para todos los tipos de archivo o aplicaciones en versión preliminar.

Página/Zoom

Es posible que las opciones "página" y "zoom" no estén disponibles para todas las aplicaciones en versión preliminar, pero se aplicarán si la aplicación en versión preliminar la admite.

Compartir a través de