S11. プロパティ要素

11.1 プロパティ要素の分類

データベースを取得したときの JSON オブジェクト(Property object)

Metadata that controls how a database property behaves. Each database property object contains the following keys. In addition, it must contain a key corresponding with the value of type. The value is an object containing type-specific configuration. The type-specific configurations are described in the sections below.

https://developers.notion.com/reference/property-object

ページを取得したときの JSON オブジェクト(Property item object)

Start building with the Notion API

A property_item object describes the identifier, type, and value of a page property. It's returned from the Retrieve a page property item Each page property item object contains the following keys. In addition, it will contain a key corresponding with the value of type. The value is an object containing type-specific data.

https://developers.notion.com/reference/property-item-object

データベースを設定するときの JSON オブジェクト (Property schema object)

Start building with the Notion API

Metadata that controls how a database property behaves. Each database property schema object has at least one key which is the property type. This type contains behavior of this property. Possible values of this key are "title", "rich_text", "number", "select", "multi_select", "date", "people", "files", "checkbox", "url", "email", "phone_number", "formula", "relation", "rollup", "created_time", "created_by", "last_edited_time", "last_edited_by".

https://developers.notion.com/reference/property-schema-object

ページを追加・更新する時の JSON オブジェクト (Property value object)

Start building with the Notion API

A property value defines the identifier, type, and value of a page property in a page object. It's used when retrieving and updating pages, ex: Create and Update pages. Property values in the page object have a 25 page reference limit Any property value that has uses other pages in its value will only use the first 25 page references.

https://developers.notion.com/reference/property-value-object

データベースを検索するための JSON オブジェクト (Property filter object)

Start building with the Notion API

A filter is a single condition used to specify and limit the entries returned from a database query. Database queries can be filtered by page property values. The API supports filtering by the following property types: rich_text, phone_number, number, checkbox, select, multi-select, date, people, fi...

https://developers.notion.com/reference/post-database-query-filter

11.2 Property object / Property schema object

プロパティ確認用

11.2 で確認するプロパティ確認用データベースです。ブロックハンドル(6点メニュー)から「リンクをコピー」してプロパティ確認用データベースの URL に貼り付けてください。

📝

プロパティ確認用データベースの URL を貼り付けます。

例: https://www.notion.so/hkob/7d16fe15159d40a6b6f8aab255c47e6f?v=7569e5029eb7450eaf6b7e6aae0df1c3

プロパティ確認用データベースの URL

このデータベース URL を用いて、Ruby のデータベースオブジェクトを取得します。取得した JSON の中から properties キーオブジェクトを取り出しておきます。


# プロパティ確認用データベースを取得
db = Database.find "プロパティ確認用データベースの URL"

データベースオブジェクトを取得 (Ruby)


# データベースプロパティが含まれた Ruby オブジェクト (Property object 確認用)
dps = db.json["properties"]

データベースプロパティ JSON を取得 (Ruby)

11.2.1 設定値がないプロパティ


print JSON.pretty_generate(dps.slice "チェックボックス")

Checkbox property の Property object

📝

JSON 部分をコピー&貼り付け

Checkbox property の Property object

11.2.2 関数 (formula)


print JSON.pretty_generate(dps.slice "関数")

formula property の Property object

📝

JSON 部分をコピー&貼り付け

formula property の Property object

11.2.3 セレクト (select) / マルチセレクト (multi_select)


print JSON.pretty_generate(dps.slice "セレクト")

select property の Property object

📝

JSON 部分をコピー&貼り付け

select property の Property object

11.2.4 数値 (number)


print JSON.pretty_generate(dps.slice "数値")

number property の Property object

📝

JSON 部分をコピー&貼り付け

number property の Property object

11.2.5 リレーション (relation)


print JSON.pretty_generate(dps.slice "片方向リレーション先")

relation property(single_property) の Property object

📝

JSON 部分をコピー&貼り付け

relation property(single_property) の Property object


print JSON.pretty_generate(dps.slice "双方向リレーション先")

relation property(dual_property) の Property object

📝

JSON 部分をコピー&貼り付け

relation property(dual_property) の Property object

11.2.6 ロールアップ (rollup)


print JSON.pretty_generate(dps.slice "ロールアップ")

rollup property の Property object

📝

JSON 部分をコピー&貼り付け

rollup property の Property object

"function" に利用可能な関数は以下の通りです。

