Method: spreadsheets.getByDataFilter

Возвращает электронную таблицу с заданным идентификатором. Вызывающий должен указать идентификатор электронной таблицы.

Этот метод отличается от крупноформатных таблиц.get тем, что он позволяет выбирать, какие подмножества данных электронной таблицы возвращать, указав параметр dataFilters . Можно указать несколько DataFilters . Указание одного или нескольких фильтров данных возвращает части электронной таблицы, которые пересекают диапазоны, соответствующие любому из фильтров.

По умолчанию данные в сетках не возвращаются. Вы можете включить данные сетки одним из двух способов:

  • Укажите маску поля , в которой перечислены нужные поля, используя параметр URL-адреса fields в HTTP.

  • Установите для параметра includeGridData значение true. Если установлена ​​маска поля, параметр includeGridData игнорируется.

Для больших электронных таблиц рекомендуется извлекать только нужные поля электронной таблицы.

HTTP-запрос

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
spreadsheetId

string

Электронная таблица для запроса.

Тело запроса

Тело запроса содержит данные со следующей структурой:

Представление JSON
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean
}
Поля
dataFilters[]

object ( DataFilter )

DataFilters , используемые для выбора диапазонов для извлечения из электронной таблицы.

includeGridData

boolean

Истинно, если должны быть возвращены данные сетки. Этот параметр игнорируется, если в запросе была задана маска поля.

Тело ответа

В случае успеха тело ответа содержит экземпляр Spreadsheet .

Области авторизации

Требуется одна из следующих областей действия OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Дополнительные сведения см. в руководстве по авторизации .