driveItem:预览版
命名空间:microsoft.graph
此操作允许获取项的短期可嵌入 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
请求标头
名称 | 说明 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type | application/json. 必需。 |
请求正文
请求正文定义应用程序请求的可嵌入 URL 的属性。 请求应为具有以下属性的 JSON 对象。
名称 | 类型 | 说明 |
---|---|---|
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 (表单 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¶m2=another%20value
页面/缩放
“页面”和“缩放”选项可能不适用于所有预览应用,但如果预览应用支持,则会应用它。