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 . Параметр рендеринга dateTime по умолчанию — 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 из запроса, соответствующие диапазону значений.