Скачивание файла в другом формате

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

С помощью этого API вы можете получить содержимое элемента в определенном формате. Не все файлы можно преобразовать в любые форматы.

Сведения о том, как скачать элемент в его исходном формате, см. в статье о скачивании содержимого элемента.

Примечание.

Максимальный размер файлов, которые можно использовать в преобразовании формата, составляет 2 МБ.

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

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

Разрешения

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

Тип разрешения	Разрешения с наименьшим объемом привилегий	Разрешения с более высоким уровнем привилегий
Делегированные (рабочая или учебная учетная запись)	Files.Read	Files. Чтение и запись Files. Read.All, Files. ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Files.Read	Files. Чтение и запись Files. Read.All, Files. ПрочитатьНаписать.Все
Приложение	Files.ReadWrite.All	Sites.ReadWrite.All

Примечание.

SharePoint Embedded требуется FileStorageContainer.Selected разрешение на доступ к содержимому контейнера. Это разрешение отличается от упомянутых ранее. В дополнение к разрешениям Microsoft Graph приложение должно иметь разрешения, необходимые для вызова этого API. Дополнительные сведения см. в статье Проверка подлинности и авторизация SharePoint Embedded.

HTTP-запрос

GET /me/drive/items/{item-id}/content?format={format}
GET /me/drive/root:/{path and filename}:/content?format={format}
GET /drive/items/{item-id}/content?format={format}
GET /drive/root:/{path and filename}:/content?format={format}

Параметры запроса

Параметр	Тип	Описание
format	String	Укажите формат, в котором следует скачать содержимое элемента.
height	Int32	Желаемая высота преобразованного изображения в пикселях. Обязательно, когда format=jpg.
ширина	Int32	Желаемая ширина преобразованного изображения в пикселях. Обязательно, когда format=jpg.

Параметры форматирования

Для параметра format допустимы указанные ниже значения.

Значение формата	Описание	Поддерживаемые расширения источника
JPG	Преобразует элемент в формат JPG.	3G2, 3GP, 3GP2, 3GPP, 3MF, AI, ARW, ASF, AVI, BAS, BASH, BAT, BMP, C, CBL, CMD, COOL, CPP, CR2, CRW, CS, CSS, CSV, CUR, DCM, DCM30, DIC, DICM, DICOM, DNG, DOC, DOCX, DWG, EML, EPI, EPS, EPSF, EPSI, EPUB, ERF, FBX, FPPX, GIF, GLB, H, HCP, HEIC, HEIF, HTM, HTML, ICO, ICON, JAVA, JFIF, JPEG, JPG, JS, JSON, KEY, LOG, M2TS, M4A, M4V, MARKDOWN, MD, MEF, MOV, MOVIE, MP3, MP4, MP4V, MRW, MSG, MTS, NEF, NRW, NUMBERS, OBJ, ODP, ODT, OGG, ORF, PAGES, PANO, PDF, PEF, PHP, PICT, PL, PLY, PNG, POT, POTM, POTX, PPS, PPSX, PPSXM, PPT, PPTM, PPTX, PS, PS1, PSB, PSD, PY, RAW, RB, RTF, RW1, RW2, SH, SKETCH, SQL, SR2, STL, TIF, TIFF, TS, TXT, VB, WEBM, WMA, WMV, XAML, XBM, XCF, XD, XML, XPM, YAML, YML
pdf	Преобразует элемент в формат PDF.	doc, docx, dot, dotx, dotm, dsn, dwg, eml, epub, fluidframework, form, htm, html, loop, loot, markdown, md, msg, note, odp, ods, odt, page, pps, ppsx, ppt, pptx, pulse, rtf, task, tif, tiff, wbtx, whiteboard, xls, xlsm, xlsx
HTML	Преобразует элемент в формат HTML.	Loop, Fluid, WBTX, Whiteboard

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

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения об аутентификации и авторизации.
if-none-match	Строка. Если указан этот заголовок запроса, а предоставленный тег eTag (или cTag) совпадает с текущим тегом файла, то будет возвращен ответ HTTP 304 Not Modified.

Пример

Запрос

Ниже показан пример запроса.

HTTP

GET /me/drive/items/{item-id}/content?format={format}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].Content.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Format = "{format}";
});

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdrives "github.com/microsoftgraph/msgraph-sdk-go/drives"
	  //other-imports
)


requestFormat := "{format}"

requestParameters := &graphdrives.ItemItemsItemContentRequestBuilderGetQueryParameters{
	Format: &requestFormat,
}
configuration := &graphdrives.ItemItemsItemContentRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Drives().ByDriveId("drive-id").Items().ByDriveItemId("driveItem-id").Content().Get(context.Background(), configuration)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.drives().byDriveId("{drive-id}").items().byDriveItemId("{driveItem-id}").content().get(requestConfiguration -> {
	requestConfiguration.queryParameters.format = "{format}";
});

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/me/drive/items/{item-id}/content?format={format}')
	.get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Drives\Item\Items\Item\Content\ContentRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new ContentRequestBuilderGetRequestConfiguration();
$queryParameters = ContentRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->format = "{format}";
$requestConfiguration->queryParameters = $queryParameters;


$graphServiceClient->drives()->byDriveId('drive-id')->items()->byDriveItemId('driveItem-id')->content()->get($requestConfiguration)->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Files

Get-MgDriveItemContent -DriveId $driveId -DriveItemId $driveItemId -Format "{format}" 

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.drives.item.items.item.content.content_request_builder import ContentRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = ContentRequestBuilder.ContentRequestBuilderGetQueryParameters(
		format = "{format}",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

await graph_client.drives.by_drive_id('drive-id').items.by_drive_item_id('driveItem-id').content.get(request_configuration = request_configuration)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика. Он возвращает ответ, 302 Found перенаправляющий на предварительно прошедший проверку подлинности URL-адрес скачивания преобразованного файла.

Чтобы скачать преобразованный файл, ваше приложение должно следовать заголовку Location в ответе.

URL-адреса, прошедшие предварительную проверку подлинности, действительны только в течение короткого периода времени (несколько минут) и не требуют Authorization заголовка для доступа.

HTTP/1.1 302 Found
Location: https://b0mpua-by3301.files.1drv.com/y23vmagahszhxzlcvhasdhasghasodfi

Ответы с ошибками

Дополнительные сведения о том, как возвращаются ошибки, см. в разделе Отклики на ошибки.