Skip to content

カスタムフィールド

エンドポイントごとに独自のフィールド(価格、発売日など)を定義し、コンテンツに構造化データを持たせられます。

カスタムフィールドとは

コンテンツは標準で「タイトル」と「本文」を持ちますが、カスタムフィールドを定義すると、エンドポイントごとに任意の入力項目を追加できます。定義したフィールドの値はコンテンツAPIのレスポンスにそのまま含まれます。

API設定を開く

権限

スキーマの変更には Admin 権限が必要です。Admin 以外は閲覧のみ可能です。

  1. エンドポイントのコンテンツ一覧を開く
  2. 右上の「API設定」をクリック

API設定ページ

フィールドの追加

フィールド追加」をクリックし、以下を設定します。

項目説明
フィールドIDAPIレスポンスのキー。小文字英字始まり、英数字と _(最大64字)
表示名コンテンツ編集画面に表示される名前
下記7種から選択
必須オンにすると保存時に入力が必須になる
説明入力欄に表示される補足(任意)

フィールド追加ダイアログ

フィールドの型

入力内容APIでの値
テキスト1行テキスト(1,000字まで)文字列
テキストエリア複数行テキスト(50,000字まで)文字列
数値数値数値
真偽値オン/オフtrue / false
日付日付"YYYY-MM-DD"
セレクト定義した選択肢から選択(複数選択も可)文字列 または 文字列の配列
画像メディアから画像を選択画像オブジェクト(URL含む)

フィールドIDの予約語

id title data published_at など、APIレスポンスの標準キーはフィールドIDに使えません。

並び替え・編集・削除

  • 「並び替え」列の上下ボタンで表示順を変更できます(この順番でコンテンツ編集画面とAPIに反映されます)
  • 鉛筆アイコンで編集、ゴミ箱アイコンで削除できます
  • 変更は「保存」をクリックするまで反映されません

コンテンツへの入力

フィールドを定義すると、そのエンドポイントのコンテンツ編集画面に「カスタムフィールド」セクションが表示され、型に応じた入力欄で値を編集できます。

コンテンツ編集画面のカスタムフィールド

  • 通常の編集では「保存」で本文と一緒に保存されます
  • 協調編集が有効な場合は、セクション内の「フィールドを保存」で保存します(本文はリアルタイム同期のまま影響を受けません)
  • 必須フィールドが未入力の場合は保存できません

APIレスポンス

カスタムフィールドの値は、コンテンツAPIのレスポンスのトップレベルにフィールドIDをキーとして展開されます。

json
{
  "id": "abc123",
  "title": "新商品発売",
  "price": 1500,
  "color": "red",
  "release_date": "2026-08-01",
  "data": { "blocks": [...] },
  "published_at": "2026-07-12T10:06:33Z"
}

スキーマ変更と既存コンテンツ

  • フィールドを削除・変更しても、既存コンテンツの保存済みの値はそのまま残り、APIも従来どおり返します
  • 既存コンテンツを次に保存したタイミングで、現在のスキーマに合わない値は取り除かれます

©2025 Hayato Iwasaki