メインコンテンツへスキップ

基本的な使用方法

データベースからすべてのアイテムを取得:

型安全性

NotCMSはリスト結果に対して完全な型推論を提供します:

絞り込みと並べ替え

プロパティ名と条件の値はスキーマから推論されます。複数の条件は AND で結合し、固定されたプロパティを含む公開時の値に対して比較します。引数なしの list() は引き続き全件を返します。 同じプロパティの複数演算子を含め、条件は合計10個までです。空の値は、プロパティなし、null、空文字列、空配列です。not_equals は空の値も含みます。null を指定する場合は is_empty を使います。 日付は UTC で比較します。日付のみは UTC 0時(日本時間9時)、タイムゾーン省略時も UTC として扱います。日付範囲は開始日時で比較し、存在しない日付はエラーにします。 sort は配列型を除く1プロパティに "asc" または "desc" を指定します。空の値はどちらでも末尾、同値の場合と sort 省略時は登録順、次にページID順です。未知のプロパティ、非対応の演算子、不正な入力はHTTP 400となり、通常のエラータプルで返します。

本文を含める

list() は既定ではページ本文を返しません。include: ["content"] を渡すと、各ページのMarkdown content を同じリクエストで受け取れます。静的サイトで全記事をビルドする場合などに使います。
結果は get() と同じ、content を持つページの型になります。本文は一覧の他の値と同じく同期済みのコピーから返します。データベースが大きいとレスポンスも大きくなるため、where や id: { in: [...] } と組み合わせて必要なページだけを取得してください。

関連ページをIDで一括取得

relationはNotionのページIDの配列です。関連先のデータベースを選び、1回につき最大100件のIDで取得できます。
重複を除いたIDが100件を超える場合は100件ずつに分割します。空配列は空の結果、100件超はHTTP 400です。未登録・削除済み・未同期・対象外のページは結果に含めません。IDの重複を除き、UUIDのハイフン・大文字小文字を正規化します。結果は通常の並べ替え順で、入力順ではありません。上のようにMapを使うとrelationの順を復元できます(NotionとNotCMSが返す正規形のIDは一致します)。 型は取得先として選んだDBの型です。再帰的に展開しないため、自己参照や循環参照で追加リクエストは発生しません。id: { in: [...] } はページIDを指します。スキーマに id プロパティがある場合、id: { equals: "値" } などの通常条件はそのプロパティに適用されます。 エラータプル・HTTP 429・再試行の扱いはエラーとレート制限を参照してください。

次のステップ

単一アイテムの取得

個別アイテムの取得方法を学ぶ

クライアントの初期化

スキーマとサーバー側の認証情報を設定する