データベースのプロパティを更新する
データベースのプロパティを更新する
API は、Notion UI のデータベースの列をデータベース プロパティとして表します。
API を使用してデータベースのプロパティを更新するには、properties
body パラメータを指定してPATCH リクエストを送信します。
プロパティを削除する
データベース プロパティを削除するには、プロパティ オブジェクトを null に設定します。
ID によるプロパティの削除
"properties": {
"J@cT": null,
}
名前によるプロパティの削除
"properties": {
"propertyToDelete": null
}
プロパティの名前を変更する
データベース プロパティの名前を変更するには、name
プロパティ オブジェクトの値で新しい名前を指定します。
ID によるプロパティの名前変更
"properties": {
"J@cT": {
"name": "New Property Name"
}
}
名前によるプロパティの名前変更
"properties": {
"Old Property Name": {
"name": "New Property Name
}
}
財産 | タイプ | 説明 |
---|---|---|
name |
string |
Notion に表示されるプロパティの名前。 |
プロパティ タイプの更新
プロパティ タイプを更新するには、プロパティ スキーマ オブジェクトにそのタイプのキーが含まれている必要があります。このタイプには、このプロパティの動作が含まれます。このキーの可能な値は"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"
です。このプロパティ内では、構成はプロパティ スキーマ オブジェクトです。
❗️制限事項
title
のプロパティ タイプは変更できないことに注意してください。API を介して
status
プロパティのname
またはoptions
値を更新することはできません。
構成の更新を選択
既存の選択構成を更新するために、プロパティ スキーマ オブジェクトには、オプションでselect
プロパティ内に次の構成が含まれます。
財産 | タイプ | 説明 | 例の値 |
---|---|---|---|
options |
オプションの既存の選択オプションの配列と選択オプション オブジェクト | 選択したプロパティの設定。既存のオプションを省略すると、データベース プロパティから削除されます。データベース プロパティに新しいオプションが追加されます。 |
既存の選択オプション
既存のオプションの名前と色は更新できないことに注意してください。
財産 | タイプ | 説明 | 例の値 |
---|---|---|---|
name |
オプションstring |
オプションの名前。 | "Fruit" |
id |
オプションstring |
オプションの ID。 | "ff8e9269-9579-47f7-8f6e-83a84716863c" |
複数選択構成の更新
既存の選択構成を更新するために、プロパティ スキーマ オブジェクトには、オプションでmulti_select
プロパティ内に次の構成が含まれます。
財産 | タイプ | 説明 | 例の値 |
---|---|---|---|
options |
既存の選択オプションおよび複数選択オプション オブジェクトのオプションの配列 | 複数選択プロパティの設定。既存のオプションを省略すると、データベース プロパティから削除されます。データベース プロパティに新しいオプションが追加されます。 |
既存の複数選択オプション
既存のオプションの名前と色は更新できないことに注意してください。
財産 | タイプ | 説明 | 例の値 |
---|---|---|---|
name |
string |
Notion に表示されるオプションの名前。 | "Fruit" |
id |
オプションstring |
オプションの ID。 | "ff8e9269-9579-47f7-8f6e-83a84716863c" |
制限事項
フォーミュラ最大深度
Notion の数式は、API が 1 回のリクエストで計算できるレベルを超えた高度な複雑さを持つ場合があります。formula
プロパティ値が10 の参照テーブルの深さを超えている場合 、API は「式の深さ」エラーを"validation_error"
のように返します。
回避策として、データベースの取得エンドポイントからformula
プロパティ オブジェクトを取得し、式を使用してより複雑な式の値を計算できます。
サポートされていないロールアップ集計
ロールアップ値の計算のエンコードされたカーソルの性質により、集計タイプのサブセットはサポートされていません。代わりに、エンドポイントは次のロールアップ集計のすべてのproperty_item オブジェクトのリストを返します。
show_unique
(一意の値を表示)unique
(一意の値をカウント)median
(中央値)
Could not find page/database
エラー
rollup
とformula
のタイプのページ プロパティであり、別のrelation
ページのプロパティに基づいて値を計算することができます。そのため、インテグレーションには他のrelation
ページへのアクセス許可が必要です。インテグレーションにプロパティ値の計算に必要なアクセス許可ページがない場合、API は、インテグレーションにアクセス許可がないページを指定する"object_not_found"
エラーを返します。
ページネーション後のプロパティ値が UI と一致しない
プロパティ値にページネーションが含まれており、プロパティ値の計算に使用される基礎となるプロパティまたはページが、インテグレーションが結果を介してページネーションされている間に変更された場合、最終的な値が影響を受け、正確であることが保証されません。