使用篩選器管理資料瀏覽權限

本文說明如何使用篩選器排序及篩選試算表中顯示的資料。

篩選器可讓您在查看試算表時,排序及篩選資料。篩選器不會變更試算表中的資料值,你可以使用篩選器暫時隱藏或排序資訊。篩選器啟用後,系統不會顯示符合指定篩選條件的資料。您也可以使用篩選器檢視畫面儲存不同名稱的篩選器,並隨時切換。

如要篩選 Google Sheets API 要求傳回的資料,請使用 DataFilter 物件。詳情請參閱「讀取、寫入及搜尋中繼資料」。

篩選用途

以下是一些篩選器的範例用途:

  • 依特定資料欄排序資料。舉例來說,依使用者記錄的姓氏排序。
  • 隱藏符合特定條件的資料。舉例來說,隱藏所有超過兩年的記錄。
  • 隱藏符合特定值的資料。舉例來說,隱藏所有狀態為「已結案」的問題。

基本篩選器

試算表的 BasicFilter 物件是預設篩選器,每當有人查看試算表時,系統都會套用這個篩選器。每份試算表只能在每個工作表中設定一個基本篩選器。如要關閉基本篩選器,請清除篩選器。這會從試算表移除篩選器和所有相關設定。如要重新開啟相同的篩選器,必須再次設定條件。

管理基本篩選器

如要設定或清除基本篩選器,請使用 spreadsheets.batchUpdate 方法和適當的要求類型:

如要列出基本篩選器,請使用 spreadsheets.get 方法,並將 fields 網址參數設為 sheets/basicFilter。下列 spreadsheets.get 程式碼範例顯示含有欄位遮罩的 Google 試算表網址:

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

篩選器檢視畫面

A FilterView 是具名的篩選器,可隨時開啟及關閉。工作表可以儲存多個篩選器檢視畫面,但一次只能套用一個。工作表也可以同時包含基本篩選器和多個篩選器檢視畫面,但您無法同時對相同資料範圍套用兩者。

篩選檢視用途

以下是篩選器檢視畫面的一些範例用途:

  • 您有多個不同的篩選器,想在查看資料時切換使用。
  • 您沒有試算表的編輯權限,但仍想套用篩選器。在這種情況下,您可以建立臨時的篩選器檢視畫面,只有您自己能看到。
  • 您希望與他人共用試算表時,對方能以不同方式查看資料。您可以在試算表網址中提供 spreadsheetIdfilterViewId,指定要套用的篩選器檢視畫面。如要這麼做,請使用建立篩選器檢視畫面時,在回應中傳回的 filterViewId

    以下程式碼範例顯示含有篩選檢視畫面的 Google 試算表網址:

    https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit#gid=0&fvid=FILTER_VIEW_ID

管理篩選器檢視畫面

如要建立、複製、修改或刪除篩選檢視畫面,請使用 spreadsheets.batchUpdate 方法和適當的要求類型:

如要列出所有篩選器檢視畫面,請使用 spreadsheets.get 方法,並將 fields 網址參數設為 sheets/filterViews。下列 spreadsheets.get 程式碼範例顯示含有欄位遮罩的 Google 試算表網址:

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

篩選條件的 JSON 表示法

下列程式碼範例顯示 FilterView 物件的 JSON 表示法。這個 BasicFilter 物件與上述物件相同,但缺少 filterViewIdtitle 欄位,且無法使用具名範圍。

