このページは Cloud Translation API によって翻訳されました。

フィルタ

フィルタを使用すると、スプレッドシートの表示時に表示されるデータを並べ替えたり、絞り込みを行ったりできます。フィルタによってスプレッドシートのデータ値が変更されることはありません。フィルタを使用すると、情報を一時的に非表示にしたり並べ替えたりできます。指定したフィルタ条件に一致するデータは、フィルタがオンになっている間は表示されません。フィルタ表示を使用すると、名前付きの異なるフィルタを保存し、必要に応じて切り替えることもできます。

フィルタのユースケースの例を次に示します。

特定の列でデータを並べ替えます。たとえば、ユーザーレコードを姓で並べ替えます。
特定の条件を満たすデータを非表示にします。たとえば、2 年以上経過したレコードをすべて非表示にします。
特定の値に一致するデータを非表示にします。たとえば、ステータスが「クローズ済み」の問題をすべて非表示にします。

基本フィルタ

スプレッドシートの BasicFilter は、スプレッドシートを閲覧するたびに適用されるデフォルトのフィルタです。スプレッドシートには、シートごとに 1 つの基本フィルタを設定できます。基本フィルタをオフにするには、フィルタを消去します。これにより、フィルタとそのすべての設定がスプレッドシートから削除されます。同じフィルタを再度有効にするには、条件を再度設定する必要があります。

基本フィルタを管理する

基本フィルタを設定または消去するには、適切なリクエストタイプで spreadsheets.batchUpdate メソッドを使用します。

基本フィルタを設定するには、SetBasicFilterRequest メソッドを使用します。
基本フィルタを消去するには、ClearBasicFilterRequest メソッドを使用します。

基本フィルタを一覧表示するには、spreadsheets.get メソッドを使用して、fields URL パラメータを sheets/basicFilter に設定します。次の spreadsheets.get コードサンプルは、フィールドマスクを含む Google スプレッドシートの URL を示しています。

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

フィルタ表示

FilterView は、いつでもオフまたはオンにできる名前付きフィルタです。スプレッドシートには複数のフィルタ表示を設定できますが、一度に適用できるのは 1 つだけです。

フィルタビューのユースケースの例を次に示します。

データを表示する際に切り替える複数のフィルタがある。
スプレッドシートの編集権限がないが、フィルタを適用したい場合。この場合は、自分だけが閲覧できる一時的なフィルタ表示を作成できます。
スプレッドシートを共有するユーザーごとにデータを表示する内容を変えたい場合。適用するフィルタビューを指定するには、スプレッドシートの URL に spreadsheetId と filterViewId を指定します。これを行うには、フィルタビューを作成するときにレスポンスで返された filterViewId を使用します。

次のコードサンプルは、フィルタビューを含む Google スプレッドシートの URL を示しています。
```
https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit#gid=0&fvid=FILTER_VIEW_ID
```

フィルタビューを管理する

フィルタビューを作成、複製、変更、削除するには、適切なリクエストタイプで spreadsheets.batchUpdate メソッドを使用します。

フィルタビューを作成するには、AddFilterViewRequest メソッドを使用します。
フィルタビューのコピーを作成するには、DuplicateFilterViewRequest メソッドを使用します。
フィルタビューのプロパティを変更するには、UpdateFilterViewRequest メソッドを使用します。
フィルタビューを削除するには、DeleteFilterViewRequest メソッドを使用します。

すべてのフィルタビューを一覧表示するには、spreadsheets.get メソッドを使用して、fields URL パラメータを sheets/filterViews に設定します。次の spreadsheets.get コードサンプルは、フィールドマスクを含む Google スプレッドシートの URL を示しています。

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

フィルタの表現

次のコードサンプルは、FilterView オブジェクトの JSON 表現を示しています。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	西	Beth	2016 年 3 月 1 日
3	ドア	D-01X	$15.00	2	南	Amir	2016 年 3 月 15 日
4	フレーム	FR-0B1	$34.00	8	東	ハンナ	2016 年 3 月 12 日
5	パネル	P-034	$6.00	4	北	Devyn	2016 年 3 月 15 日
6	パネル	P-052	11.50 ドル	7	東	エリック	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	南	Amir	2016 年 3 月 15 日
3	エンジン	ENG-0161	$330.00	2	北	ジェシー	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	東	エリック	2016 年 5 月 16 日
7	フレーム	FR-0B1	$34.00	8	東	ハンナ	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]（商品カテゴリ）が [Panel]（パネル）ではなく、[Ship Date]（配送日）が 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	東	ハンナ	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")