driveItem: versão prévia

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Essa ação permite obter URLs inseriveis de curta duração para um item, a fim de renderizar uma visualização temporária.

Se você quiser obter links inseriveis de longa duração, use a API createLink .

Nota: No momento, a ação de visualização só está disponível no SharePoint e OneDrive for Business.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Files.Read	Files.Read.All, Files.ReadWrite, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	Files.Read.All	Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Solicitação 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

Corpo da solicitação

O corpo da solicitação define as propriedades da URL inserida que seu aplicativo está solicitando. A solicitação deve ser um objeto JSON com as seguintes propriedades.

Nome	Tipo	Descrição
Visualizador	string	Opcional. Aplicativo de visualização a ser usado. onedrive ou office. Se for nulo, um visualizador adequado será escolhido automaticamente.
Chromeless	booliano	Opcional. Se true (padrão), a exibição inserida não incluirá controles.
Allowedit	booliano	Opcional. Se true, o arquivo poderá ser editado da interface do usuário inserida.
page	cadeia de caracteres/número	Opcional. Número de página do documento a ser iniciado, se aplicável. Especificado como cadeia de caracteres para casos de uso futuros em torno de tipos de arquivo, como ZIP.
zoom	number	Opcional. Nível de zoom a ser iniciado, se aplicável.

Resposta

{
    "getUrl": "https://www.onedrive.com/embed?foo=bar&bar=baz",
    "postParameters": "param1=value&param2=another%20value",
    "postUrl": "https://www.onedrive.com/embed_by_post"
}

A resposta será um objeto JSON que contém as seguintes propriedades:

Nome	Tipo	Descrição
Geturl	cadeia de caracteres	URL adequada para inserção usando HTTP GET (iframes etc.)
postUrl	cadeia de caracteres	URL adequada para inserção usando HTTP POST (postagem de formulário, JS etc.)
postParameters	string	Parâmetros POST a serem incluídos se usar postUrl

GetUrl, postUrl ou ambos podem ser retornados dependendo do estado atual do suporte de inserção para as opções especificadas.

postParameters é uma cadeia de caracteres formatada como application/x-www-form-urlencoded, e se executar um POST para o postUrl, o tipo de conteúdo deverá ser definido de acordo. Por exemplo:

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

param1=value&param2=another%20value

Visualizadores

Nota: Esse parâmetro foi preterido e não será disponibilizado no ponto de extremidade v1.0.

Os valores a seguir são permitidos para o parâmetro visualizador .

Valor do tipo	Descrição
(nulo)	Escolhe um aplicativo apropriado para renderizar o arquivo. Na maioria dos casos, isso usará o visualizador, mas pode variar de acordo com o onedrive tipo de arquivo.
onedrive	Use o aplicativo de visualização do OneDrive para renderizar o arquivo.
office	Use a versão web do Office para renderizar o arquivo. Válido apenas para documentos do Office.

Chrome vs chromeless

Nota: Esse parâmetro foi preterido e não será disponibilizado no ponto de extremidade v1.0.

Se chromeless for true, a visualização será uma renderização nua do arquivo. Caso contrário, poderá haver barras de ferramentas/botões adicionais exibidos para interagir com o documento/exibição.

Exibir/editar

Nota: Esse parâmetro foi preterido e não será disponibilizado no ponto de extremidade v1.0.

Se allowEdit for verdadeiro, o documento poderá ser modificado pela interação do usuário com a visualização inserida. Essa funcionalidade pode não estar disponível para todos os aplicativos de versão prévia ou tipos de arquivo.

Página/zoom

As page opções e zoom podem não estar disponíveis para todos os aplicativos de visualização, mas serão aplicadas se o aplicativo de visualização dá suporte a ele.