Method: spreadsheets.getByDataFilter

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

Этот метод отличается от метода Spreadsheets.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

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

Тело ответа

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

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

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

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

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