ページのプロパティ
ページのプロパティ
👍
ページ プロパティは、Notion UI で行として表される、データベースのエントリであるページを操作するときに最も役立ちます。 ページがデータベースの一部でない場合、使用可能な唯一のプロパティはその title
です。
properties
オブジェクトの body パラメータでページ プロパティを設定します。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 パラメータの例
{
"properties": {
"Task completed": {
"checkbox": true
}
}
}
GET ページ リクエストで返されるcheckbox
ページ プロパティ値の例
"Task completed": {
"id": "ZI%40W",
"type": "checkbox",
"checkbox": true
}
作成されたのは:
フィールド | タイプ | 説明 | 例の値 |
---|---|---|---|
created_by | object | ページを作成したユーザーに関する情報を含むユーザー オブジェクト。created_by を更新できません。 | 以下の応答オブジェクトの例を参照してください。 |
GET ページ リクエストで返されるcreated_by
ページ プロパティ値の例
"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
ページ プロパティ値の例
"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 ページ リク エストのproperties
body パラメータの例
{
"properties": {
"Due date": {
"date": {
"start": "2023-02-23"
}
}
}
}
GET ページ リクエストで返されるdate
ページ プロパティ値の例
"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 パラメータの例
{
"properties": {
"Email": {
"email": "ada@makenotion.com"
}
}
}
GET ページ リクエストで返されるemail
ページ プロパティ値の例
"Email": {
"id": "y%5C%5E_",
"type": "email",
"email": "ada@makenotion.com"
}
ファイル
📘
Notion API は、Notion へのファイルのアップロードをまだサポートしていません。
フィールド | タイプ | 説明 | 例の値 |
---|---|---|---|
files | ファイル オブジェクトの配列 | ファイルに関する情報を含むオブジェクトの配列。 | 以下の応答オブジェクトの例を参照してください。 |
files
ページ プロパティ値を作成または更新する POST または PATCH ページ リクエストのproperties
body パラメータの例
{
"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
ページ プロパティ値の例
"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 つとして残ります。ファイルを削除するには、更新応答でそれを渡さないでください。
方式
type
が "formula"
の場合、プロパティ値には次のフィールドを持つ"formula"
オブジェクトが含まれます。フィールド | タイプ | 説明 | 例の値 |
---|---|---|---|
boolean | date | ||
type | string (列挙型) | 数式の結果のデータ型を示す文字列。可能な値は次のとおりです。 -type boolean date number string | "number" |
GET ページ リクエストで返されるformula
ページ プロパティ値の例
"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
ページ プロパティ値の例
"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
ページ プロパティ値の例
"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 ページ リクエストの properties
body パラメータの例
{
"properties": {
"Programming language": {
"multi_select": [
{
"name": "TypeScript"
},
{
"name": "Python"
}
]
}
}
}
GET ページ リクエストで返されるmulti_select
ページ プロパティ値の例
"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 |