ページのプロパティ

👍

ページ プロパティは、Notion UI で行として表される、データベースのエントリであるページを操作するときに最も役立ちます。

ページがデータベースの一部でない場合、使用可能な唯一のプロパティはそのtitleです。

ページオブジェクトは、ページに関するデータを含むページ プロパティで構成されます。

ページ作成へのリクエストを送信するときに、propertiesオブジェクトの body パラメータでページ プロパティを設定します。

ページを取得すると、ページのプロパティの識別子、型、および値が取得されます。ページ プロパティ アイテムを取得すると、単一のプロパティ ID に関する情報が返されます。

ページ更新クエリは、propertiesオブジェクトの body パラメータで指定されたページ プロパティの値を変更します。

各ページ プロパティ値オブジェクトには、次のフィールドが含まれています。

フォールド	タイプ	説明	例の値
id	string	プロパティの基礎となる識別子。idがUUID の場合もありますが、短いランダムな文字列であることがよくあります。idは、ページを作成または更新するときに、名前の代わりに使用できます。プロパティ名が変更されてもidは一定のままです。	"f%5C%5C%3Ap"
type	string(列挙型)	ページ オブジェクトのプロパティの型。 タイプ 固有の 値 の 詳細 について は 、 以下 の 特定 の タイプ の セクション を 参照 し て ください 。checkbox created_by created_time date email files formula last_edited_by last_edited_time multi_select number people phone_number relation rollup rich_text select status title url	"rich_text"
checkbox created_by created_time date email files formula last_edited_by last_edited_time multi_select number people phone_number relation rollup rich_text select status title url	object	ページ プロパティの値など、ページ プロパティの型に固有のデータを含む型オブジェクト。各タイプの説明と例については、タイプ オブジェクトのセクション を参照してください。	"checkbox": true

📘ページ プロパティ値のサイズ制限

特定のページ プロパティ オブジェクトのサイズ制限については、プロパティ値の制限に関するドキュメントを参照してください。

型オブジェクト

チェックボックス

フィールド	タイプ	説明	例の値
checkbox	boolean	チェックボックスがチェックされているか ( true)、チェックされていないか (false )。	true

checkboxページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
    "properties": {
        "Task completed": {
            "checkbox": true
        }
    }
}

GET ページ リクエストで返されるcheckboxページ プロパティ値の例

JSON

"Task completed": {
    "id": "ZI%40W",
  "type": "checkbox",
  "checkbox": true
}

作成されたのは：

フィールド	タイプ	説明	例の値
created_by	object	ページを作成したユーザーに関する情報を含むユーザー オブジェクト。created_byを更新できません。	以下の応答オブジェクトの例を参照してください。

GET ページ リクエストで返されるcreated_byページ プロパティ値の例

JSON

"created_by": {
    "object": "user",
    "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
}

作成時間

フィールド	タイプ	説明	例の値
created_time	string( ISO 8601 の日付と時刻)	ページが作成された日時。 created_time値を更新できません。	"2022-10-12T16:34:00.000Z"

GET ページ リクエストで返されるcreated_timeページ プロパティ値の例

JSON

"Created time": {
    "id": "eB_%7D",
    "type": "created_time",
    "created_time": "2022-10-24T22:54:00.000Z"
}

日付

ページ プロパティ値のtype が "date"の場合、プロパティ値には次のフィールドを持つ"date"オブジェクトが含まれます。

フィールド	タイプ	説明	例の値
end	string( ISO 8601 の日付と時刻)	(オプション) 日付範囲の終了を表す文字列。 値がnull の場合、日付値は範囲ではありません。	"2020-12-08T12:00:00Z"
start	string( ISO 8601 の日付と時刻)	オプションの時間付きの日付。date値が範囲の場合、 start は範囲の開始を表します。	"2020-12-08T12:00:00Z”

日付ページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのpropertiesbody パラメータの例

JSON

{
    "properties": {
        "Due date": {
            "date": {
                  "start": "2023-02-23"
                }
        }
    }
}

GET ページ リクエストで返されるdateページ プロパティ値の例

JSON

"Due date": {
    "id": "M%3BBw",
  "type": "date",
  "date": {
      "start": "2023-02-07",
    "end": null,
    "time_zone": null
 }

電子メール

フィールド	タイプ	説明	例の値
email	string	電子メール アドレスを説明する文字列。	"ada@makenotion.com"

emailページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
    "properties": {
        "Email": {
            "email": "ada@makenotion.com"
        }
    }
}

GET ページ リクエストで返されるemailページ プロパティ値の例

JSON

