S14. 一覧取得 (Read)

14.1 ページ・ブロックから子ブロック一覧を取得 (Retrieve block children)

14.1.1 基本的な使い方

• 子ブロック一覧を取得する API の説明はこちらです。
Start building with the Notion API
Returns a paginated array of child block objects contained in the block using the ID specified. In order to receive a complete representation of a block, you may need to recursively retrieve the block children of child blocks. Returns only the first level of children for the specified block.

https://developers.notion.com/reference/get-block-children

• 10節(
  2️⃣
  S10. ブロック要素)のブロック一覧を取得したページの URL はこちらです。
📝

ページの URL を記載 例: https://www.notion.so/hkob/be077324015d43a197dcf6be4781a39c

• page_id は末尾の 32 桁の 16 進数です。下の赤字の部分にこの page_id を記述してください。ヘッダ部分はこれまでと変更がないので、SCHEME の部分だけ修正すればよいです。

https://api.notion.com/v1/blocks/ここに上のpage_idを記述/children

• 画面はこんな感じです。

14.1.2 Pagination 処理

• 上で記述した SCHEME の最後に ?page_size=5 を追加します。

https://api.notion.com/v1/blocks/ここに上のpage_idを記述/children?page_size=5

• 取得した next_cursor の情報を記録しておきましょう。
📝

next_cursor の値を記録 例: 30c866e5-8db1-4400-b6bb-a7bde838ddfc

• 上で記述した SCHEME の最後に &start_cursor=指定された値 を追加します。

https://api.notion.com/v1/blocks/ここに上のpage_idを記述/children?page_size=5&start_cursor=ここに指定された値を記述

14.2 データベースからページを検索 (Query a database)

14.2.1 単純なクエリ実行

• これは10節 (
  2️⃣
  S10. ブロック要素) で Property object などを確認したデータベースの URL を同期したものです。
📝

プロパティ確認用データベースの URL を貼り付けます。

例: https://www.notion.so/hkob/7d16fe15159d40a6b6f8aab255c47e6f?v=7569e5029eb7450eaf6b7e6aae0df1c3

• この URL からこのデータベースの ID を取り出して貼り付けておきましょう。
📝

database_id 上の URL の / から ? までの間の 32 桁の 16 進数)

例: 7d16fe15159d40a6b6f8aab255c47e6f

• SCHEME を以下のように設定します。

https://api.notion.com/v1/databases/ここに上の database_id を記述/query

• METHOD を POST に変更します。

• HEADER に Content-Type として application/json を追加します。

• 画面は以下のようになります。

14.2.2 並び替え

• BODY に以下のように記述することで並び替えが実現できます。

{
  "sorts": [
    {
      "property": "ステータス",
      "direction": "ascending"
    },
    {
      "timestamp": "last_edited_time",
      "direction": "descending"
    }
  ]
}

14.2.3 絞り込み

• BODY に以下のように記述することで絞り込みが実現できます。

{
  "filter": {
    "and": [
      {
        "property": "ステータス",
        "status": {
          "equals": "Not started"
        }
      },
      {
        "property": "数値",
        "number": {
          "greater_than_or_equal_to": 1000
        }
      }
    ]
  }
}

14.3 全検索 (Search)

• SCHEME を以下のように設定します。

https://api.notion.com/v1/search

BODY を以下のように設定します。結果として、インテグレーションキーに繋がっているデータベースの一覧が取得できます。

{
  "query": "",
  "filter": {
    "value": "database",
    "property": "object"
  },
  "sort": {
    "direction": "ascending",
    "timestamp": "last_edited_time"
  }
}