driveItem：预览版

命名空间：microsoft.graph

重要

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

通过此操作，可以获取项的短期可嵌入 URL，以便呈现临时预览。

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

注意：预览操作目前仅在 SharePoint 和 OneDrive for Business 上可用。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

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

名称	类型	说明
观众	string	可选。 要使用的预览应用。 onedrive 或 office）。 如果为 null，则将自动选择合适的查看器。
无 chrome	布尔值	可选。 如果 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	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

查看者

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

查看器参数允许以下值。

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

Chrome 与无版式

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

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

查看/编辑

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

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

页面/缩放

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