メインコンテンツへスキップ
ページIDが分かっているなら get、slugなどのプロパティで探すなら getFirst を使います。 どちらもページのプロパティとMarkdownの本文 content を返します。 以下のデータベース名・プロパティ名は、生成したスキーマに合わせてください。

IDで取得する

IDは特定のページを指します。タイトルやslugが変わっても同じページを参照したい場合に使います。
ページが存在しなければ get はエラーを返します。空のページとしては扱いません。

プロパティで探す

プロパティによる検索は、サイトの条件に合うページを探します。たとえば、公開済みの記事をslugで取得します。
一致するページがなければ post は null です。アプリではその結果を使って404を表示できます。 リクエスト自体の失敗は、ページなしではなくエラーとして扱います。
getFirst は NotCMS 0.5.0 以降で利用できます。利用前に notcms パッケージを更新してください。

どの1件を選ぶか

where と sort は list() と同じです。複数のページが一致した場合は、 その並び順の先頭を返します。一意性を保証する機能ではありません。
「最初の1件」に意味がある場合は、並び順を指定します。slugのルートでは、編集時に重複を避け、 変更時のリダイレクトをサイト側で管理します。言語別slugやIDによる代替は URLレシピを参照してください。

画像とファイル

Notion自体のファイルURLは署名付きで、約1時間で失効します。NotCMSは画像、files プロパティのファイル、 Notionにアップロードされたファイル・PDF・動画ブロックのファイルを保存し、 https://api.notcms.com/v1/images/{id} として返します。このURLは失効しないため、静的にビルドしたページに埋め込めます。
  • 同期直後はファイルのコピー中のため、短時間 202 と Retry-After を返すことがあります。
  • 画像はインラインで表示します。それ以外のファイルはダウンロード(Content-Disposition: attachment)として配信します。
  • 1ファイルの上限は20 MiBです。超えるファイルは保存できず、URLはエラーを返します。大きな動画は外部ホストのリンクにしてください。
  • 外部リンク、埋め込み、ブックマーク、外部URLを指すファイル・動画ブロックは元のURLのままです。

結果を扱う

型は生成スキーマから推論されます。ページを使う前に error を確認し、getFirst では null も扱います。 再試行の判断はエラーとレート制限を参照してください。
  • getFirst は limit=1&include=content を付けた一覧取得を1回だけ送ります。転送するのは先頭の1件とその本文だけです。
  • getFirst は list と同じく、NotCMSへ同期済みの内容を返します。get と違いNotionへは問い合わせないため、最後の同期より後の変更(アクセスできなくなったページなど)は次の同期後に反映されます。
  • 並び順の省略時や同値の場合は、登録順、次にページIDで並びます。
  • タプルの3番目は成功時と該当なし時に一覧レスポンス、失敗時に失敗したレスポンスです。ネットワーク障害では undefined になります。SDKは自動再試行しません。