"Email": {
    "id": "y%5C%5E_",
    "type": "email",
    "email": "ada@makenotion.com"
}

ファイル

📘

Notion API は、Notion へのファイルのアップロードをまだサポートしていません。

フィールド	タイプ	説明	例の値
files	ファイル オブジェクトの配列	ファイルに関する情報を含むオブジェクトの配列。	以下の応答オブジェクトの例を参照してください。

filesページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
  "properties": {
    "Blueprint": {
      "files": [
        {
          "name": "Project Alpha blueprint",
          "external": {
            "url": "https://www.figma.com/file/g7eazMtXnqON4i280CcMhk/project-alpha-blueprint?node-id=0%3A1&t=nXseWIETQIgv31YH-1"
          }
        }
      ]
    }
  }
}

GET ページ リクエストで返されるfilesページ プロパティ値の例

JSON

"Blueprint": {
    "id": "tJPS",
  "type": "files",
  "files": [
      {
        "name": "Project blueprint",
      "type": "external",
      "external": {
          "url": "https://www.figma.com/file/g7eazMtXnqON4i280CcMhk/project-alpha-blueprint?node-id=0%3A1&t=nXseWIETQIgv31YH-1"
      }
    }
  ]
}

📘fileページ プロパティ値を更新すると、渡されたファイルの配列によって値が上書きされます。

Notion は API を介したファイルのアップロードをサポートしていませんが、 Notion がホストするファイルを含むfileオブジェクトを渡すと 、それはファイルの 1 つとして残ります。ファイルを削除するには、更新応答でそれを渡さないでください。

方式

Formula プロパティ値オブジェクトは、データベースの propertiesに記述されている式を評価した結果を表します。

ページ プロパティ値のtype が "formula"の場合、プロパティ値には次のフィールドを持つ"formula"オブジェクトが含まれます。

フィールド	タイプ	説明	例の値
boolean		date
type	string(列挙型)	数式の結果のデータ型を示す文字列。可能な値は次のとおりです。 -type boolean date number string	"number"

GET ページ リクエストで返されるformulaページ プロパティ値の例

JSON

"Days until launch": {
    "id": "CSoE",
  "type": "formula",
  "formula": {
      "type": "number",
    "number": 56
  }
}

📘

ページの取得エンドポイントは、formulaプロパティの最大 25 のインライン ページまたは個人参照を返します。formulaプロパティに 25 を超える参照が含まれている 場合は、特定のformulaプロパティの [ページ プロパティ アイテムの取得] エンドポイントを使用して、参照の完全なリストを取得できます。

最終編集者

フィールド	タイプ	説明	例の値
last_edited_by	object	ページを最後に更新したユーザーに関する情報を含むユーザー オブジェクト。last_edited_byを更新できません。	以下の応答オブジェクトの例を参照してください。

GET ページ リクエストで返されるlast_edited_byページ プロパティ値の例

JSON

"Last edited by column name": {
    "id": "uGNN",
  "type": "last_edited_by",
  "last_edited_by": {
      "object": "user",
    "id": "9188c6a5-7381-452f-b3dc-d4865aa89bdf",
    "name": "Test Integration",
      "avatar_url": "https://s3-us-west-2.amazonaws.com/public.notion-static.com/3db373fe-18f6-4a3c-a536-0f061cb9627f/leplane.jpeg",
    "type": "bot",
    "bot": {}
  }
}

最終編集時刻

フィールド	タイプ	説明	例の値
last_edited_time	string( ISO 8601 の日付と時刻)	ページが最後に編集された日時。 last_edited_time値を更新できません。	"2022-10-12T16:34:00.000Z"

GET ページ リクエストで返されるlast_edited_timeページ プロパティ値の例

JSON

"Last edited time": {
    "id": "%3Defk",
  "type": "last_edited_time",
  "last_edited_time": "2023-02-24T21:06:00.000Z"
}

複数選択

ページ プロパティ値の typeが"multi_select" の場合、プロパティ値には次のフィールドを持つ"multi_select"配列が含まれます。

フィールド	タイプ	説明	例の値
color	string(列挙型)	オプションの色。"color" の可能な値は次 のとおりです。 - blue brown default gray green orange pink" "purple red yellow デフォルトはdefault です 。API 経由でcolor値を更新することはできません。	"red"
id	string(UUIDv4)	オプションの ID。idまたは nameを使用して、複数選択プロパティを更新 できます。	"b3d773ca-b2c9-47d8-ae98-3c2ce3b2bffb"
name	string	Notion に表示されるオプションの名前。 複数選択データベース プロパティにその名前のオプションがまだない場合、統合に親データベースへの書き込みアクセス権もあれば、その名前がデータベース スキーマに追加されます。 注: コンマ ( ",") は選択値には無効です。	"JavaScript"

