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 incorporáveis de curta duração para um item a fim de renderizar uma visualização temporária.

Se você deseja obter links incorporáveis de longa duração, use a API createLink .

Observação

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

Cuidado

A URL de visualização destina-se ao uso próprio do chamador e não deve ser compartilhada com outros usuários. A visualização é renderizada em nome da identidade da chamada, e qualquer pessoa que acessa a URL atua como chamador com as permissões do chamador. Isso é particularmente importante em cenários de permissão de aplicativo em que seu aplicativo tem read-write acesso ao arquivo, mas você pretende fornecer acesso aos usuários read-only finais. Nesses casos, tome precauções, como restringir o acesso DOM aos componentes internos da página e obter a URL de visualização usando uma identidade de aplicativo com acesso somente leitura.

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

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

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
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.
Application Files.Read.All Files. ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

Observação

O SharePoint Embedded requer a FileStorageContainer.Selected permissão para acessar o conteúdo do contêiner. Essa permissão é diferente das mencionadas anteriormente. Além das permissões do Microsoft Graph, seu aplicativo deve ter as permissões de tipo de contêiner necessárias para chamar essa API. Para obter mais informações, consulte Autenticação e autorização do SharePoint Embedded.

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
do visualizador string Opcional. Aplicativo de pré-visualização para uso. onedrive ou office. Se nulo, um visualizador adequado será escolhido automaticamente.
sem cromo Booleano Opcional. Se true (padrão), a exibição inserida não incluirá nenhum controle.
permitirEditar Booleano Opcional. Em caso truede dúvida, o arquivo pode ser editado a partir da interface do usuário inserida.
page string/número Opcional. Número da página do documento a ser iniciado, se aplicável. Especificada como cadeia de caracteres para casos de uso futuros em torno de tipos de arquivo, como ZIP.
zoom number Opcional. Nível de zoom para iniciar, 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 contendo as seguintes propriedades:

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

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

postParameters é uma string formatada como application/x-www-form-urlencoded, e se estiver realizando um POST para o postUrl, o content-type deve 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

Observação: 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 do visualizador .

Valor do tipo Descrição
(nulo) Escolhe um aplicativo apropriado para renderizar o arquivo. Na maioria dos casos, isso usará o pré-visualizador, mas pode variar de acordo com o onedrive tipo de arquivo.
onedrive Use o aplicativo visualizador 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

Observação: 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 simples do arquivo. Caso contrário, pode haver barras de ferramentas/botões adicionais exibidos para interagir com o documento/exibição.

Exibir/editar

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

Se allowEdit for true, 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 tipos de arquivo ou aplicativos de visualização.

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 der suporte a elas.

  • Última atualização a