新しくなった Notion API reference : hkob の雑記録 (392)

はじめに

hkob の雑記録の第392回目(通算789日目)は、昨日更新されていることを確認した新しい Notion API reference について説明します。

以前の API reference

内容の説明ページのスクリーンショットは撮っていなかったのですが、Notion API 活用術の説明でスクリプトの説明部分が残っていました。以前は、こんな感じでテキストで例が示されていました。

以前のリファレンスページ

Notion API 活用術では、この例を参考に Talend API Tester という Chrome 機能拡張を使って API 呼び出しを実行してもらっていました。

Talend API Tester

新しいリファレンスページ

新しいリファレンスページのスクリーンショットを撮ってみました。気になるところをいくつか解説してみます。

新しいリファレンスページ

Copy page のボタンをクリックするとこんなプルダウンメニューが出てきます。このページをネタに様々な AI service に質問できるようになっているようですね。

Copy page

なお、一番下にはこのページについて直接質問できるようです。Notion AI が回答してくれるのでしょう。

Ask a question

実際に Cmd-I を押してみたら、サイドバーで Assistant のインスペクタが表示されました。

Assistant inspector

右側にはこれまでと同様に実際の利用方法が表示されています。以前と異なり、パラメータなどのダミーデータが入っていません。これについては、この後説明します。また、HTTP status に対応したレスポンスのサンプルも下に掲載されています。ここまではあくまでサンプルです。

Script and Response

なお、上では cURL のものが掲載されていますが、ここをクリックすると以下のように言語が選択できます。

Select language

新機能 Try it

今回の目玉は画面中央に置かれている Try it だと思います。クリックすると以下のような画面が出てきます。先ほど上で表示した Talend API Tester と同じことがこのページ上で実行できるということですね。

Try it!

ここで、Authorization の bearer token や Notion-Version を選択すると、自動的に右のスクリプト部分が変更されています。

パラメータの入力

実際に別の言語に変更してもスクリプトの定数も正しく変更されています。

Ruby script

実際に実行してみると、以下のように成功のメッセージが表示されました。

成功時のリファレンス

残存するバグ

まだ作成されたばかりでいくつかバグが残っているようです。例えば、Query a data source API で filter を選択しようとすると filter の横が object となっています。ここは本当は date と表示して欲しいところです。また、filter.date の横の部分も object となっていますが、ここは equals になるはずです。実際に選択しようとしても全部が object になっていて、選択してみないと中身がわからない状態になっています。これについては、アンバサダーの Slack にバグレポートを送っています。そのうち修正されるでしょう。

Query a data source

おわりに

Selector のバグが修正されたら、現在 Notion API 活用術で Talend API Tester を使っている部分を全部リファレンスの Try it に変更するつもりです。この機能拡張のためにわざわざ Chrome をインストールしてもらっていましたが、その必要がなくなりますね。

hkob.notion.site