multi_selectページ プロパティ値を作成または更新する POST または PATCH ページ リクエストの propertiesbody パラメータの例

JSON

{
  "properties": {
    "Programming language": {
      "multi_select": [
        {
          "name": "TypeScript"
        },
        {
          "name": "Python"
        }
      ]
    }
  }
}

GET ページ リクエストで返されるmulti_selectページ プロパティ値の例

JSON

"Programming language": {
    "id": "QyRn",
  "name": "Programming language",
  "type": "multi_select",
  "multi_select": {
      "options": [
        {
          "id": "tC;=",
        "name": "TypeScript",
        "color": "purple"
      },
      {
        "id": "e4413a91-9f84-4c4a-a13d-5b4b3ef870bb",
        "name": "JavaScript",
        "color": "red"
      },
      {
          "id": "fc44b090-2166-40c8-8c58-88f2d8085ec0",
        "name": "Python",
        "color": "gray"
      }
      ]
    }
}

📘

更新ページまたは更新データベースエンドポイントを介して複数選択プロパティに新しいオプションを追加する場合、統合には親データベースへの書き込みアクセスが必要です。

番号

フィールド	タイプ	説明	例の値
number	number	値を表す数値。	1234

numberページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
  "properties": {
    "Number of subscribers": {
        "number": 42
    }
  }
}

GET ページ リクエストで返されるnumberページ プロパティ値の例

JSON

"Number of subscribers": {
    "id": "WPj%5E",
  "name": "Number of subscribers",
  "type": "number",
    "number": {
        "format": "number"
  }
}

人

フィールド	タイプ	説明	例の値
people	ユーザー オブジェクトの配列	ユーザー オブジェクトの配列。	以下の応答オブジェクトの例を参照してください。

peopleページ プロパティ値を作成または更新する POST または PATCH ページ リクエストの propertiesbody パラメータの例

JSON

{
  "properties": {
    "Stakeholders": {
        "people": [{
            "object": "user",
            "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
        }
        ]
    }
  }
}

GET ページ リクエストで返されるpeopleページ プロパティ値の例

JSON

"Stakeholders": {
    "id": "%7BLUX",
  "type": "people",
  "people": [
      {
        "object": "user",
      "id": "c2f20311-9e54-4d11-8c79-7398424ae41e",
      "name": "Kimberlee Johnson",
      "avatar_url": null,
      "type": "person",
      "person": {
          "email": "hello@kimberlee.dev"
      }
    }
  ]
}

📘

ページの取得エンドポイントは、 1 peopleページあたり 25 人を超えるユーザーを返すことを保証できません 。peopleページ プロパティに 25 人を超えるユーザーが含まれている 場合 、特定のpeopleプロパティの [ ページ プロパティ アイテムの取得] エンドポイントを使用して、ユーザーの完全なリストを取得できます。

電話番号

フィールド	タイプ	説明	例の値
phone_number	string	電話番号を表す文字列。電話番号の形式は強制されません。	"415-867-5309"

phone_numberページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
  "properties": {
    "Contact phone number": {
        "phone_number": "415-202-4776"
    }
  }
}

GET ページ リクエストで返されるphone_numberページ プロパティ値の例

JSON

"Example phone number property": {
    "id": "%5DKhQ",
  "name": "Example phone number property",
  "type": "phone_number",
  "phone_number": {}
}

関係

フィールド	タイプ	説明	例の値
has_more	boolean	relationに 25 を超える参照がある 場合 、 応答オブジェクトのリレーションのhas_more値は trueです 。リレーションが制限を超えない場合は、has_moreはfalse です 。	以下の応答オブジェクトの例を参照してください。
relation	ページ参照の配列	関連するページ参照の配列。 ページ参照は、idキーと別のデータベースのページ ID に対応する文字列値 (UUIDv4)を持つオブジェクトです 。	以下の応答オブジェクトの例を参照してください。

relationページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
  "properties": {
    "Related tasks": {
      "relation": [
        {
          "id": "dd456007-6c66-4bba-957e-ea501dcda3a6"
        },
        {
          "id": "0c1f7cb2-8090-4f18-924e-d92965055e32"
        }
      ]
    }
  }
}

GET ページ リクエストで返されるrelationページ プロパティ値の例

JSON