関数	日本語メニュー	対象の型	返り値の型
count_all	すべてカウント	すべての型	数値
count_values	値の数をカウント	すべての型	数値
count_unique_values	一意の値をカウント	数値・文字列・日付	数値
count_empty	未入力をカウント	数値・文字列・日付	数値
count_not_empty	未入力以外をカウント	数値・文字列・日付	数値
percent_empty	未入力の割合	数値・文字列・日付	数値
percent_not_empty	未入力以外の割合	数値・文字列・日付	数値
checked	チェックあり	ブール値	数値
unchecked	チェックなし	ブール値	数値
percent_checked	チェックありの割合	ブール値	数値
percent_unchecked	チェックなしの割合	ブール値	数値
sum	合計	数値	数値
average	平均	数値	数値
median	中央値	数値	数値
min	最小 (数値) 最も古い日付 (日付)	数値日付	数値日付
max	最大 (数値) 最も新しい日付 (日付)	数値日付	数値日付
range	範囲(数値) 日付範囲(日付)	数値日付	数値日付範囲
show_original	オリジナルを表示する	すべての型	配列
show_unique	一意の値を表示する	すべての型	配列

11.3 Property item object / Property value object

データベース内には二つのページが登録されています。このうち「データ1」ページへのメンションリンクをここに用意しておきました。このページを開き、page URL を取得してください。

データ1

📝

プロパティ確認用ページの URL を貼り付けます。

例: https://www.notion.so/hkob/1-1771b75598ec478a98d3c64b1ae62846

プロパティ確認用ページ(データ1ページ)の URL

このページ URL を用いて、Ruby のページオブジェクトを取得します。取得した JSON の中から properties キーオブジェクトを取り出しておきます。


# プロパティ確認用データベースを取得
page = Page.find "データ 1 ページの URL"

page オブジェクトの取得


# ページプロパティが含まれた Ruby オブジェクト (Property item object 確認用)
pps = page.json["properties"]

ページプロパティ JSON を取得

11.3.1 作成者 (created_by) /最終更新者 (last_edited_by)


print JSON.pretty_generate(pps.slice "作成者")

created_by property の Property item object

📝

JSON 部分をコピー&貼り付け

created_by property の Property item object


print JSON.pretty_generate(pps.slice "最終更新者")

last_edited_by property の Property item object

📝

JSON 部分をコピー&貼り付け

last_edited_by property の Property item object

11.3.2 作成日時 (created_time) /最終更新日時 (last_edited_time)


print JSON.pretty_generate(pps.slice "作成日時")

created_time property の Property item object

📝

JSON 部分をコピー&貼り付け

created_time property の Property item object


print JSON.pretty_generate(pps.slice "最終更新日時")

last_edited_time property の Property item object

📝

JSON 部分をコピー&貼り付け

last_edited_time property の Property item object

11.3.3 関数 (formula)


print JSON.pretty_generate(pps.slice "関数")

formula の Property item object

📝

JSON 部分をコピー&貼り付け

formula の Property item object

11.3.4 ロールアップ (rollup)


print JSON.pretty_generate(pps.slice "ロールアップ")

rollup property (count) の Property item object

📝

JSON 部分をコピー&貼り付け

rollup property (count) の Property item object


print JSON.pretty_generate(pps.slice "ロールアップ(オリジナル)")

rollup property (show_original) の Property item object

📝

JSON 部分をコピー&貼り付け

rollup property (show_original) の Property item object

11.3.5 チェックボックス (checkbox)


print JSON.pretty_generate(pps.slice "チェックボックス")

checkbox property の Property item object

📝

JSON 部分をコピー&貼り付け

checkbox property の Property item object

11.3.6 日付 (date)


print JSON.pretty_generate(pps.slice "日付")

date property の Property item object

📝

JSON 部分をコピー&貼り付け

date property の Property item object

11.3.7 メール (email)


print JSON.pretty_generate(pps.slice "メール")

email property の Property item object

📝

JSON 部分をコピー&貼り付け

email property の Property item object

11.3.8 ファイル & メディア (files)


print JSON.pretty_generate(pps.slice "ファイル&メディア")

files property の Property item object

📝

JSON 部分をコピー&貼り付け

files property の Property item object

11.3.9 マルチセレクト (multi_select)


print JSON.pretty_generate(pps.slice "マルチセレクト")

