Method: spreadsheets.values.batchGetByDataFilter

Возвращает один или несколько диапазонов значений, соответствующих указанным фильтрам данных. Дополнительную информацию см. в разделе «Чтение, запись и поиск метаданных» .

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

HTTP-запрос

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

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

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

Параметры
spreadsheetId

string

Идентификатор электронной таблицы, из которой нужно извлечь данные.

Текст запроса

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

JSON-представление 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
Поля
dataFilters[]

object ( DataFilter )

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

majorDimension

enum ( Dimension )

Основной параметр, который следует использовать в результатах.

Например, если данные в электронной таблице: A1=1,B1=2,A2=3,B2=4 , то запрос, который выбирает этот диапазон и устанавливает majorDimension=ROWS возвращает [[1,2],[3,4]] , тогда как запрос, который устанавливает majorDimension=COLUMNS возвращает [[1,3],[2,4]] .

valueRenderOption

enum ( ValueRenderOption )

Способ представления значений в выходных данных. Параметр рендеринга по умолчанию — FORMATTED_VALUE .

dateTimeRenderOption

enum ( DateTimeRenderOption )

Способ отображения дат, времени и продолжительности в выходных данных. Этот параметр игнорируется, если valueRenderOption имеет значение FORMATTED_VALUE . Параметр отображения даты и времени по умолчанию — SERIAL_NUMBER .

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

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

В случае успеха тело ответа будет содержать данные следующей структуры:

JSON-представление 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
Поля
spreadsheetId

string

Идентификатор электронной таблицы, из которой были получены данные.

valueRanges[]

object ( MatchedValueRange )

Запрошенные значения вместе со списком соответствующих им фильтров данных.

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

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

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

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

MatchedValueRange

Диапазон значений, которому соответствовал один или несколько источников данных.

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

object ( ValueRange )

Значения, соответствующие данным, найденным с помощью DataFilter .

dataFilters[]

object ( DataFilter )

Фильтры DataFilters из запроса, соответствующие диапазону значений.