driveItem： preview

命名空间：microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

此操作允许您获取项目的短生存期可嵌入 Url，以呈现临时预览。

如果要获取持续生存期的可嵌入链接，请改用 createLink API。

注意：****预览操作当前仅适用于 SharePoint 和 OneDrive for business。

权限

要调用此 API，需要以下权限之一。要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型	权限（从最低特权到最高特权）
委派（工作或学校帐户）	Files.Read、Files.ReadWrite、Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。
应用程序	Files.Read.All、Files.ReadWrite.All、Sites.Read.All、Sites.ReadWrite.All

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

请求正文

请求正文定义您的应用程序所请求的可嵌入 URL 的属性。 请求应为具有以下属性的 JSON 对象。

名称	类型	说明
格式	字符串	可选。 要使用的预览应用。 onedrive 或 office）。 如果为 null，则将自动选择合适的查看器。
chromeless	布尔	可选。 如果 true (默认) ，则嵌入的视图将不包含任何控件。
allowEdit	布尔	可选。 如果 true 是，则可以从嵌入的 UI 编辑该文件。
page	string/number	可选。 要从其开始的文档的页码（如果适用）。 为在文件类型（如 ZIP）周围的将来用例指定为字符串。
zoom	number	可选。 要从其开始的缩放级别（如果适用）。

响应

{
    "getUrl": "https://www.onedrive.com/embed?foo=bar&bar=baz",
    "postParameters": "param1=value&param2=another%20value",
    "postUrl": "https://www.onedrive.com/embed_by_post"
}

响应将是一个包含以下属性的 JSON 对象：

名称	类型	说明
getUrl	字符串	适用于使用 HTTP GET (iframe 等嵌入的 URL )
postUrl	字符串	适合使用 HTTP POST (表单 post、JS 等进行嵌入的 URL )
postParameters	字符串	如果使用 postUrl，则发布要包括的参数

根据指定选项的 embed 支持的当前状态，可能会返回 getUrl、postUrl 或 both。

postParameters 是格式为的字符串 application/x-www-form-urlencoded ，如果向 postUrl 执行 POST，应相应地设置内容类型。 例如：

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

param1=value&param2=another%20value

查看者

注意： 此参数已弃用，将不会在 v1.0 终结点上可用。

查看器参数允许使用以下值。

类型值	说明
(null)	选择用于呈现文件的适当的应用程序。 在大多数情况下，这将使用 onedrive 预览器，但可能因文件类型而异。
onedrive	使用 OneDrive 预览器应用程序呈现文件。
office	使用 Office 的 web 版本呈现文件。 仅对 Office 文档有效。

Chrome vs chromeless

注意： 此参数已弃用，将不会在 v1.0 终结点上可用。

如果 chromeless 为 true，预览将是文件的简略呈现。 否则，可能会显示其他工具栏/按钮以与文档/视图进行交互。

查看/编辑

注意： 此参数已弃用，将不会在 v1.0 终结点上可用。

如果 allowEdit 为 true，则文档可以通过嵌入预览的用户交互进行修改。 此功能可能不适用于所有预览版应用或文件类型。

页面/缩放

"" 和 "" page zoom 选项可能不适用于所有预览版应用，但如果预览应用支持它，则将应用 "" 和 "" 选项。