Предварительные просмотры внедренных файлов

Это действие позволяет получить кратковременные встраиваемые URL-адреса для элемента.

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

Разрешения

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

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

Наблюдатели

Для параметра средства просмотра разрешены следующие значения.

Значение средства просмотра	Описание
(null)	Выбирает подходящее приложение для отрисовки файла. В большинстве случаев используется средство предварительного onedrive просмотра, но может отличаться в зависимости от типа файла.
onedrive	Используйте приложение средства предварительного просмотра OneDrive для отрисовки файла.
office	Используйте WAC (Office Online) для отрисовки файла. Допустимо только для документов Office.

Chrome и Chromeless

Если параметр "без хрома" имеет значение true, предварительная версия будет отрисовкой файла без хрома. В противном случае могут отображаться дополнительные панели инструментов или кнопки для взаимодействия с документом или представлением.

Просмотр и изменение

Если параметр edit имеет значение true, документ можно изменить путем взаимодействия пользователя с внедренным предварительным просмотром. Эта возможность может быть доступна не для всех предварительных версий приложений или типов файлов.

Страница или масштаб

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