データベースのプロパティ
データベースのプロパティ
データベース プロパティ オブジェクトは、Notion UI でデータベース列としてレンダリングされます。
すべてのデータベース オブジェクトには子オブジェクトのpropertiesが含まれます。このpropertiesオブジェクトは、個々のデータベース プロパティ オブジェクトで構成されます。これらのプロパティ オブジェクトはデータベース スキーマを定義し、Notion UI でデータベース列としてレンダリングされます。
📘データベース行
API を使用してデータベース行を操作する方法についての情報を探している場合は、ページ プロパティ値のドキュメントを参照してください。API は、データベースの行をページとして扱います。
すべてのデータベース プロパティ オブジェクトには、次のキーが含まれています。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
id |
string |
プロパティの識別子で、通常はランダムな文字と記号の短い文字列です。 一部の自動生成されたプロパティ タイプには、人間が判読できる特別な ID があります。たとえば、すべての Title プロパティには"title"という idがあります。 |
"fy:{" |
name |
string |
Notion に表示されるプロパティの名前。 | |
type |
string(列挙型) |
プロパティの動作を制御する型。可能な値は次のとおり です 。 -"checkbox" "created_by" "created_time" "date" "email" "files" "formula" "last_edited_by" "last_edited_time" "multi_select" "number" "people" "phone_number" "relation" "rich_text" "rollup" "select" "status" "title" "url" |
"rich_text" |
各データベース プロパティ オブジェクトには、タイプ オブジェクトも含まれます。オブジェクトのキーはオブジェクトの であり、値はタイプ固有の構成を含むオブジェクトです。次のセクションでは、これらのタイプ固有のオブジェクトと、各タイプのプロパティ オブジェクトの例について詳しく説明します。type
チェックボックス
チェックボックス データベース プロパティは、チェックボックスを含む列として Notion UI に表示されます。checkbox型オブジェクトが空です。追加のプロパティ構成はありません。
チェックボックス データベース プロパティ オブジェクトの例
"Task complete": {
"id": "BBla",
"name": "Task complete",
"type": "checkbox",
"checkbox": {}
}
作成されたもの
データベースによって作成されたプロパティは、Notion UI で、各行の作成者のメンションを値として含む列としてレンダリングされます。
created_byタイプオブジェクトが空です。追加のプロパティ構成はありません。
データベース プロパティ オブジェクトによって作成された例
"Created by": {
"id": "%5BJCR",
"name": "Created by",
"type": "created_by",
"created_by": {}
}
作成時間
作成時刻データベース プロパティは、各行が値として作成されたときのタイムスタンプを含む列として Notion UI にレンダリングされます。
created_timeタイプオブジェクトが空です。追加のプロパティ構成はありません。
作成されたタイム データベース プロパティ オブジェクトの例
"Created time": {
"id": "XcAf",
"name": "Created time",
"type": "created_time",
"created_time": {}
}
日付
日付データベース プロパティは、日付値を含む列として Notion UI に表示されます。
date型オブジェクトが空です。追加の構成はありません。
日付データベース プロパティ オブジェクトの例
"Task due date" {
"id": "AJP%7D",
"name": "Task due date",
"type": "date",
"date": {}
}
電子メール
電子メール データベース プロパティは、電子メールの値を含む列として Notion UI に表示されます。
emailタイプオブジェクトが空です。追加のプロパティ構成はありません。
メール データベース プロパティ オブジェクトの例
"Contact email": {
"id": "oZbC",
"name": "Contact email",
"type": "email",
"email": {}
}
ファイル
📘
Notion API は、Notion へのファイルのアップロードをまだサポートしていません。
ファイル データベース プロパティは、Notion に直接アップロードされたファイルまたはファイルへの外部リンクのいずれかの値を持つ列として Notion UI にレンダリングされます。files型オブジェクトが空です。追加の構成はありません。
サンプル ファイル データベース プロパティ オブジェクト
"Product image": {
"id": "pb%3E%5B",
"name": "Product image",
"type": "files",
"files": {}
}
方式
数式データベース プロパティは、指定された式から派生した値を含む列として Notion UI に表示されます。
formulaタイプオブジェクトは、次のフィールドで式を定義します。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
expression |
string |
このプロパティの値を計算するために使用される式。式の構文については 、Notion ヘルプ センターを参照してください。 | "prop(\"Price\") * 2" |
数式データベース プロパティ オブジェクトの例
"Updated price": {
"id": "YU%7C%40",
"name": "Updated price",
"type": "formula",
"formula": {
"expression": "prop(\"Price\") * 2"
}
}
最終編集者
最終編集者データベース プロパティは、各行を最後に編集した人物のメンションを値として含む列として Notion UI にレンダリングされます。
last_edited_byタイプオブジェクトが空です。追加のプロパティ構成はありません。
最終編集時刻
最終編集時間データベース プロパティは、各行が最後に編集されたときのタイムスタンプを値として含む列として Notion UI に表示されます。
last_edited_timeタイプオブジェクトが空です。追加のプロパティ構成はありません。
最終編集時間データベース プロパティ オブジェクトの例
"Last edited time": {
"id": "jGdo",
"name": "Last edited time",
"type": "last_edited_time",
"last_edited_time": {}
}
複数選択
複数選択データベース プロパティは、Notion UI で、さまざまなオプションの値を含む列としてレンダリングされます。各行には、1 つまたは複数のオプションを含めることができます。
multi_selectタイプオブジェクトには、optionsオブジェクトの配列が含まれます。各オプション オブジェクトは、オプションの詳細設定を示し、次のフィールドを示します。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
color |
string(列挙型) |
Notion UI でレンダリングされるオプションの色。可能な値は次のとおりです。 -blue brown default gray green orange pink purple red yellow |
"blue" |
id |
string |
名前が変更されても変更されない、オプションの識別子。idは常に*ではありませんが、 UUIDの場合もあります。 |
"ff8e9269-9579-47f7-8f6e-83a84716863c" |
name |
string |
Notion に表示されるオプションの名前。 注: コンマ (",") は複数選択プロパティには無効です。 | "Fruit" |
複数選択データベース プロパティの例
"Store availability": {
"id": "flsb",
"name": "Store availability",
"type": "multi_select",
"multi_select": {
"options": [
{
"id": "5de29601-9c24-4b04-8629-0bca891c5120",
"name": "Duc Loi Market",
"color": "blue"
},
{
"id": "385890b8-fe15-421b-b214-b02959b0f8d9",
"name": "Rainbow Grocery",
"color": "gray"
},
{
"id": "72ac0a6c-9e00-4e8c-80c5-720e4373e0b9",
"name": "Nijiya Market",
"color": "purple"
},
{
"id": "9556a8f7-f4b0-4e11-b277-f0af1f8c9490",
"name": "Gus's Community Market",
"color": "yellow"
}
]
}
}
番号
数値データベース プロパティは、数値を含む列として Notion UI に表示されます。タイプオブジェクトには次のフィールドが含まれます。number
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
format |
string(列挙型) |
Notion での数値の表示方法。可能な 値は 次 のとおり です。 -argentine_peso baht canadian_dollar chilean_peso colombian_peso danish_krone dirham dollar euro forint franc hong_kong_dollar koruna krona leu lira mexican_peso new_taiwan_dollar new_zealand_dollar norwegian_krone number number_with_commas percent philippine_peso pound rand real ringgit riyal ruble rupee rupiah shekel singapore_dollar uruguayan_peso yen yuan won zloty |
"percent" |
数値データベース プロパティ オブジェクトの例
"Price"{
"id": "%7B%5D_P",
"name": "Price",
"type": "number",
"number": {
"format": "dollar"
}
}
人
people データベース プロパティは、ピープル メンションを含む列として Notion UI に表示されます。people型オブジェクトが空です。追加の構成はありません。
ピープル データベース プロパティ オブジェクトの例
"Project owner": {
"id": "FlgQ",
"name": "Project owner",
"type": "people",
"people": {}
}
電話番号
電話番号データベース プロパティは、電話番号の値を含む列として Notion UI に表示されます。
phone_numberタイプオブジェクトが空です。追加のプロパティ構成はありません。
電話番号データベース プロパティ オブジェクトの例
"Contact phone number": {
"id": "ULHa",
"name": "Contact phone number",
"type": "phone_number",
"phone_number": {}
}
関係
リレーション データベース プロパティは、値としてリレーション、別のデータベース内のページへの参照を含む列として Notion UI にレンダリングされます。
relationタイプオブジェクトには次のフィールドが含まれます。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
database_id |
string(UUID) |
関係プロパティが参照するデータベース。 対応するリンクされたページの値が有効であるためには、データベースに属している必要があります。 | "668d797c-76fa-4934-9b05-ad288df2d136" |
synced_property_id |
string |
このプロパティが変更されたときに、関連するデータベースで更新される対応するプロパティのidを指定します。 |
"fy:{" |
synced_property_name |
string |
このプロパティが変更されたときに、関連するデータベースで更新される対応するプロパティのnameを指定します。 |
"Ingredients" |
リレーション データベース プロパティ オブジェクトの例
"Projects": {
"id": "~pex",
"name": "Projects",
"type": "relation",
"relation": {
"database_id": "6c4240a9-a3ce-413e-9fd0-8a51a4d0a49b",
"synced_property_name": "Tasks",
"synced_property_id": "JU]K"
}
}
📘API を介してデータベース関係プロパティを更新するには、関連する親データベースを統合と共有します。
リッチテキスト
リッチ テキスト データベース プロパティは、テキスト値を含む列として Notion UI に表示されます。rich_text型オブジェクトが空です。追加の構成はありません。
リッチ テキスト データベース プロパティ オブジェクトの例
"Project description": {
"id": "NZZ%3B",
"name": "Project description",
"type": "rich_text",
"rich_text": {}
}
ロールアップ
ロールアップ データベース プロパティは、関連するデータベースから取得された特定のプロパティであるロールアップである値を持つ列として Notion UI にレンダリングされます。
rollupタイプオブジェクトには次のフィールドが含まれます。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
function |
string(列挙型) |
関連ページからロールアップ値を計算する関数。 可能な値は次の とおり です 。 -average checked count_per_group count count_values date_range earliest_date empty latest_date max median min not_empty percent_checked percent_empty percent_not_empty percent_per_group percent_unchecked range unchecked unique show_original show_unique sum |
"sum" |
relation_property_id |
string |
ロールアップされる関連データベース プロパティのid。 |
"fy:{" |
relation_property_name |
string |
ロールアップされる関連データベース プロパティのname。 |
Tasks" |
rollup_property_id |
string |
ロールアップ プロパティのid。 |
"fy:{" |
rollup_property_name |
string |
ロールアップ プロパティのname。 |
"Days to complete" |
ロールアップ データベース プロパティ オブジェクトの例
"Estimated total project time": {
"id": "%5E%7Cy%3C",
"name": "Estimated total project time",
"type": "rollup",
"rollup": {
"rollup_property_name": "Days to complete",
"relation_property_name": "Tasks",
"rollup_property_id": "\\nyY",
"relation_property_id": "Y]<y",
"function": "sum"
}
}
選択
選択データベース プロパティは、選択したオプションからの値を含む列として Notion UI に表示されます。行ごとに 1 つのオプションのみが許可されます。
select型オブジェクトには、使用可能なオプションを表すオブジェクトの配列が含まれています。各オプション オブジェクトには、次のフィールドが含まれます。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
color |
string(列挙型) |
Notion UI でレンダリングされるオプションの色。可能な値は次のとおりです。 -blue brown default gray green orange pink purple red yellow |
-"red" |
id |
string |
オプションの識別子。名前が変わっても変わりません。これらは UUID である場合もありますが、常にではありません。 | "ff8e9269-9579-47f7-8f6e-83a84716863c" |
name |
string |
Notion UI に表示されるオプションの名前。 注: コンマ ("," ) は選択値には無効です。 |
"Fruit" |
例 select データベース プロパティ オブジェクト
"Food group": {
"id": "%40Q%5BM",
"name": "Food group",
"type": "select",
"select": {
"options": [
{
"id": "e28f74fc-83a7-4469-8435-27eb18f9f9de",
"name": "🥦Vegetable",
"color": "purple"
},
{
"id": "6132d771-b283-4cd9-ba44-b1ed30477c7f",
"name": "🍎Fruit",
"color": "red"
},
{
"id": "fc9ea861-820b-4f2b-bc32-44ed9eca873c",
"name": "💪Protein",
"color": "yellow"
}
]
}
}
スターテス
ステータス データベース プロパティは、ステータス オプションのリストの値を含む列として Notion UI に表示されます。status型オブジェクトには、optionsオブジェクトの配列とgroupsオブジェクトの配列が含まれます。
options配列は、プロパティで使用可能なステータス オプションのリストをソートしたリストです。配列内の各オプション オブジェクトには、次のフィールドがあります。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
color |
string(列挙型) |
Notion UI でレンダリングされるオプションの色。可能な値は次のとおりです。 -blue brown default gray green orange pink purple red yellow |
"green" |
id |
string |
オプションの識別子。nameが変更されても、id は変更されません。常にではありませんが、UUID の場合もあります。 |
"ff8e9269-9579-47f7-8f6e-83a84716863c" |
name |
string |
Notion UI に表示されるオプションの名前。 注: コンマ (",") はステータス値には無効です。 | "In progress" |
グループは、オプションのコレクションです。groups配列は、プロパティで使用可能なグループの並べ替えられたリストです。配列内の各グループ オブジェクトには、次のフィールドがあります。
| フィールド | タイプ | 説明 | 例の値 |
|---|---|---|---|
color |
string(列挙型) |
Notion UI でレンダリングされるオプションの色。可能な値は次のとおりです。 -blue brown default gray green orange pink purple red yellow |
"purple" |
id |
string |
オプションの識別子。nameが変更されても、 idは変更されません。常にではありませんが、UUID の場合もあります。 |
"ff8e9269-9579-47f7-8f6e-83a84716863c" |
name |
string |
Notion UI に表示されるオプションの名前。 注: コンマ (",") はステータス値には無効です。 | "To do" |
option_ids |
の配列(UUID)string |
グループに属するすべてのオプションのソートされたリスト。id |
以下のstatusオブジェクトの例を参照してください。 |
ステータス データベース プロパティ オブジェクトの例
"Status": {
"id": "biOx",
"name": "Status",
"type": "status",
"status": {
"options": [
{
"id": "034ece9a-384d-4d1f-97f7-7f685b29ae9b",
"name": "Not started",
"color": "default"
},
{
"id": "330aeafb-598c-4e1c-bc13-1148aa5963d3",
"name": "In progress",
"color": "blue"
},
{
"id": "497e64fb-01e2-41ef-ae2d-8a87a3bb51da",
"name": "Done",
"color": "green"
}
],
"groups": [
{
"id": "b9d42483-e576-4858-a26f-ed940a5f678f",
"name": "To-do",
"color": "gray",
"option_ids": [
"034ece9a-384d-4d1f-97f7-7f685b29ae9b"
]
},
{
"id": "cf4952eb-1265-46ec-86ab-4bded4fa2e3b",
"name": "In progress",
"color": "blue",
"option_ids": [
"330aeafb-598c-4e1c-bc13-1148aa5963d3"
]
},
{
"id": "4fa7348e-ae74-46d9-9585-e773caca6f40",
"name": "Complete",
"color": "green",
"option_ids": [
"497e64fb-01e2-41ef-ae2d-8a87a3bb51da"
]
}
]
}
}
🚧API を介してステータス データベースのプロパティの
nameまたはoptions値を更新することはできません。代わりに、Notion UI からこれらの値を更新してください。
タイトル
タイトル データベース プロパティは、データベース行を開いたときにページの上部に表示されるタイトルを制御します。title型オブジェクト自体は空です。追加の構成はありません。
タイトル データベース プロパティ オブジェクトの例
"Project name": {
"id": "title",
"name": "Project name",
"type": "title",
"title": {}
}
🚧すべてのデータベースには、
titleプロパティが 1 つだけ必要です。
titleプロパティなしでデータベースを作成するリクエストを送信した場合、またはtitleプロパティを追加または削除するためにデータベースを更新しようとした場合、 API はエラーをスローします。
📘タイトル データベース プロパティとデータベース タイトル
titleデータベースプロパティは、データベース内の列のタイプです。データベース
titleはデータベースのタイトルを定義し、データベース オブジェクトにあります。すべてのデータベースには、データベース
titleとtitleデータベース プロパティの両方が必要です。
URL
URL データベース プロパティは、URL 値を含む列として Notion UI に表示されます。
urlタイプオブジェクトが空です。追加のプロパティ構成はありません。
URL データベース プロパティ オブジェクトの例
"Project URL": {
"id": "BZKU",
"name": "Project URL",
"type": "url",
"url": {}
}