tipo de recurso da pasta de trabalho

Artigo
07/31/2024

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.

Contém objetos de livro relacionados, como folhas de cálculo, tabelas, intervalos, etc.

Métodos

Método	Tipo de retorno	Descrição
Criar	workbookSessionInfo	Crie uma sessão de pasta de trabalho para iniciar uma sessão persistente ou não persistente.
Fechar sessão	Nenhum(a)	Fechar uma sessão existente.
Atualizar sessão	Nenhum(a)	Atualizar uma sessão existente.

Propriedades

Nenhum.

Relações

Relação	Tipo	Descrição
names	coleção workbookNamedItem	Representa uma coleção de livros no âmbito de itens nomeados (intervalos nomeados e constantes). Somente leitura.
tables	coleção WorkbookTable	Representa uma coleção de tabelas associadas à pasta de trabalho. Somente leitura.
worksheets	coleção WorkbookWorksheet	Representa uma coleção de planilhas associadas à pasta de trabalho. Somente leitura.
workbbookApplication	workbookApplication	Representa o livro do ExcelAplicação que gere o livro.
operações	coleção workbookOperation	O estado das operações do Livro. Não há suporte para a obtenção de uma coleção de operações, mas você pode obter o status de uma operação de longa execução se o cabeçalho `Location` retornar na resposta. Somente leitura. Anulável.

Funções

Funções do Excel: Invoque uma função de pasta de trabalho usando a sintaxe POST /me/drive/root/workbook/functions/{function-name} e fornecendo os argumentos de função no corpo usando um objeto JSON. O value resultante da função e quaisquer cadeias de caracteres error são retornados no objeto de resultado de função. O valor error de null indica a execução bem-sucedida da função.

A lista completa de funções com suporte está listada aqui. Confira a assinatura de função para tipos de dados e nomes de parâmetro específicos.

Observações importantes:

O parâmetro de entrada do intervalo é fornecido usando um objeto range, em vez da cadeia de caracteres de endereço do intervalo.
O parâmetro index é indexado como 1, diferentemente do índice 0 usado na maioria das APIs.

Exemplo: vlookup

Em uma planilha do Excel, a função vlookup utiliza os seguintes argumentos:

O valor que você deseja pesquisar, também chamado de valor de pesquisa.
O intervalo em que o valor de pesquisa está localizado. Lembre-se de que o valor de pesquisa sempre deve estar na primeira coluna no intervalo para que o PROCV funcione corretamente. Por exemplo, se o valor de pesquisa estiver na célula C2, o intervalo deve começar com C.
O número da coluna no intervalo que contém o valor de retorno. Por exemplo, se você especificar B2: D11 como o intervalo, deverá contar B como a primeira coluna, C como a segunda e assim por diante.
Opcionalmente, você pode especificar TRUE se desejar uma correspondência aproximada ou FALSE se desejar uma correspondência exata do valor de retorno. Se você não especificar nada, o valor padrão sempre será TRUE ou uma correspondência aproximada.

Dentro de uma célula, a função vlookup tem esta aparência:

= PROCV(valor de pesquisa, intervalo que contém o valor de pesquisa, o número da coluna no intervalo que contém o valor de retorno, opcionalmente, TRUE para coincidência aproximada ou FALSE para uma correspondência exata)

(Confira a documentação para a função do Excel PROCV).

O exemplo abaixo mostra como chamar a função vlookup e passar esses parâmetros com a API REST do Excel. Solicitação:

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/vlookup
content-type: Application/Json 
authorization: Bearer {access-token} 
workbook-session-id: {session-id}

{
    "lookupValue": "Temperature",
    "tableArray": { "Address": "Sheet1!E1:G5" },
    "colIndexNum": 2,
    "rangeLookup": false
}

Resposta:

HTTP code: 200 OK
content-type: application/json;odata.metadata 

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
    "@odata.type": "#microsoft.graph.workbookFunctionResult",
    "@odata.id": "/users('f6d92604-4b76-4b70-9a4c-93dfbcc054d5')/drive/root/workbook/functions/vlookup()",
    "error": null,
    "value": "28.3"
}

Exemplo: median

Em uma planilha do Excel, a função median possui uma matriz de um ou mais intervalos de entrada.

Dentro de uma célula, a função median se parece com este exemplo:

=MED(A2:A6)

(Confira a documentação para a função MED).

O exemplo abaixo mostra como chamar a função median e um ou mais intervalos de entrada com a API REST do Excel.

Solicitação:

POST https://graph.microsoft.com/beta/me/drive/root:/book1.xlsx:/workbook/functions/median
content-type: Application/Json 
authorization: Bearer {access-token} 
workbook-session-id: {session-id}

{
   "values":[
      {
         "address":"Sheet2!A1:A5"
      },
      {
         "address":"Sheet2!B1:B5"
      }
   ]
}

Resposta:

HTTP code: 200 OK
content-type: application/json;odata.metadata 

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#workbookFunctionResult",
  "@odata.type": "#microsoft.graph.workbookFunctionResult",
  "@odata.id": "/users('2abcad6a-2fca-4b6e-9577-e358a757d77d')/drive/root/workbook/functions/median()",
  "error": null,
  "value": 30
}

Representação JSON

{
    "id": "string"
}

Compartilhar via