driveItem: preview

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Esta acción permite obtener direcciones URL incrustables de corta duración para un elemento con el fin de representar una vista previa temporal.

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

Nota:

Actualmente, la acción de vista previa solo está disponible en SharePoint y OneDrive para la Empresa.

Precaución

La dirección URL de vista previa está pensada para el uso propio del autor de la llamada y no debe compartirse con otros usuarios. La vista previa se representa en nombre de la identidad que llama y cualquier persona que acceda a la dirección URL actúa como autor de la llamada con sus permisos. Esto es especialmente importante en escenarios de permisos de aplicación en los que la aplicación tiene read-write acceso al archivo, pero tiene previsto proporcionar acceso a los usuarios read-only finales. En tales casos, tome precauciones, como restringir el acceso DOM a los datos internos de la página y obtener la dirección URL de vista previa mediante una identidad de aplicación con acceso de solo lectura.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Files.Read Files. Read.All, Files. ReadWrite, Files. ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación Files.Read.All Files. ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Nota:

SharePoint Embedded requiere permiso FileStorageContainer.Selected para acceder al contenido del contenedor. Este permiso es diferente de los mencionados anteriormente. Además de los permisos de Microsoft Graph, la aplicación debe tener los permisos de tipo de contenedor necesarios para llamar a esta API. Para obtener más información, consulte Autenticación y autorización de SharePoint Embedded.

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 la solicitud

En el cuerpo de la solicitud se definen las propiedades de la dirección URL insertable que solicita la aplicación. La solicitud debe ser un objeto JSON con las siguientes propiedades.

Nombre Tipo Descripción
Visor string Opcional. Vista previa de la aplicación que se va a usar. onedrive o office. Si es null, se elegirá automáticamente un visor adecuado.
Sin cromo Booleano Opcional. Si true es (valor predeterminado), la vista incrustada no incluirá ningún control.
allowEdit Booleano Opcional. Si true, el archivo se puede editar desde la interfaz de usuario incrustada.
page Cadena/número Opcional. Número de página del documento por el 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 URL adecuada para insertar mediante HTTP GET (iframes, etc.)
postUrl string URL adecuada para incrustar mediante HTTP POST (formulario post, JS, etc.)
postParameters string Parámetros POST que se incluirán si se utiliza postUrl

Se pueden devolver getUrl, postUrl o ambos según el estado actual de compatibilidad con incrustaciones para las opciones especificadas.

postParameters es una cadena formateada como application/x-www-form-urlencoded, y si realiza un POST a 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

Nota: Este parámetro está en desuso y no estará disponible en el punto de conexión v1.0.

Se permiten los siguientes valores para el parámetro de visor .

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

Chrome frente a chromeless

Nota: Este parámetro está en desuso y no estará disponible en el punto de conexión v1.0.

Si chromeless es verdadera, la vista previa será una mera representación del archivo. De lo contrario, es posible que se muestren barras de herramientas o botones adicionales para interactuar con el documento o la vista.

Ver/editar

Nota: Este parámetro está en desuso y no estará disponible en el punto de conexión v1.0.

Si allowEdit es verdadero, 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 todas las aplicaciones o tipos de archivo de versión preliminar.

Página/zoom

Es page posible que las opciones and zoom no estén disponibles para todas las aplicaciones de versión preliminar, pero se aplicarán si la aplicación de versión preliminar lo admite.

  • Last updated on