Тип ресурса workbookWorkbook resource type

Workbook — это объект верхнего уровня, содержащий связанные объекты книг, например листы, таблицы, диапазоны и т. д.Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc.

Представление в формате JSONJSON representation

Ниже показано представление JSON ресурса.Here is a JSON representation of the resource

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

СвойстваProperties

НетNone

МетодыMethods

МетодMethod Возвращаемый типReturn Type ОписаниеDescription
Create SessionCreate Session workbookSessionInfoworkbookSessionInfo Создание сеанса книги для запуска сохраняемого или несохраняемого сеанса.Create a workbook session to start a persistent or non-persistent session.
Close SessionClose Session НетNone Закрытие существующего сеанса.Close an existing session.
Refresh SessionRefresh Session НетNone Обновление существующего сеанса.Refresh an existing session.

СвязиRelationships

ОтношениеRelationship ТипType ОписаниеDescription
namesnames Коллекция WorkbookNamedItemWorkbookNamedItem collection Представляет коллекцию именованных элементов в книге (именованные диапазоны и константы). Только для чтения.Represents a collection of workbook scoped named items (named ranges and constants). Read-only.
tablestables Коллекция WorkbookTableWorkbookTable collection Представляет коллекцию таблиц, сопоставленных с книгой. Только для чтения.Represents a collection of tables associated with the workbook. Read-only.
worksheetsworksheets Коллекция WorkbookWorksheetWorkbookWorksheet collection Представляет коллекцию листов, сопоставленных с книгой. Только для чтения.Represents a collection of worksheets associated with the workbook. Read-only.

ФункцииFunctions

Функции Excel: вызов функции книги с использованием синтаксиса POST /workbook/functions/{function-name} и предоставление аргументов функции в основном тексте с помощью объекта JSON. Результирующее value функции и любые строки error возвращаются в объекте результата функции. Если значение error равно null, это свидетельствует об успешном выполнении функции.Excel functions: Invoke a workbook function using the syntax POST /workbook/functions/{function-name} and providing the function argument(s) in the body using a JSON object. The function's resulting value and any error strings are returned in the function result object. The error value of null indicates successful execution of the function.

Полный список поддерживаемых функций см. здесь. Имена определенных параметров и типы данных см. в сигнатуре функции.The complete list of supported functions are listed here. Refer to the function signature for specific parameter names and data types.

Важные примечания.Important notes:

  • Входной параметр range предоставляется с использованием объекта range вместо строки адреса range.The range input parameter is supplied using a range object instead of the range address string.
  • Параметр index индексируется с 1, а не с 0, как в большинстве API.The index parameter is 1-indexed unlike the 0-index used in most of the APIs.

Пример: vlookup.Example: vlookup

В электронной таблице Excel функция vlookup принимает следующие аргументы:In an Excel spreadsheet, the vlookup function takes the following arguments:

  1. Значение, которое вы хотите найти. Его также называют искомым значением.The value you want to look up, also called the lookup value.
  2. Диапазон, в котором находится искомое значение.The range where the lookup value is located. Помните, что искомое значение должно находиться всегда в первом столбце в диапазоне ВПР. В ином случае его обработка не будет выполняться правильно.Remember that the lookup value should always be in the first column in the range for VLOOKUP to work correctly. Например, если искомое значение находится в ячейке C2, диапазон должен начинаться с C.For example, if your lookup value is in cell C2 then your range should start with C.
  3. Номер столбца в диапазоне, который содержит возвращаемое значение.The column number in the range that contains the return value. Например, если вы укажете в качестве диапазона B2:D11, B будет первым столбцом, C — вторым и т. д. 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. При желании вы можете указать TRUE, если нужно приблизительное совпадение, и FALSE, если нужно точное совпадение возвращаемого значения.Optionally, you can specify TRUE if you want an approximate match or FALSE if you want an exact match of the return value. Если вы ничего не укажете, значением по умолчанию будет TRUE (приблизительное совпадение).If you don't specify anything, the default value will always be TRUE or approximate match.

В ячейке функция vlookup выглядит так:Inside a cell, the vlookup function looks like this:

=ВПР(искомое значение, диапазон с искомым значением, номер столбца в диапазоне с возвращаемым значением, необязательное значение TRUE для указания приблизительного значения или FALSE для указания точного совпадения)=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)

(См. документацию по функции ВПР в Excel.)(See the documentation for the VLOOKUP Excel function.)

В приведенном ниже примере показано, как вызывать функцию vlookup и передавать эти параметры с помощью REST API для Excel.The example below shows how to call the vlookup function and pass these parameters with the Excel REST API.

Запрос:Request:

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
}

Отклик:Response:

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

Пример: median.Example: median

В электронной таблице Excel функция median принимает массив одного или нескольких диапазонов входных значений.In an Excel spreadsheet, the median function takes an array of one or more input ranges.

В ячейке функция median выглядит так, как показано в этом примере:Inside a cell, the median function looks like this example:

=МЕДИАНА(A2:A6)=MEDIAN(A2:A6)

(См. документацию по функции МЕДИАНА в Excel.)(See the documentation for the MEDIAN Excel function.)

В приведенном ниже примере показано, как вызывать функцию median и один или несколько диапазонов входных значений с помощью REST API для Excel.The example below shows how to call the median function and one or more input ranges with the Excel REST API.

Запрос:Request:

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

Отклик:Response:

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
}