{
  "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 西部 Beth 2016 年 3 月 1 日
3 D-01X $15.00 2 Amir 2016 年 3 月 15 日
4 頁框 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 Jessie 2016 年 7 月 2 日

排序規格

篩選條件可以有多個排序規格。這些規格會決定資料的排序方式,並依指定順序套用。SortSpec.dimensionIndex 屬性會指定要套用排序的資料欄索引。

下列程式碼範例顯示排序規格:

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

套用至銷售資料樣本時,這項規格會先依「數量」欄排序,如果兩列的數量相同,則依「出貨日期」排序。

表 2. 依兩欄排序的銷售資料
A B C D E F G
1 項目類別 型號 費用 數量 區域 銷售專員 出貨日期
2 D-01X $15.00 2 Amir 2016 年 3 月 15 日
3 引擎 ENG-0161 $330.00 2 Jessie 2016 年 7 月 2 日
4 車輪 W-24 $20.50 4 西部 Beth 2016 年 3 月 1 日
5 面板 P-034 $6.00 4 Devyn 2016 年 3 月 15 日
6 面板 P-052 $11.50 7 Erik 2016 年 5 月 16 日
7 頁框 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'
      }
    }
  }
}

套用至銷售資料樣本時,這項條件只會顯示「項目類別」欄值不是「面板」,且「出貨日期」欄值早於「2016 年 4 月 30 日」的資料列。

表 3:使用篩選條件的銷售資料
A B C D E F G
1 項目類別 型號 費用 數量 區域 銷售專員 出貨日期
2 車輪 W-24 $20.50 4 西部 Beth 2016 年 3 月 1 日
3 D-01X $15.00 2 Amir 2016 年 3 月 15 日
4 頁框 FR-0B1 $34.00 8 Hannah 2016 年 3 月 12 日

篩選檢視畫面程式碼範例

下列程式碼範例說明如何建立篩選器檢視畫面、複製該檢視畫面,然後使用範例銷售資料更新複製的版本。

Java

sheets/snippets/src/main/java/SheetsFilterViews.java
/*
 * Dependencies (Maven):
 * com.google.apis:google-api-services-sheets:v4-rev20220927-2.0.0
 * com.google.auth:google-auth-library-oauth2-http:1.19.0
 */

import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.sheets.v4.Sheets;
import com.google.api.services.sheets.v4.SheetsScopes;
import com.google.api.services.sheets.v4.model.*;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;

import java.io.IOException;
import java.security.GeneralSecurityException;
import java.util.*;

public class SheetsFilterViews {

    public static void main(String... args) {
        filterViews("1CM29gwKIzeXsAppeNwrc8lbYaVMmUclprLuLYuHog4k");
    }

