Gerenciar sessões e persistência no Excel

  • Artigo

Se seu aplicativo precisar fazer mais de uma ou duas chamadas para a API do Excel no Microsoft Graph, crie uma sessão e passe a ID da sessão com cada solicitação. A presença de uma ID de sessão nas solicitações garante que você esteja usando a API do Excel da maneira mais eficiente possível.

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

  • Sessão persistente: Todas as alterações feitas na pasta de trabalho são persistentes (salvas) na pasta de trabalho. 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 feitas pela API não são salvas no local 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 de API não passam uma ID da sessão. Os servidores do Excel precisam localizar a cópia do servidor da pasta de trabalho 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 solicitação

O tratamento de erros sugeridos para APIs do Excel baseia-se no tipo de solicitação, no código de erro e no código status. A seguir estão os tipos de solicitação:

  • Solicitação CreateSession: Usado para criar uma sessão persistente ou não persistente. Em uma resposta bem-sucedida, a ID da sessão será retornada na propriedade id no corpo da resposta. Para obter detalhes, confira Criar sessão.
  • Solicitação de sessão: Solicitações subsequentes que seguem uma solicitação CreateSession. Eles geralmente incluem um workbook-session-id: {session-id} cabeçalho. A exceção é uma solicitação de status de pesquisa, que usa o padrão de operação de execução longa. Para obter detalhes, consulte Trabalhar com APIs que levam muito tempo para serem concluídas.
  • Solicitação sem sessão: Usado no modo sem sessão. Essas solicitações 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.

Conteúdo relacionado