Usar funções de pasta de trabalho do Excel com o Microsoft GraphUse workbook functions in Excel with Microsoft Graph

Você pode usar qualquer função de pasta de trabalho com a seguinte sintaxe: POST /workbook/functions/{function-name}.You can invoke any workbook function by using the following syntax: POST /workbook/functions/{function-name}. Forneça o(s) argumento(s) de função no corpo usando um objeto JSON.You provide the function argument(s) in the body using a JSON object. O value resultante da função e quaisquer cadeias de caracteres error são retornados no objeto de resultado da função.The function's resulting value and any error strings are returned in the function result object. O valor error de null indica a execução bem-sucedida da função.The error value of null indicates successful execution of the function.

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.The complete list of supported functions are listed here. Refer to the function signature for specific parameter names and data types.

Observações importantes:Important notes:

  • O parâmetro de entrada do intervalo é fornecido usando um objeto range, em vez da cadeia de caracteres de endereço do intervalo.The range input parameter is supplied using a range object instead of the range address string.
  • O parâmetro index é indexado como 1, diferentemente do índice 0 usado na maioria das APIs.The index parameter is 1-indexed unlike the 0-index used in most of the APIs.

Exemplo: vlookupExample: vlookup

Em uma planilha do Excel, a função vlookup utiliza os seguintes argumentos:In an Excel spreadsheet, the vlookup function takes the following arguments:

  1. valor_proc (obrigatório): o valor que você deseja pesquisar.lookup_value (required) The value you want to look up.
  2. matriz_tabela (obrigatório): o intervalo de células em que se encontra o valor a pesquisar.table_array (required) The range of cells where the lookup value is located. Lembre-se de que o valor de pesquisa sempre deve estar na primeira coluna no intervalo para que o PROCV funcione corretamente.Remember that the lookup value should always be in the first column in the range for VLOOKUP to work correctly. Por exemplo, se o valor de pesquisa estiver na célula C2, o intervalo deve começar com C.For example, if your lookup value is in cell C2 then your range should start with C.
  3. núm_índice_coluna (obrigatório): o número da coluna no intervalo que contém o valor de retorno.col_index_num (required) The column number in the range that contains the return value. 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.For example, if you specify B2: D11 as the range, you should count B as the first column, C as the second, and so on.
  4. procurar_intervalo (opcional): o valor lógico que especifica se você deseja que PROCV localize uma correspondência exata ou aproximada.range_lookup (optional) The logical value that specifies whether you want VLOOKUP to find an approximate or an exact match. Especifique VERDADEIRO se desejar uma correspondência aproximada ou FALSO se desejar uma correspondência exata do valor de retorno.Specify TRUE if you want an approximate match or FALSE if you want an exact match of the return value. Se você não especificar nada, o valor padrão sempre será TRUE ou uma correspondência aproximada.If you don't specify anything, the default value will always be TRUE or approximate match.

Dentro de uma célula, a função vlookup tem esta aparência:Inside a cell, the vlookup function looks like this:

= 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)=VLOOKUP(lookup value, range containing the lookup value, the column number in the range containing the return value, optionally specify TRUE for approximate match or FALSE for an exact match)

(Confira a documentação para a função do Excel PROCV).(See the documentation for the VLOOKUP Excel function.)

Solicitação:Request:

O seguinte exemplo mostra como chamar a função vlookup e passar esses parâmetros com a API REST do Excel.The following example shows how to call the vlookup function and pass these parameters with the Excel REST API.

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
}
RespostaResponse
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: medianExample: median

Em uma planilha do Excel, a função median possui uma matriz de um ou mais intervalos de entrada.In an Excel spreadsheet, the median function takes an array of one or more input ranges.

Dentro de uma célula, a função median se parece com este exemplo:Inside a cell, the median function looks like this example:

=MED(A2:A6)=MEDIAN(A2:A6)

(Confira a documentação para a função MED).(See the documentation for the MEDIAN Excel function.)

SolicitaçãoRequest

O seguinte exemplo mostra como chamar a função median e um ou mais intervalos de entrada com a API REST do Excel.The following example shows how to call the median function and one or more input ranges with the Excel REST API.

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" },
      ]
}
RespostaResponse
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
}

Confira tambémSee also