sheets.filter Object

Defines the filtering criteria for this sheet, if any.

sheets.filter.columns Array

An array defining the filter configuration of individual columns.

sheets.filter.columns.criteria Array

An array of filter criteria for custom filters.

sheets.filter.columns.criteria.operator String

The criterion operator type.

Supported types vary based on the inferred column data type (inferred):

  • Text
    • contains - the text contains the value
    • doesnotcontain - text does not contain the value
    • startswith - text starts with the value
    • endswith - text ends with the value
  • Date
    • eq - date is the same as the value
    • neq - date is not the same as the value
    • lt - date is before the value
    • gt - date is after the value
  • Number
    • eq - is equal to the value
    • neq - is not equal to the value
    • gte - is greater than or equal to the value
    • gt - is greater than the value
    • lte - is less than or equal to the value
    • lt - is less than the value

sheets.filter.columns.criteria.value String

The value for the criteria operator.

sheets.filter.columns.filter String

The filter to apply to this column.

The supported filters are:

  • value - filters based on unique values
  • custom - applies custom filtering criteria
  • top - filters the top or bottom records
  • dynamic - filters based on dynamic criteria

sheets.filter.columns.index Number

The index of the column relative to the filter range.

sheets.filter.columns.logic String

The logical operator to apply to filter criteria.

Possible values are and, or.

sheets.filter.columns.type String

The filter sub-type, if any.

Applicable types according to the main filter.

  • top
    • topNumber
    • topPercent
    • bottomNumber
    • bottomPercent
  • dynamic
    • aboveAverage
    • belowAverage
    • tomorrow
    • today
    • yesterday
    • nextWeek
    • thisWeek
    • lastWeek
    • nextMonth
    • thisMonth
    • lastMonth
    • nextQuarter
    • thisQuarter
    • lastQuarter
    • nextYear
    • thisYear
    • lastYear
    • yearToDate

sheets.filter.columns.value Number|String|Date

The filter value for filters that require a single value, e.g. "top".

sheets.filter.columns.values Array

The filter values for filters that support multiple values.

sheets.filter.ref String

The active range for the filter, e.g. "B1:D8".

In this article
Not finding the help you need? Improve this article