此页面由 Cloud Translation API 翻译。

过滤

通过过滤器，您可以对查看报告时看到的数据进行排序和过滤电子表格。过滤器不会更改电子表格中的数据值。您可以使用过滤器暂时隐藏信息或对信息进行排序。与指定的过滤条件不会显示出来，而。借助过滤视图，您还可以保存并随时在它们之间切换。

以下是过滤器的一些用例：

按特定列对数据进行排序。例如，将用户记录按最后一项排序名称。
隐藏符合特定条件的数据。例如，隐藏所有记录 2 年以上。
隐藏与特定值匹配的数据。例如，隐藏所有问题状态为“已关闭”。

基本过滤条件

通过 BasicFilter 是默认过滤器，此过滤器会在任何人查看电子表格。每个电子表格可以有一个基本过滤条件工作表。您可以按以下步骤关闭基本过滤器：清除它。此操作会从电子表格中移除该过滤器及其所有设置。如果要重新启用相同的过滤器，必须重新设置条件。

管理基本过滤条件

要设置或清除基本过滤条件，请使用 spreadsheets.batchUpdate 方法：

如需设置基本过滤条件，请使用 SetBasicFilterRequest 方法。
如需清除基本过滤条件，请使用 ClearBasicFilterRequest 方法。

要列出基本过滤器，请使用 spreadsheets.get 方法和将 fields 网址参数设为 sheets/basicFilter。以下 spreadsheets.get 代码示例显示了包含字段的 Google 表格网址 mask：

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?fields=sheets/basicFilter)

过滤视图

FilterView 是一个已命名的过滤器，您可以随时关闭和打开它。电子表格可以有多个过滤视图，但一次只能应用一个。

以下是过滤视图的一些用例：

您有几个不同的过滤条件，希望在选择和查看数据
您没有电子表格的编辑权限，但仍想将过滤。在这种情况下，您可以创建对您可见。
您希望所有电子表格的共享对象都查看数据。您可以通过提供 spreadsheetId和 filterViewId。为此，请使用 filterViewId 返回的值。

以下代码示例展示了包含过滤视图的 Google 表格网址：
```
https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit#gid=0&fvid=FILTER_VIEW_ID
```

管理过滤视图

要创建、复制、修改或删除过滤视图，请使用 spreadsheets.batchUpdate 方法：

如需创建过滤视图，请使用 AddFilterViewRequest 方法。
如需复制过滤视图，请使用 DuplicateFilterViewRequest 方法。
要修改过滤视图的属性，请使用 UpdateFilterViewRequest 方法。
如需删除过滤视图，请使用 DeleteFilterViewRequest 方法。

要列出所有过滤视图，请使用 spreadsheets.get 方法和将 fields 网址参数设为 sheets/filterViews。以下 spreadsheets.get 代码示例显示了包含字段的 Google 表格网址 mask：

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?fields=sheets/filterViews)

过滤器表示法

以下代码示例显示了 FilterView 对象。通过 BasicFilter 对象相同，只不过它缺少 filterViewId 和 title 字段，且不能使用命名的范围。

{
  "filterViewId": number,
  "title": string,
  "range": {
    object(GridRange)
  },
  "namedRangeId": string,
  "sortSpecs": [
    {
      object(SortSpec)
    }
  ],
  "criteria": {
    string: {
      object(FilterCriteria)
    },
    ...
  }
}

示例数据

本文档的其余部分引用了下面的示例销售数据表：

**表 1.** 销售数据示例
	A	B	C	D	E	F	G
1	商品类别	型号	费用	数量	区域	销售人员	发货日期
2	车轮	W-24	20.50 美元	4	西	贝丝	2016 年 3 月 1 日
3	门	D-01X	15.00 美元	2	南	阿米尔	2016 年 3 月 15 日
4	Frame	FR-0B1	34.00 美元	8	东	Hannah	2016 年 3 月 12 日
5	面板	P-034	6.00 美元	4	北	Devyn	2016 年 3 月 15 日
6	面板	P-052	11.50 美元	7	东	Erik	2016 年 5 月 16 日
7	车轮	W-24	20.50 美元	11	南	Sheldon	2016 年 4 月 30 日
8	引擎	ENG-0161	330.00 美元	2	北	杰西	2016 年 7 月 2 日

排序规范

一个过滤器可以有多个排序规范。这些规范决定了如何对数据进行排序，并按指定顺序应用。通过 SortSpec.dimensionIndex 属性指定对其应用排序的列索引。

以下代码示例展示了排序规范：

[
  {
    "dimensionIndex": 3,
    "sortOrder": "ASCENDING"
  },
  {
    "dimensionIndex": 6,
    "sortOrder": "ASCENDING"
  }
]

将此规范应用于示例销售数据时，按“数量”排序然后，如果 2 行具有相同的数量，则按日期。”

**表格 2.** 销售数据按 2 列排序
	A	B	C	D	E	F	G