"Related tasks": {
    "id": "hgMz",
  "type": "relation",
  "relation": [
      {
        "id": "dd456007-6c66-4bba-957e-ea501dcda3a6"
    },
    {
      "id": "0c1f7cb2-8090-4f18-924e-d92965055e32"
    }
    ],
  "has_more": false
}

📘API を介してrelationプロパティ値を更新するには、関連する親データベースを統合と共有します。

📘

relationプロパティ値が予期せず空である場合は、 relationが指す元のソース データベースを統合で共有していることを確認してください。

ロールアップ

ページ プロパティ値のtype が "rollup"の場合、プロパティ値には次のフィールドを持つ"rollup"オブジェクトが含まれます。

フィールド	タイプ	説明	例の値
array		date
function	string(列挙型)	ロールアップの関係でページごとに評価される関数。可能な値 は 次のとおり です。 -"function" average checked count count_per_group 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 show_original show_unique sum unchecked unique	"sum"
type	array		date

GET ページ リクエストで返されるrollupページ プロパティ値の例

JSON

"Related tasks": {
    "id": "hgMz",
  "type": "relation",
  "relation": [
      {
        "id": "dd456007-6c66-4bba-957e-ea501dcda3a6"
    },
    {
      "id": "0c1f7cb2-8090-4f18-924e-d92965055e32"
    }
    ],
  "has_more": false
}

📘

ロールアップ プロパティ値に関するデータのクエリの詳細については、ページ プロパティ アイテムの取得エンドポイントのドキュメントを参照してください。

🚧API は、rollupページ プロパティ値の更新をサポートしていません。

ページのrollupプロパティを変更するには、Notion UI を使用します。

リッチテキスト

フィールド	タイプ	説明	例の値
rich_text	リッチ テキスト オブジェクトの配列	リッチ テキスト オブジェクトの配列	以下の応答オブジェクトの例を参照してください。

rich_textページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの 例

JSON

