Тип ресурса workbook

Статья
03/26/2023

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Содержит связанные объекты книги, такие как листы, таблицы, диапазоны и т. д.

Методы

Метод	Возвращаемый тип	Описание
Создание	workbookSessionInfo	Создание сеанса книги для запуска сохраняемого или несохраняемого сеанса.
Close session	Нет	Закрытие существующего сеанса.
Refresh session	Нет	Обновление существующего сеанса.

Свойства

Нет

Связи

Связь	Тип	Описание
names	Коллекция workbookNamedItem	Представляет коллекцию книг с областью именованных элементов (именованные диапазоны и константы). Только для чтения.
tables	Коллекция workbookTable	Представляет коллекцию таблиц, сопоставленных с книгой. Только для чтения.
worksheets	Коллекция workbookWorksheet	Представляет коллекцию листов, сопоставленных с книгой. Только для чтения.
workbbookApplication	workbookApplication	Представляет книгу ExcelApplication, которая управляет книгой.
operations	Коллекция workbookOperation	Состояние операций с книгами. Получить коллекцию операций нельзя, но можно получить состояние длительной операции, если в ответе возвращается заголовок `Location`. Только для чтения. Допускается значение null.

Функции

Функции Excel: Вызов функции книги с использованием синтаксиса POST /me/drive/root/workbook/functions/{function-name} и предоставление аргументов функции в теле с помощью объекта JSON. Результирующее value функции и любые строки error возвращаются в объекте результата функции. Если значение error равно null, это свидетельствует об успешном выполнении функции.

Полный список поддерживаемых функций см. здесь. Имена определенных параметров и типы данных см. в сигнатуре функции.

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

Входной параметр range предоставляется с использованием объекта range вместо строки адреса range.
Параметр index индексируется с 1, а не с 0, как в большинстве API.

Пример: vlookup.

В электронной таблице Excel функция vlookup принимает следующие аргументы:

Значение, которое вы хотите найти. Его также называют искомым значением.
Диапазон, в котором находится искомое значение. Помните, что искомое значение должно находиться всегда в первом столбце в диапазоне ВПР. В ином случае его обработка не будет выполняться правильно. Например, если искомое значение находится в ячейке C2, диапазон должен начинаться с C.
Номер столбца в диапазоне, который содержит возвращаемое значение. Например, если вы укажете в качестве диапазона B2:D11, B будет первым столбцом, C — вторым и т. д.
При желании вы можете указать TRUE, если нужно приблизительное совпадение, и FALSE, если нужно точное совпадение возвращаемого значения. Если вы ничего не укажете, значением по умолчанию будет TRUE (приблизительное совпадение).

В ячейке функция vlookup выглядит так:

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

(См. документацию по функции ВПР в Excel.)

В приведенном ниже примере показано, как вызывать функцию vlookup и передавать эти параметры с помощью REST API для 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
}

Отклик:

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.

В электронной таблице Excel функция median принимает массив одного или нескольких диапазонов входных значений.

В ячейке функция median выглядит так, как показано в этом примере:

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

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

В приведенном ниже примере показано, как вызывать функцию median и один или несколько диапазонов входных значений с помощью REST API для 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"
      }
   ]
}

Отклик:

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
}

Представление JSON

{
    "id": "string"
}

Поделиться через