可嵌入的文件预览
此操作允许您获取项目的短期可嵌入 URL。
如果你想要获取长期嵌入的链接,请改为使用 createLink API。
Permissions
要调用此 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 对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| viewer | string | 可选。 预览应用以使用。 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¶m2=another%20value",
"postUrl": "https://www.onedrive.com/embed_by_post"
}
该响应将是包含以下属性的 JSON 对象:
| 名称 | 类型 | 说明 |
|---|---|---|
| getUrl | string | 适合使用 HTTP GET (iframe 等嵌入的 URL ) |
| postUrl | string | 适合使用 HTTP POST、表单 (JS 等进行嵌入的 URL ) |
| postParameters | string | 使用 postUrl 时要包含的 POST 参数 |
可能会返回 getUrl、postUrl 或两者,具体取决于指定选项的嵌入支持的当前状态。
postParameters 是格式设置为 的字符串,如果对 postUrl 执行 application/x-www-form-urlencoded POST,应相应地设置内容类型。 例如:
POST https://www.onedrive.com/embed_by_post
Content-Type: application/x-www-form-urlencoded
param1=value¶m2=another%20value
查看者
viewer 参数 允许以下值 。
| 查看器值 | 说明 |
|---|---|
| (null) | 选择用于呈现文件的适当应用。 在大多数情况下,这将使用 onedrive 预览器,但因文件类型而异。 |
onedrive |
使用 OneDrive 预览器应用呈现文件。 |
office |
使用 WAC (Office联机) 呈现文件。 仅对文档Office有效。 |
Chrome 与 Chromeless
如果"chromeless"为 true,预览将只是文件的空呈现。 否则,可能会显示其他工具栏/按钮以与文档/视图交互。
查看/编辑
如果"edit"为 true,则可以通过用户与嵌入预览的交互来修改文档。 此功能可能无法用于所有预览应用或文件类型。
页面/缩放
"页面"和"缩放"选项可能并非适用于所有预览应用,但将在预览应用支持时应用。