{
  "properties": {
    "Description": {
      "rich_text": [
        {
          "type": "text",
          "text": {
            "content": "There is some ",
            "link": null
          },
          "annotations": {
            "bold": false,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": "There is some ",
          "href": null
        },
        {
          "type": "text",
          "text": {
            "content": "text",
            "link": null
          },
          "annotations": {
            "bold": true,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": "text",
          "href": null
        },
        {
          "type": "text",
          "text": {
            "content": " in this property!",
            "link": null
          },
          "annotations": {
            "bold": false,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": " in this property!",
          "href": null
        }
      ]
    }
  }
}

GET ページ リクエストで返されるrich_textページ プロパティ値の例

JSON

"Description": {
  "id": "HbZT",
  "type": "rich_text",
  "rich_text": [
    {
      "type": "text",
      "text": {
        "content": "There is some ",
        "link": null
      },
      "annotations": {
        "bold": false,
        "italic": false,
        "strikethrough": false,
        "underline": false,
        "code": false,
        "color": "default"
      },
      "plain_text": "There is some ",
      "href": null
    },
    {
      "type": "text",
      "text": {
        "content": "text",
        "link": null
      },
      "annotations": {
        "bold": true,
        "italic": false,
        "strikethrough": false,
        "underline": false,
        "code": false,
        "color": "default"
      },
      "plain_text": "text",
      "href": null
    },
    {
      "type": "text",
      "text": {
        "content": " in this property!",
        "link": null
      },
      "annotations": {
        "bold": false,
        "italic": false,
        "strikethrough": false,
        "underline": false,
        "code": false,
        "color": "default"
      },
      "plain_text": " in this property!",
      "href": null
    }
  ]
}

📘

ページの取得エンドポイントは、rich_textプロパティの最大 25 個の入力済みインライン ページまたは個人参照を返します。rich_textプロパティに 25 を超える参照が含まれている場合は、特定のrich_textプロパティの [ページ プロパティ アイテムの取得] エンドポイントを使用して、参照の完全なリストを取得できます。

選択

ページ プロパティ値のタイプが selectの場合、プロパティ値には次のフィールドを持つselectオブジェクトが含まれます。

プロパティ	タイプ	説明	例の値
color	string(列挙型)	オプションの色。"color"の可能な値は次のとおりです: - blue brown default gray green orange pink purple red Defaults のデフォルト色値はyellow、 API 経由で更新できません。	red
id	string(UUIDv4)	オプションの ID。idまたはname を使用して、 select プロパティを更新 できます。	"b3d773ca-b2c9-47d8-ae98-3c2ce3b2bffb"
name	string	Notion に表示されるオプションの名前。 select database プロパティにその名前のオプションがまだない場合、統合に親データベースへの書き込みアクセス権もあれば、その名前がデータベース スキーマに追加されます。 注: コンマ ("," ) は選択値には無効です。	"jQuery"

selectページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの 例

JSON

{
  "properties": {
    "Department": {
      "select": {
        "name": "Marketing"
      }
    }
  }
}

例 GET ページ要求で返される選択ページ プロパティ値

JSON

"Department": {
    "id": "Yc%3FJ",
  "type": "select",
  "select": {
      "id": "ou@_",
    "name": "jQuery",
    "color": "purple"
  }
}

スターテス

ページ プロパティ値のタイプが の場合、プロパティ値には次のフィールドを持つオブジェクトが含まれます。status``status

財産	タイプ	説明	例の値
color	string(列挙型)	オプションの色。"color" の可能な値は次 のとおりです。 - blue brown default gray green orange pink purple red yellow デフォルトは defaultです 。API 経由でcolor値を更新することはできません。	"red"
id	string(UUIDv4)	string(UUIDv4)	"b3d773ca-b2c9-47d8-ae98-3c2ce3b2bffb"
name	string	Notion に表示されるオプションの名前。	"In progress"

statusページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
  "properties": {
    "Status": {
      "status": {
        "name": "Not started"
      }
    }
  }
}

GET ページ リクエストで返されるstatusページ プロパティ値の例

JSON

"Status": {
    "id": "Z%3ClH",
  "type": "status",
  "status": {
      "id": "539f2705-6529-42d8-a215-61a7183a92c0",
    "name": "In progress",
    "color": "blue"
  }
}

タイトル

フィールド	タイプ	説明	例の値
title	リッチ テキスト オブジェクトの配列	リッチ テキスト オブジェクトの配列。	以下の応答オブジェクトの例を参照してください。

titleページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
  "properties": {
    "Title": {
      "id": "title",
      "type": "title",
      "title": [
        {
          "type": "text",
          "text": {
            "content": "A better title for the page",
            "link": null
          },
          "annotations": {
            "bold": false,
            "italic": false,
            "strikethrough": false,
            "underline": false,
            "code": false,
            "color": "default"
          },
          "plain_text": "This is also not done",
          "href": null
        }
      ]
    }
  }
}

GET ページ リクエストで返されるtitleページ プロパティ値の例

JSON

"Title": {
  "id": "title",
  "type": "title",
  "title": [
    {
      "type": "text",
      "text": {
        "content": "A better title for the page",
        "link": null
      },
      "annotations": {
        "bold": false,
        "italic": false,
        "strikethrough": false,
        "underline": false,
        "code": false,
        "color": "default"
      },
      "plain_text": "This is also not done",
      "href": null
    }
  ]
}

📘

ページの取得エンドポイントは、titleプロパティの最大 25 のインライン ページまたは個人参照を返します。titleプロパティに 25 を超える参照が含まれている 場合は、特定のtitleプロパティの [ページ プロパティ アイテムの取得] エンドポイントを使用して、参照の完全なリストを取得できます。

URL

フィールド	タイプ	説明	例の値
url	string	Web アドレスを説明する文字列。	"https://developers.notion.com/"

urlページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties body パラメータの例

JSON

{
  "properties": {
    "Website": {
      "url": "https://developers.notion.com/"
    }
  }
}

GET ページ リクエストで返されるurlページ プロパティ値の例

JSON

"Website": {
    "id": "bB%3D%5B",
  "type": "url",
  "url": "https://developers.notion.com/"
}

ページ分割されたページのプロパティ

title、rich_text、relationおよびpeopleページプロパティは、個々のproperty_itemオブジェクトのページ分割されたlistオブジェクトとして返されます。

listオブジェクトで見つかったプロパティの要約セットを以下に示します。詳細については、ページネーションのドキュメントを参照してください。

フィールド	タイプ	説明	例の値
object	"list"	常に"list"	"list"
type	"property_item"	常に"property_item"	"property_item"
results	list	property_itemオブジェクトのリスト。	[{"object": "property_item", "id": "vYdV", "type": "relation", "relation": { "id": "535c3fb2-95e6-4b37-a696-036e5eac5cf6"}}... ]
property_item	object	プロパティを説明するproperty_itemオブジェクト。	{"id": "title", "next_url": null, "type": "title", "title": {}}
next_url	stringまたnull	結果の次のページを取得するためにユーザーが要求できる URL。	"http://api.notion.com/v1/pages/0e5235bf86aa4efb93aa772cce7eab71/properties/vYdV?start_cursor=LYxaUO&page_size=25"