Получение именованных диапазонов в рабочей книге Excel – Aspose.Cells Cloud API

Этот REST API возвращает информацию об именованных диапазонах, определённых внутри рабочих листов.

Введение – Именованный диапазон — это определяемый пользователем идентификатор, ссылающийся на конкретную ячейку или блок ячеек в рабочем листе. Именованные диапазоны упрощают создание формул, повышают читаемость и обеспечивают программный доступ к часто используемым областям рабочей книги.

Необходимые условия – Доступ к облачному API Aspose.Cells требует действительного JWT-токена. Получите токен, пройдя аутентификацию с помощью идентификатора клиента и секрета клиента Aspose Cloud через точку входа OAuth 2.0. Включайте токен в заголовок Authorization: Bearer <jwt token> каждого запроса.

API GetNamedRanges

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/ranges

Безопасность и аутентификация

Облачные API Aspose.Cells защищены и требуют аутентификации по JWT-токену.

Параметры запроса

Имя параметра	Тип	Расположение	Описание
name	string	Path	Имя документа Excel.
folder	string	Query string	Папка, содержащая документ.
storageName	string	Query string	Имя хранилища, в котором находится документ.

Коды HTTP-статуса

Код	Значение	Описание
200	OK (ОК)	Фильтр успешно применён; ответ содержит детали операции.
400	Bad Request (Неверный запрос)	Отсутствуют или недопустимы параметры (например, неподдерживаемый тип файла).
401	Unauthorized (Неавторизован)	Недействительный или отсутствующий JWT-токен.
413	Payload Too Large (Слишком большой полезный объект)	Загруженный файл превышает лимит размера.
500	Internal Server Error (Внутренняя ошибка сервера)	Непредвиденная ошибка сервера.

Спецификация OpenAPI определяет публично доступное программное интерфейсное описание, позволяющее выполнять взаимодействие REST напрямую из веб-браузера.

Вы можете использовать утилиту командной строки cURL для вызова веб-сервисов Aspose.Cells. Пример ниже демонстрирует, как получить именованные диапазоны с помощью cURL.

Запрос

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/ranges" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Ответ

{
  "Ranges": {
    "RangeList": [
      {
        "ColumnCount": 7,
        "ColumnWidth": 8.428571428571429,
        "FirstColumn": 1,
        "FirstRow": 9,
        "Name": "data",
        "RefersTo": "=Sheet1!$B$10:$H$10",
        "RowCount": 1,
        "RowHeight": 15,
        "Worksheet": "Sheet1"
      }
    ]
  },
  "Code": 200,
  "Status": "OK"
}

Модель ответа

Поле	Тип	Описание
`ColumnCount`	integer	Количество столбцов в диапазоне.
`ColumnWidth`	number	Ширина каждого столбца (в пунктах).
`FirstColumn`	integer	Индекс первого столбца в диапазоне (начиная с 0).
`FirstRow`	integer	Индекс первой строки в диапазоне (начиная с 0).
`Name`	string	Пользовательское имя диапазона.
`RefersTo`	string	Формула, определяющая ссылку на ячейку (например, `=Sheet1!$B$10:$H$10`).
`RowCount`	integer	Количество строк в диапазоне.
`RowHeight`	number	Высота каждой строки (в пунктах).
`Worksheet`	string	Имя рабочего листа, содержащего диапазон.

Семейство облачных SDK

Использование SDK — самый быстрый способ интеграции этой функциональности. SDK обрабатывают детали низкого уровня, позволяя вам сосредоточиться на бизнес-логике. Полный список облачных SDK Aspose.Cells см. в репозитории на GitHub.

Примеры кода ниже демонстрируют вызов веб-сервисов Aspose.Cells с использованием различных SDK:

Получение данных ячеек по именованному диапазону