Compartilhar via

Utilizar funções de livro no Excel

Pode utilizar as funções do livro no Excel com o Microsoft Graph para invocar qualquer função de livro com a seguinte sintaxe: POST /me/drive/root/workbook/functions/{function-name}. Pode fornecer os argumentos da função no corpo com 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.

Para obter uma lista completa das funções suportadas, consulte Excel.Functions class (Classe Excel.Functions). Confira a assinatura de função para tipos de dados e nomes de parâmetro específicos.

Importante

  • 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:

  • lookup_value (obrigatório): o valor que pretende procurar.

  • table_array (obrigatório): o intervalo de células onde o valor de pesquisa está localizado. Lembre-se de que o valor de pesquisa deve estar sempre na primeira coluna do intervalo para que a função PROCV funcione corretamente. Por exemplo, se o valor de pesquisa estiver na célula C2, o intervalo deve começar com C.

  • col_index_num (obrigatório): o número da coluna no intervalo que contém o valor devolvido. 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.

  • range_lookup (opcional): o valor lógico que especifica se pretende que a função PROCV encontre uma correspondência aproximada ou exata. Especifique VERDADEIRO se desejar uma correspondência aproximada ou FALSO se desejar uma correspondência exata do valor de retorno. Se não especificar nada, o valor predefinido será sempre VERDADEIRO ou uma correspondência aproximada.

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

=VLOOKUP(valor de pesquisa, intervalo que contém o valor de pesquisa, o número da coluna no intervalo que contém o valor devolvido, especifique opcionalmente VERDADEIRO para correspondência aproximada ou FALSO para uma correspondência exata)

Para obter mais informações, veja a documentação da função PROCV do Excel.

Solicitação

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

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:

=MEDIAN(A2:A6)

Para obter mais informações, veja a documentação da função MEDIANA do Excel.

Solicitação

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

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
}

Conteúdo relacionado

  • Last updated on