multi_select property の Property item object

📝

JSON 部分をコピー&貼り付け

multi_select property の Property item object

11.3.10 数値 (number)


print JSON.pretty_generate(pps.slice "数値")

number property の Property item object

📝

JSON 部分をコピー&貼り付け

number property の Property item object

11.3.11 ユーザー (people)


print JSON.pretty_generate(pps.slice "ユーザー")

people property の Property item object

📝

JSON 部分をコピー&貼り付け

number property の Property item object

11.3.12 電話 (phone_number)


print JSON.pretty_generate(pps.slice "電話")

phone_number property の Property item object

📝

JSON 部分をコピー&貼り付け

phone_number property の Property item object

11.3.13 リレーション (relation)


print JSON.pretty_generate(pps.slice "片方向リレーション先")

relation property の Property item object

📝

JSON 部分をコピー&貼り付け

relation property の Property item object

11.3.14 テキスト (rich_text)


print JSON.pretty_generate(pps.slice "テキスト")

rich_text property の Property item object

📝

JSON 部分をコピー&貼り付け

rich_text property の Property item object

11.3.15 セレクト (select)


print JSON.pretty_generate(pps.slice "セレクト")

select property の Property item object

📝

JSON 部分をコピー&貼り付け

select property の Property item object

11.3.16 タイトル (title)


print JSON.pretty_generate(pps.slice "タイトル")

title property の Property item object

📝

JSON 部分をコピー&貼り付け

title property の Property item object

11.3.17 URL (url)


print JSON.pretty_generate(pps.slice "URL")

url property の Property item object

📝

JSON 部分をコピー&貼り付け

url property の Property item object

11.4 Filter object

Start building with the Notion API

https://developers.notion.com/reference/post-database-query-filter

11.4.1 存在・非存在条件

データベース Ruby オブジェクトから PropertyCache オブジェクトを取得しておきます。


ps = db.properties

Ruby の PropertyCache オブジェクト


print JSON.pretty_generate(ps["数値"].filter_is_not_empty.filter)

is_not_empty 条件

📝

JSON 部分をコピー&貼り付け

is_not_empty 条件


print JSON.pretty_generate(ps["数値"].filter_is_empty.filter)

is_empty 条件

📝

JSON 部分をコピー&貼り付け

is_not_empty 条件

11.4.2 一致・不一致条件


print JSON.pretty_generate(ps["URL"].filter_equals("ABC").filter)

equals 条件

📝

JSON 部分をコピー&貼り付け

equals 条件


print JSON.pretty_generate(ps["URL"].filter_does_not_equal("ABC").filter)

does_not_equal 条件

📝

JSON 部分をコピー&貼り付け

does_not_equal 条件


print JSON.pretty_generate(ps["日付"].filter_equals(Date.new(2022, 10, 15)).filter)

NotionRubyMapping 拡張

📝

JSON 部分をコピー&貼り付け

NotionRubyMapping 拡張

11.4.3 包含・非包含条件


print JSON.pretty_generate(ps["タイトル"].filter_contains("ABC").filter)

contains 条件

📝

JSON 部分をコピー&貼り付け

contains 条件


print JSON.pretty_generate(ps["タイトル"].filter_does_not_contain("ABC").filter)

does_not_contain 条件

📝

JSON 部分をコピー&貼り付け

does_not_contain 条件

11.4.4 開始・終了条件


print JSON.pretty_generate(ps["テキスト"].filter_starts_with("ABC").filter)

starts_with 条件

📝

JSON 部分をコピー&貼り付け

starts_with 条件


print JSON.pretty_generate(ps["テキスト"].filter_ends_with("ABC").filter)

ends_with 条件

📝

JSON 部分をコピー&貼り付け

ends_with 条件

11.4.5 数値の大小条件


print JSON.pretty_generate(ps["数値"].filter_greater_than(10).filter)

greater_than 条件

📝

JSON 部分をコピー&貼り付け

greater_than 条件


print JSON.pretty_generate(ps["数値"].filter_less_than(10).filter)

less_than 条件

📝

JSON 部分をコピー&貼り付け

less_than 条件


print JSON.pretty_generate(ps["数値"].filter_greater_than_or_equal_to(10).filter)

greater_than_or_equal_to 条件

📝

JSON 部分をコピー&貼り付け

greater_than_or_equal_to 条件


