概要

コメント は Notion 内のページとブロックに存在します。ユーザはページにコメントを追加したり、テキストやその他のブロックなどにコメントを追加できます。このガイドでは、API でコメントを操作する方法を示します。

ページに対するインテグレーションによるコメント

現在、インテグレーションは次の作業を行うことができます。

• ページにコメントを追加
• 既存のディスカッションスレッドにコメントを追加
• ブロックやページのコメントを取得

<aside> 💡 コメントAPIの制限

• API は現在、ブロックに新しいコメントやディスカッションスレッドを作成する機能をサポートしていません。
• API を使ってコメントを更新することはできません。
• API を使って解決済みのコメントを取得することはできません。 </aside>

機能

パブリックAPIでコメントを操作するには、インテグレーションがコメント機能を構成している必要があります。さらに、コメントするページはインテグレーションに共有されている必要があります。

現在、関連する機能は2つあります。一つはコメントを読み込むためのもので、もう一つはコメントを挿入するためのものです。この機能は https://notion.so/my-integrations で編集できます。より詳しい情報については、機能 に関するリファレンスガイドを参照してください。

統合設定ページにおける機能構成

ページにコメントを追加する

add comment to page エンドポイントに rich text 本文を指定することで、ページ上部にコメントを追加できます。

curl -X POST <https://api.notion.com/v1/comments> \\
  -H 'Authorization: Bearer '"$NOTION_API_KEY"'' \\
  -H "Content-Type: application/json" \\
  -H "Notion-Version: 2022-06-28" \\
  --data '
  {
    "parent": {
      "page_id": "59e3eb41-33b2-4151-b05b-31115a15e1c2"
    },
    "rich_text": [
      {
        "text": {
          "content": "Hello from my integration."
        }
      }
    ]
  }
  '

この応答として、作成された comment object を受け取ります。もし、コメント書き込み機能のみで読み込み機能がなかった場合には、応答は id と object フィールドのみを持つ部分オブジェクトになります。

コメントは、統合の名前とアイコンを用いてページに表示されます。

ページまたはブロックのコメントを一覧表示する

retrieve comments エンドポイントを利用して、ページまたはブロックの未解決のコメントを全て一覧表示できます。どちらの場合でもクエリパラメータには block_id を使います(なぜなら ページもブロックだからです)。