Class DataSourceSheetFilter
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Fuentede datosHojaFiltro
Acceder a un filtro de hoja de la fuente de datos existente y modificarlo Para crear un nuevo filtro de hoja de fuente de datos, usa DataSourceSheet.addFilter(columnName, filterCriteria)
.
Solo usa esta clase con datos conectados a una base de datos.
Documentación detallada
getDataSourceColumn()
Devuelve la columna de la fuente de datos a la que se aplica este filtro.
Volver
DataSourceColumn
: Es la columna de la fuente de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceSheet()
Muestra el DataSourceSheet
al que pertenece este filtro.
Volver
DataSourceSheet
: Es la hoja de la fuente de datos a la que pertenece este filtro.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilterCriteria()
Muestra los criterios de filtro de este filtro.
Volver
FilterCriteria
: Son los criterios de filtro de este filtro.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
remove()
Quita este filtro del objeto de la fuente de datos.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFilterCriteria(filterCriteria)
Establece los criterios de filtro para este filtro.
Parámetros
Nombre | Tipo | Descripción |
filterCriteria | FilterCriteria | Los criterios de filtro que se establecerán. |
Volver
DataSourceSheetFilter
: Es el filtro para encadenar.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003e\u003ccode\u003eDataSourceSheetFilter\u003c/code\u003e allows you to access and modify existing filters applied to data source sheets connected to databases.\u003c/p\u003e\n"],["\u003cp\u003eYou can get information about the filter, such as the column it applies to, the sheet it belongs to, and its criteria.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to remove the filter and to set new filter criteria.\u003c/p\u003e\n"],["\u003cp\u003eThis class is exclusively for data connected to a database and is not intended for regular spreadsheet data.\u003c/p\u003e\n"],["\u003cp\u003eAll methods within \u003ccode\u003eDataSourceSheetFilter\u003c/code\u003e require authorization with specific scopes related to spreadsheet access.\u003c/p\u003e\n"]]],["`DataSourceSheetFilter` allows interaction with existing filters on database-connected data. Key actions include: retrieving the associated data source column, sheet, and filter criteria using `getDataSourceColumn()`, `getDataSourceSheet()`, and `getFilterCriteria()`, respectively. Filters can be removed with `remove()` or modified using `setFilterCriteria()`. Creating new filters requires `DataSourceSheet.addFilter`. All methods necessitate specific authorization scopes related to spreadsheets.\n"],null,["# Class DataSourceSheetFilter\n\nDataSourceSheetFilter\n\nAccess and modify an existing data source sheet filter. To create a new data source sheet filter,\nuse [DataSourceSheet.addFilter(columnName, filterCriteria)](/apps-script/reference/spreadsheet/data-source-sheet#addFilter(String,FilterCriteria)).\n\n\n**Only use this class with data that's connected to a database.** \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [getDataSourceColumn()](#getDataSourceColumn()) | [DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) | Returns the data source column this filter applies to. |\n| [getDataSourceSheet()](#getDataSourceSheet()) | [DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) | Returns the [DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) that this filter belongs to. |\n| [getFilterCriteria()](#getFilterCriteria()) | [FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) | Returns the filter criteria for this filter. |\n| [remove()](#remove()) | `void` | Removes this filter from the data source object. |\n| [setFilterCriteria(filterCriteria)](#setFilterCriteria(FilterCriteria)) | [DataSourceSheetFilter](#) | Sets the filter criteria for this filter. |\n\nDetailed documentation\n----------------------\n\n### `get``Data``Source``Column()`\n\nReturns the data source column this filter applies to.\n\n#### Return\n\n\n[DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) --- The data source column.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Data``Source``Sheet()`\n\nReturns the [DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) that this filter belongs to.\n\n#### Return\n\n\n[DataSourceSheet](/apps-script/reference/spreadsheet/data-source-sheet) --- The data source sheet, to which this filter belongs.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `get``Filter``Criteria()`\n\nReturns the filter criteria for this filter.\n\n#### Return\n\n\n[FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) --- The filter criteria for this filter.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `remove()`\n\nRemoves this filter from the data source object.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`\n\n*** ** * ** ***\n\n### `set``Filter``Criteria(filterCriteria)`\n\nSets the filter criteria for this filter.\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------------|----------------------------------------------------------------------|-----------------------------|\n| `filter``Criteria` | [FilterCriteria](/apps-script/reference/spreadsheet/filter-criteria) | The filter criteria to set. |\n\n#### Return\n\n\n[DataSourceSheetFilter](#) --- The filter for chaining.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/spreadsheets.currentonly`\n- `https://www.googleapis.com/auth/spreadsheets`"]]