2
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

【Notion】Query a database APIのFilter objectの書き方について

Last updated at Posted at 2023-05-27

はじめに

Filter objectはQuery a databaseで検索を行う際の条件指定に使用するオブジェクトです。
指定できる条件の種類については公式リファレンスの中で詳しく解説されているのですが、オブジェクトの書き方(具体例)はあまり掲載されていなかったのでメモ的にまとめていこうと思います。
・公式リファレンスはこちらから:https://developers.notion.com/reference/post-database-query-filter

プロパティごとのオブジェクトの書き方

Text filter condition - テキスト

「タイトル(title)」「テキスト(rich_text)」「URL(url)」「メール(email)」「電話番号(phone_number)」プロパティの条件指定に使用します(※URLプロパティに対して条件を指定する場合は下記サンプルの「rich_text」を「url」に変更)。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "rich_text": {
        "contains": "sample"
    }
}

Number filter condition - 数値

「数値」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "number": {
        "greater_than": 2
    }
}

Checkbox filter condition - チェックボックス

「チェックボックス」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "checkbox": {
        "equals": "true"
    }
}

Select filter condition - セレクト

「セレクト」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "select": {
        "equals": "sample"
    }
}

Mulit-select filter condition - マルチセレクト

「マルチセレクト」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "multi_select": {
        "contains": "sample"
    }
}

Status filter condition - ステータス

「ステータス」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "status": {
        "is_not_empty": true
    }
}

Date filter condition - 日付

「日付」「作成日時」「最終更新日時」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "date": {
        "after": "202-01-01"
    }
}

People filter condition - ユーザー

「ユーザー」「作成者」「最終更新者」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "people": {
        "contains": "aaaaaaaa-aaaa-aaa-aaaa-aaaaaaaaaaaa"
    }
}

Files filter condition - ファイル

「ファイル」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "files": {
        "is_not_empty": true
    }
}

Relation filter condition - リレーション

「リレーション」プロパティの条件指定に使用します。指定できる条件の種類はこちらから

sample
{
    "property": "プロパティ名",
    "relation": {
        "contains": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
}
2
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?