    public static void filterViews(String spreadsheetId) {
        try {
            // Load pre-authorized user credentials from the environment.
            // TODO(developer) - See https://developers.google.com/identity for guides on implementing OAuth2.
            GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
                    .createScoped(Collections.singleton(SheetsScopes.SPREADSHEETS));

            Sheets service = new Sheets.Builder(
                    GoogleNetHttpTransport.newTrustedTransport(),
                    GsonFactory.getDefaultInstance(),
                    new HttpCredentialsAdapter(credentials))
                    .setApplicationName("Sheets Filter Views Sample")
                    .build();

            // --- Step 1: Add Filter View ---
            GridRange myRange = new GridRange()
                    .setSheetId(0)
                    .setStartRowIndex(0)
                    .setStartColumnIndex(0);

            // Construct Criteria for Column 0 (Hidden Values)
            FilterCriteria criteria0 = new FilterCriteria()
                    .setHiddenValues(Collections.singletonList("Panel"));

            // Construct Criteria for Column 6 (Date Condition)
            ConditionValue dateValue = new ConditionValue().setUserEnteredValue("4/30/2016");
            BooleanCondition dateCondition = new BooleanCondition()
                    .setType("DATE_BEFORE")
                    .setValues(Collections.singletonList(dateValue));
            FilterCriteria criteria6 = new FilterCriteria().setCondition(dateCondition);

            // Map criteria to column indices (Note: keys are Strings in Java map)
            Map<String, FilterCriteria> criteriaMap = new HashMap<>();
            criteriaMap.put("0", criteria0);
            criteriaMap.put("6", criteria6);

            FilterView filterView = new FilterView()
                    .setTitle("Sample Filter")
                    .setRange(myRange)
                    .setSortSpecs(Collections.singletonList(
                            new SortSpec().setDimensionIndex(3).setSortOrder("DESCENDING")
                    ))
                    .setCriteria(criteriaMap);

            // --- Step 1: Add Filter View ---
            // (Request construction remains the same)
            // ...
            AddFilterViewRequest addFilterViewRequest = new AddFilterViewRequest().setFilter(filterView);

            BatchUpdateSpreadsheetRequest batchRequest1 = new BatchUpdateSpreadsheetRequest()
                    .setRequests(Collections.singletonList(new Request().setAddFilterView(addFilterViewRequest)));

            BatchUpdateSpreadsheetResponse response1 = service.spreadsheets()
                    .batchUpdate(spreadsheetId, batchRequest1)
                    .execute();

            if (response1.getReplies() == null || response1.getReplies().isEmpty()) {
                System.err.println("Error: No replies returned from AddFilterView request.");
                return;
            }

            Response reply1 = response1.getReplies().get(0);
            if (reply1.getAddFilterView() == null || reply1.getAddFilterView().getFilter() == null) {
                 System.err.println("Error: Response did not contain AddFilterView data.");
                 return;
            }

            int filterId = reply1.getAddFilterView().getFilter().getFilterViewId();

            // --- Step 2: Duplicate Filter View ---
            DuplicateFilterViewRequest duplicateRequest = new DuplicateFilterViewRequest()
                    .setFilterId(filterId);

            BatchUpdateSpreadsheetRequest batchRequest2 = new BatchUpdateSpreadsheetRequest()
                    .setRequests(Collections.singletonList(new Request().setDuplicateFilterView(duplicateRequest)));

            BatchUpdateSpreadsheetResponse response2 = service.spreadsheets()
                    .batchUpdate(spreadsheetId, batchRequest2)
                    .execute();

            if (response2.getReplies() == null || response2.getReplies().isEmpty()) {
                 System.err.println("Error: No replies returned from DuplicateFilterView request.");
                 return;
            }

            Response reply2 = response2.getReplies().get(0);
            if (reply2.getDuplicateFilterView() == null || reply2.getDuplicateFilterView().getFilter() == null) {
                System.err.println("Error: Response did not contain DuplicateFilterView data.");
                return;
            }

            int newFilterId = reply2.getDuplicateFilterView().getFilter().getFilterViewId();

            // --- Step 3: Update Filter View ---
            // Extract the new ID from the duplicate response
            int newFilterId = response2.getReplies().get(0)
                    .getDuplicateFilterView().getFilter().getFilterViewId();

            // Create update criteria
            Map<String, FilterCriteria> updateCriteriaMap = new HashMap<>();
            updateCriteriaMap.put("0", new FilterCriteria()); // Empty criteria

            ConditionValue numValue = new ConditionValue().setUserEnteredValue("5");
            BooleanCondition numCondition = new BooleanCondition()
                    .setType("NUMBER_GREATER")
                    .setValues(Collections.singletonList(numValue));
            updateCriteriaMap.put("3", new FilterCriteria().setCondition(numCondition));

            FilterView updateFilterView = new FilterView()
                    .setFilterViewId(newFilterId)
                    .setTitle("Updated Filter")
                    .setCriteria(updateCriteriaMap);

            UpdateFilterViewRequest updateRequest = new UpdateFilterViewRequest()
                    .setFilter(updateFilterView)
                    .setFields("criteria,title");

            BatchUpdateSpreadsheetRequest batchRequest3 = new BatchUpdateSpreadsheetRequest()
                    .setRequests(Collections.singletonList(new Request().setUpdateFilterView(updateRequest)));

            BatchUpdateSpreadsheetResponse response3 = service.spreadsheets()
                    .batchUpdate(spreadsheetId, batchRequest3)
                    .execute();

            System.out.println(response3.toPrettyString());

        } catch (IOException | GeneralSecurityException e) {
            System.err.println("An error occurred: " + e);
        }
    }
}

Python

sheets/snippets/sheets_filter_views.py
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")