Tipo de recurso Workbook

Artículo
03/16/2023

Espacio de nombres: microsoft.graph

El objeto de nivel superior que contiene los objetos de libro relacionados, como hojas de cálculo, tablas e intervalos.

Métodos

Método	Tipo de valor devuelto	Descripción
Crear	workbookSessionInfo	Crear una sesión de libro para iniciar una sesión persistente o no persistente.
Cerrar sesión	Ninguna	Cerrar una sesión existente.
Actualizar sesión	Ninguna	Actualizar una sesión existente.

Propiedades

Ninguna.

Relaciones

Relación	Tipo	Descripción
comments	workbookComment (colección)	Representa una colección de comentarios en un libro.
names	Colección workbookNamedItem	Representa una colección de libros con ámbito de elementos con nombre (intervalos y constantes con nombre). Solo lectura.
operations	Colección workbookOperation	El estado de las operaciones del libro. No se admite la obtención de una colección de operaciones, pero puede obtener el estado de operaciones de larga duración si el encabezado `Location` se devuelve en la respuesta. Solo lectura.
tables	Colección workbookTable	Representa una colección de tablas asociadas con el libro. Solo lectura.
worksheets	Colección workbookWorksheet	Representa una colección de hojas de cálculo asociadas con el libro. Solo lectura.

Funciones

Funciones de Excel: Para invocar una función de libro, use la sintaxis POST /me/drive/root/workbook/functions/{function-name} y proporcione los argumentos de la función en el cuerpo mediante un objeto JSON. Las cadenas value y error resultantes de la función se devuelven en el objeto de resultado de la función. El valor error de null indica que la función se ha ejecutado correctamente.

La lista completa de funciones admitidas se encuentra aquí. Consulte la firma de la función para obtener tipos de datos y nombres de parámetros específicos.

Notas importantes:

El parámetro de entrada de intervalo se suministra mediante un objeto range en lugar de la cadena de dirección de intervalo.
El parámetro de índice es “1 indexado”, a diferencia del “índice 0” usado en la mayoría de las API.

Ejemplo: BUSCARV

En una hoja de cálculo de Excel, la función vlookup admite estos argumentos:

El valor que quiere buscar, también llamado el valor de búsqueda.
El rango donde se encuentra el valor de búsqueda. Recuerde que el valor de búsqueda siempre tiene que estar en la primera columna del rango para que BUSCARV funcione correctamente. Por ejemplo, si el valor de búsqueda se encuentra en la celda C2, el rango tiene que empezar con C.
El número de columna en el rango que contiene el valor devuelto. Por ejemplo, si especifica B2:D11 como el rango, B será la primera columna, C la segunda, etc.
De forma opcional, puede especificar VERDADERO si quiere obtener una coincidencia aproximada, o bien FALSO si quiere obtener una coincidencia exacta del valor devuelto. Si no especifica nada, el valor predeterminado será siempre VERDADERO o coincidencia aproximada.

Dentro de una celda, la función vlookup es similar a esta:

= BUSCARV(valor de búsqueda, rango que contiene el valor de búsqueda, el número de columna en el rango que contiene el valor devuelto, de forma opcional, especifique VERDADERO para obtener una coincidencia aproximada o FALSO para una coincidencia exacta)

(Vea la documentación de la Función de Excel BUSCARV).

En el ejemplo siguiente, se muestra cómo realizar una llamada a la función vlookup y pasar estos parámetros con la API de REST de Excel.

Solicitud:

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
}

Respuesta:

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"
}

Ejemplo: median

En una hoja de cálculo de Excel, la función median admite una matriz de uno o más rangos de entrada.

Dentro de una celda, la función median es similar a este ejemplo:

=MEDIANA(A2:A6)

(Vea la documentación de la Función de Excel MEDIANA).

En el ejemplo siguiente, se muestra cómo realizar una llamada a la función median y uno o más rangos de entrada con la API de REST de Excel.

Solicitud:

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

Respuesta:

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
}

Representación JSON

{
  "names": [{"@odata.type": "microsoft.graph.workbookNamedItem"}],
  "tables": [{"@odata.type": "microsoft.graph.workbookTable"}],
  "worksheets": [{"@odata.type": "microsoft.graph.workbookWorksheet"}]
}

Compartir a través de