後に述べる破壊的変更を含む Notion-Version 2021-08-16 をリリースした。

不明なキーは検証に失敗する

これまで未知のキーに対する処理の対応が曖昧だったので、API で処理できないキーが渡されたときにはエラーが返るようになった。

安全に 2021-08-16 にアップデートする場合には、2021-08-16 バージョンに変更後、テストを徹底的に実施するべきとのこと。テストしてキーがリジェクトされないことを確認する必要がある

配列ロールアッププロパティタイプの変更

Notion-Version header 2021-08-16から、配列形式のルールアップのプロパティタイプが変更になった。ただし、数字と日付のロールアップは変更にならない。配列ロールアップの type は他の API のプロパティタイプと同じ形になった。 例が紹介されているけど省略。

変更前 変更後
type: "file" type: "files"
type: "text" type: "rich_text"
type: "person" type: "people"

配列ブロックの子追加はブロックのリストを返す

配列ブロック子追加 は、作成した ブロックオブジェクト の子供のリストを返す。

以前は親のブロックが返されていた。もし同じように親のブロックを取得したい場合には、 block_id から Retrieve a block を実行する。

今回の変更で block_id と新しい追加されたブロックの情報が同時に取得できる。ただし、取得できるのは最初の子供のレベルの情報だけとのこと。さらに下のレベルのものを取得する場合には、 Retrieve block children を使って取得する。これも検証は省略する。

プロパティIDが URL セーフになった

処理結果で返ってくるプロパティ名が URL セーフになった。プロパティ ID を使用する Update a databaseUpdate a page などでは、新しい URL セーフの ID を使用する必要がある。

逆にいうと、URL セーフになったため、全てのプロパティは URL で参照できるようになった。

変更前 変更後
DoS\ DoS%5C
title title
vEKn vEKn

空のデータベースプロパティが返るようになった

以前は、空の日付、メールアドレス、数値、ロールアップのプロパティは表示されていなかった。今回の更新で、空のプロパティは null 値として表示されるようになった。これも例が示されているが省略


Notion API Changelog まとめ