可嵌入文件预览

项目
04/08/2023

此操作允许获取项的短期可嵌入 URL。

如果要获取长期可嵌入链接，请改用 createLink API。

权限

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

权限类型	权限（从最低特权到最高特权）
委派（工作或学校帐户）	Files.Read、Files.ReadWrite、Files.ReadWrite.All、Sites.ReadWrite.All
委派（个人 Microsoft 帐户）	Files.Read、Files.ReadWrite、Files.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 对象。

名称	类型	说明
观众	string	可选。要使用的预览应用。 `onedrive` 或 `office`）。如果为 null，则将自动选择合适的查看器。
无 chrome	boolean	可选。如果 `true` (默认) ，则嵌入视图将不包含任何控件。
allowEdit	boolean	可选。如果 `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	string	适用于使用 HTTP GET (iframe 等嵌入的 URL )
postUrl	string	适合使用 HTTP POST (表单 post、JS 等嵌入的 URL )
postParameters	string	使用 postUrl 时要包括的 POST 参数

根据对指定选项的嵌入支持的当前状态，可能会返回 getUrl、postUrl 或两者。

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

查看者

查看器参数允许以下值。

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

Chrome 与无 Chrome

如果“无 chrome”为 true，则预览将是文件的裸呈现。否则，可能会显示用于与文档/视图交互的其他工具栏/按钮。

查看/编辑

如果“编辑”为 true，则可以通过用户与嵌入预览交互来修改文档。此功能可能不适用于所有预览应用或文件类型。

Page/Zoom

“页面”和“缩放”选项可能不适用于所有预览应用，但如果预览应用支持，则会应用它。

通过