1	商品类别	型号	费用	数量	区域	销售人员	发货日期
2	门	D-01X	15.00 美元	2	南	阿米尔	2016 年 3 月 15 日
3	引擎	ENG-0161	330.00 美元	2	北	杰西	2016 年 7 月 2 日
4	车轮	W-24	20.50 美元	4	西	贝丝	2016 年 3 月 1 日
5	面板	P-034	6.00 美元	4	北	Devyn	2016 年 3 月 15 日
6	面板	P-052	11.50 美元	7	东	Erik	2016 年 5 月 16 日
7	Frame	FR-0B1	34.00 美元	8	东	Hannah	2016 年 3 月 12 日
8	车轮	W-24	20.50 美元	11	南	Sheldon	2016 年 4 月 30 日

过滤条件

通过 FilterCriteria 方法可确定在基本过滤器或过滤视图。每个条件都取决于特定列中的值。您以映射形式提供过滤条件，其中键为列索引，值就是条件

对于使用布尔值 condition 指定的条件，条件必须为 True 即可显示的值。条件不会替换 hiddenValues。如果值列在 hiddenValues 下，则值的所有匹配项仍然处于隐藏状态。

以下代码示例展示了过滤条件映射：

{
  0: {
    'hiddenValues': ['Panel']
  },
  6: {
    'condition': {
      'type': 'DATE_BEFORE',
      'values': {
        'userEnteredValue': '4/30/2016'
      }
    }
  }
}

应用于示例销售数据时，此条件仅适用于会显示“Item Category”列不是“面板”，并且其中“发货日期” 早于 2016 年 4 月 30 日。

**表格 3.** 使用过滤条件的销售数据
	A	B	C	D	E	F	G
1	商品类别	型号	费用	数量	区域	销售人员	发货日期
2	车轮	W-24	20.50 美元	4	西	贝丝	2016 年 3 月 1 日
3	门	D-01X	15.00 美元	2	南	阿米尔	2016 年 3 月 15 日
4	Frame	FR-0B1	34.00 美元	8	东	Hannah	2016 年 3 月 12 日

示例

以下代码示例展示了如何创建过滤视图、复制该视图以及然后使用示例销售数据更新复制的版本。

Python

sheets/snippets/sheets_filter_views.py

在 GitHub 上查看

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def filter_views(spreadsheet_id):
  """
  Creates the batch_update the user has access to.
  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()
  # pylint: disable=maybe-no-member
  try:
    service = build("sheets", "v4", credentials=creds)

    my_range = {
        "sheetId": 0,
        "startRowIndex": 0,
        "startColumnIndex": 0,
    }
    addfilterviewrequest = {
        "addFilterView": {
            "filter": {
                "title": "Sample Filter",
                "range": my_range,
                "sortSpecs": [{
                    "dimensionIndex": 3,
                    "sortOrder": "DESCENDING",
                }],
                "criteria": {
                    0: {"hiddenValues": ["Panel"]},
                    6: {
                        "condition": {
                            "type": "DATE_BEFORE",
                            "values": {"userEnteredValue": "4/30/2016"},
                        }
                    },
                },
            }
        }
    }

    body = {"requests": [addfilterviewrequest]}
    addfilterviewresponse = (
        service.spreadsheets()
        .batchUpdate(spreadsheetId=spreadsheet_id, body=body)
        .execute()
    )

    duplicatefilterviewrequest = {
        "duplicateFilterView": {
            "filterId": addfilterviewresponse["replies"][0]["addFilterView"][
                "filter"
            ]["filterViewId"]
        }
    }

    body = {"requests": [duplicatefilterviewrequest]}
    duplicatefilterviewresponse = (
        service.spreadsheets()
        .batchUpdate(spreadsheetId=spreadsheet_id, body=body)
        .execute()
    )

    updatefilterviewrequest = {
        "updateFilterView": {
            "filter": {
                "filterViewId": duplicatefilterviewresponse["replies"][0][
                    "duplicateFilterView"
                ]["filter"]["filterViewId"],
                "title": "Updated Filter",
                "criteria": {
                    0: {},
                    3: {
                        "condition": {
                            "type": "NUMBER_GREATER",
                            "values": {"userEnteredValue": "5"},
                        }
                    },
                },
            },
            "fields": {"paths": ["criteria", "title"]},
        }
    }

    body = {"requests": [updatefilterviewrequest]}
    updatefilterviewresponse = (
        service.spreadsheets()
        .batchUpdate(spreadsheetId=spreadsheet_id, body=body)
        .execute()
    )
    print(str(updatefilterviewresponse))
  except HttpError as error:
    print(f"An error occurred: {error}")


if __name__ == "__main__":
  # Pass: spreadsheet_id
  filter_views("1CM29gwKIzeXsAppeNwrc8lbYaVMmUclprLuLYuHog4k")