APIスキーマのフィールドタイプ
APIの各フィールドの詳細をご説明します。
コンテンツのデータ構造に合わせて、フィールドタイプを選択し、APIを作成しましょう。各フィールドタイプで必須項目、説明文の設定の他、詳細設定を行うことができます。
テキストフィールド
1行のテキストを入力するフィールドです。コンテンツのタイトルやURL入力に適しています。
テキストフィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 重複を許可しない(ユニーク) - 他のコンテンツに同じ値を入力できなくなります。
- 文字数制限 - 文字列の最小文字数、最大文字数を制限します。
- 入力規則 - 正規表現にマッチした値のみ入力できるようになります。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
テキストエリア
複数行のテキストを入力するフィールドです。HTMLテンプレートや、装飾不要のテキストや説明文の入力に適しています。
テキストエリアの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 文字数制限 - 文字列の最小文字数、最大文字数を制限します。
- 表示形式 - テキスト入力欄を指定したフォーマットで表示します。Markdown / HTML / CSS / Javascriptが選択可能です。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
リッチテキスト
リッチエディタを利用した入力フィールドです。リッチエディタの詳細は、「リッチエディタ」のページを参照ください。お知らせやブログの本文などの入力時に適しています。
リッチテキストの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
- スタイルシート - 「リッチエディタのスタイルシート設定」で登録したスタイルシートを選択します。
画像フィールド
メディア管理にアップロードされた画像ファイルを設定するフィールドです。対応している拡張子は以下となります。サムネイル画像、OGP画像、カバー画像などに適しています。
- jpg
- jpeg
- gif
- png
- svg
- webp
- avif
画像フィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
ファイルフィールド
メディア管理にアップロードされたファイルを設定するフィールドです。対応している拡張子は以下となります。
- HTML(html,htm,css,js,json)
- 動画(avi,wmv,mpg,mov,mp4)
- 音声(mp3,wav,m4a,ogg,ogx,mid,midi,aac, flac)
- フォント(ttf,eot,woff,woff2)
- 素材(ai,psd,eps,psb)
- 書類(pdf,txt,doc,docx,xls,xlsx,ppt,pptx,odt,csv,xml,md,openoffice)
- 圧縮(zip,rar,gz,tar,7z)
ファイルフィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
日時フィールド
日時を入力するフィールドです。投稿日などの指定に適しています。
日時フィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 日付のみ - 日付のみ指定できます。(時間指定ができなくなります)
- 繰り返し - フィールドの入力を繰り返しできるようになります。
数字フィールド
半角数字を入力するフィールドです。記事の並び順などの指定に適しています。
数字フィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- データ型 - 小数の有無を選択してください。この設定は後から変更できません。
- 数値制限 - 数値の最小値、最大値を制限します。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
真偽値フィールド
スイッチにて「ON」「OFF」を選択するフィールドです。APIでは、スイッチがONの場合に「true」、OFFの場合に「false」を返します。
真偽値フィールドの詳細設定
-
説明文 - フィールドの説明文を入力画面に表示します。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
セレクトフィールド
項目を指定して選択するフィールドです。複数選択にも対応しています。記事のカテゴリー設定などに適しています。
セレクトフィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 選択肢 - セレクトフィールドの項目を設定します。
- 複数選択可 - 項目を複数選択できるようにします。
- 繰り返し - フィールドの入力を繰り返しできるようになります。
参照フィールド
別のAPIのコンテンツを参照するフィールドです。複数選択にも対応しています。記事編集者のプロフィールや店舗情報など、複数の情報をまとめたものを別APIで管理して掲載することができます。
参照フィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 参照するAPI - 参照するAPIを選択します。
- 複数のコンテンツを参照をする - 参照するAPIから複数のコンテンツを参照できるようになります。この設定は後から変更できません。
カスタムフィールド
複数のフィールドを組み合わせたフィールドです。繰り返し設定を行うことで多彩な表現が可能です。
APIスキーマでカスタムフィールドを追加後、「カスタムフィールドの編集」で、フィールドの編集を行えます。
※カスタムフィールドで選択できるフィールドタイプとして「参照フィールド」には対応しておりません。
カスタムフィールドの詳細設定
- 必須項目 - 設定をONにすると入稿時の入力が必須となります。
- 説明文 - フィールドの説明文を入力画面に表示します。
- 繰り返し - フィールドの入力を繰り返しできるようになります。