driveItem: предварительная версия

Статья
01/30/2024

Пространство имен: microsoft.graph

Это действие позволяет получить кратковременный ВНЕДРЕННЫЙ URL-адрес для элемента, чтобы отобразить временный предварительный просмотр.

Если вы хотите получить долгоживущие встраиваемые ссылки, используйте ВМЕСТО этого API createLink .

Примечание: Действие предварительной версии в настоящее время доступно только в SharePoint и OneDrive для бизнеса.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Files.Read	Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	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

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

Текст запроса

Текст запроса определяет свойства встраиваемого URL-адреса, запрашиваемого приложением. Запрос должен быть объектом JSON с указанными ниже свойствами.

Имя	Тип	Описание
page	строка или число	Необязательный параметр. Номер страницы документа, с который необходимо начать, если применимо. Указывается в качестве строки для будущих вариантов использования типов файлов, таких как ZIP.
zoom	число	Необязательный параметр. Уровень масштабирования, с который необходимо начать, если применимо.

Отклик

{
    "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	URL-адрес, подходящий для внедрения с помощью HTTP GET (iframes и т. д.)
postUrl	string	URL-адрес, подходящий для внедрения с помощью HTTP POST (post form, JS и т. д.)
postParameters	string	Параметры POST для включения при использовании postUrl

В зависимости от текущего состояния поддержки внедрения для указанных параметров может быть возвращено значение getUrl, postUrl или и то, и другое.

postParameters — это строка, отформатированная как application/x-www-form-urlencoded, и при выполнении postUrl postUrl тип содержимого должен быть задан соответствующим образом. Например:

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

param1=value&param2=another%20value

Страница и масштабирование

Параметры "страница" и "масштаб" могут быть недоступны для всех предварительных версий приложений, но будут применяться, если приложение предварительной версии поддерживает их.