print JSON.pretty_generate(ps["数値"].filter_less_than_or_equal_to(10).filter)

less_than_or_equal_to 条件

📝

JSON 部分をコピー&貼り付け

less_than_or_equal_to 条件

11.4.5 日付の前後条件

日付系プロパティ(date, created_time, last_edited_time)のみ、日付の前後を比較するフィルタが利用できます。まず、特定の日付・時間の前後関係に関するフィルタとして、前(before)、後(after)、今を含む前(on_or_before)、今を含む後(on_or_after)が利用できます。これも日付の場合には、UTC になるので注意が必要です。せっかくなので、ここでは Timestamp filter object の例で説明しています。このように専用のプロパティを用意していなくても、データベースの作成時刻を使って絞り込みをすることが可能です。こちらも before の結果のみ示します。


print JSON.pretty_generate(db.created_time.filter_before(Time.local(2022, 10, 15, 12, 0, 0)).filter)

before 条件

📝

JSON 部分をコピー&貼り付け

before 条件


print JSON.pretty_generate(db.created_time.filter_after(Time.local(2022, 10, 15, 12, 0, 0)).filter)

after 条件

📝

JSON 部分をコピー&貼り付け

after 条件


print JSON.pretty_generate(db.created_time.filter_on_or_before(Time.local(2022, 10, 15, 12, 0, 0)).filter)

on_or_before 条件

📝

JSON 部分をコピー&貼り付け

on_or_before 条件


print JSON.pretty_generate(db.created_time.filter_on_or_after(Time.local(2022, 10, 15, 12, 0, 0)).filter)

on_or_after 条件

📝

JSON 部分をコピー&貼り付け

on_or_after 条件


print JSON.pretty_generate(db.last_edited_time.filter_past_week.filter)

past_week 条件

📝

JSON 部分をコピー&貼り付け

past_week 条件


print JSON.pretty_generate(db.last_edited_time.filter_next_week.filter)

next_week 条件

📝

JSON 部分をコピー&貼り付け

next_week 条件


print JSON.pretty_generate(db.last_edited_time.filter_past_month.filter)

past_month 条件

📝

JSON 部分をコピー&貼り付け

past_month 条件


print JSON.pretty_generate(db.last_edited_time.filter_next_month.filter)

next_month 条件

📝

JSON 部分をコピー&貼り付け

next_month 条件


print JSON.pretty_generate(db.last_edited_time.filter_past_year.filter)

past_year 条件

📝

JSON 部分をコピー&貼り付け

past_year 条件


print JSON.pretty_generate(db.last_edited_time.filter_next_year.filter)

next_year 条件

📝

JSON 部分をコピー&貼り付け

next_year 条件


print JSON.pretty_generate(db.last_edited_time.filter_this_week.filter)

this_week 条件

📝

JSON 部分をコピー&貼り付け

this_week 条件

11.4.6 関数(formula)に対する条件


print JSON.pretty_generate(ps["関数"].filter_equals(true, another_type: "checkbox").filter)

Formula filter object

📝

JSON 部分をコピー&貼り付け

Formula filter object

11.4.7 ロールアップ(rollup)に対する条件


rp = ps["ロールアップ"]

Rollup Property Ruby オブジェクトの取得


print JSON.pretty_generate(rp.filter_greater_than(10, another_type: "number").filter)

数値の場合の Rollup filter object


print JSON.pretty_generate(rp.filter_past_week(another_type: "date").filter)

日付の場合の Rollup filter object

一方、 show_original や show_unique の場合には、複数個の値が存在します。ロールアップの場合には、それらのどれかの値が該当するか (any)、全ての値が該当するか (every)、全ての値が該当しないか (none) を確認することができます。例えばチェックボックスを複数個ロールアップしてきた場合を考えましょう。複数個存在するチェックボックスのいずれかにチェックがされているものを抽出する場合には以下のようになります。


print JSON.pretty_generate(rp.filter_equals(true, another_type: "checkbox", condition: "any").filter)

Rollup filter object (any)


print JSON.pretty_generate(rp.filter_equals(true, another_type: "checkbox", condition: "every").filter)

Rollup filter object (any)


print JSON.pretty_generate(rp.filter_equals(true, another_type: "checkbox", condition: "none").filter)

Rollup filter object (none)

以下、サンプルデータのリレーション先のデータベース

片方向リレーション先

双方向リレーション先