Compartilhar via


Gerir sessões e persistência no Excel

Se a sua aplicação precisar de fazer mais do que uma ou duas chamadas para a API do Excel no Microsoft Graph, crie uma sessão e transmita o ID da sessão com cada pedido. A presença de um ID de sessão nos pedidos garante que está a utilizar a API do Excel da forma mais eficiente possível.

As APIs do Excel podem ser chamadas em um destes três modos:

  • Sessão persistente: Todas as alterações efetuadas ao livro são mantidas (guardadas) no livro. Esse uso da API do Excel é o método mais eficiente e que oferece o melhor desempenho.

  • Sessão não persistente: As alterações efetuadas pela API não são guardadas na localização de origem. Em vez disso, o servidor back-end do Excel mantém uma cópia temporária do arquivo que reflete as alterações feitas durante essa sessão de API específica. Quando a sessão do Excel expirar, as alterações serão perdidas. Esse modo é útil para aplicativos que precisam fazer uma análise ou obter os resultados de um cálculo ou de uma imagem de gráfico, mas não precisa afetar o estado do documento.

  • Sem sessão: As chamadas à API não passam num ID de sessão. Os servidores do Excel têm de localizar a cópia do servidor do livro para cada operação. Essa não é uma maneira eficiente para chamar a API do Excel, mas ela é adequada para fazer certos tipos de solicitações isoladas.

Para representar a sessão na API, use o cabeçalho workbook-session-id: {session-id}.

Observação

O cabeçalho da sessão não é necessário para que uma API do Excel funcione. No entanto, recomendamos que você use o cabeçalho de sessão para melhorar o desempenho. Se você não usar um cabeçalho de sessão, as alterações feitas durante a chamada da API serão mantidas como persistentes no arquivo.

Tipos de pedido

O processamento de erros sugerido para AS APIs do Excel baseia-se no tipo de pedido, no código de erro e no código de status. Seguem-se os tipos de pedido:

  • Pedido CreateSession: Utilizado para criar uma sessão persistente ou não persistente. Numa resposta bem-sucedida, o ID da sessão será devolvido na propriedade ID no corpo da resposta. Para obter detalhes, veja Criar sessão.
  • Pedido com sessão: Pedidos subsequentes que se seguem a um pedido CreateSession. Normalmente, incluem um workbook-session-id: {session-id} cabeçalho. A exceção é um inquérito status pedido, que utiliza o padrão de operação de execução prolongada. Para obter detalhes, veja Trabalhar com APIs que demoram muito tempo a concluir.
  • Pedido sem sessão: Utilizado no modo Sem sessão. Estes pedidos não têm um workbook-session-id: {session-id} cabeçalho.

Próximas etapas

Para saber como criar e usar sessões, confira o tópico de referência de criação de sessão.