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,
  "excludeTablesInBandedRanges": boolean
}
Поля
dataFilters[]

object ( DataFilter )

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

includeGridData

boolean

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

excludeTablesInBandedRanges

boolean

Значение True, если таблицы следует исключать из диапазонов. Значение False, если значение не задано.

Ответный текст

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

Области полномочий

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

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

Для получения более подробной информации см. руководство по авторизации .