コンテンツ定義で利用できる項目設定一覧

コンテンツは、デフォルトで下の3項目が表示されます。

コンテンツID/Slug
日付
タイトル

Image from Gyazo

項目はコンテンツ定義編集で編集/追加できます。

参考: コンテンツ定義編集

[編集]や[項目追加]をクリックすると、項目の種類や入力制限などを設定できます。

Image from Gyazo

設定できる内容は項目により異なりますので下記参照ください。

項目一覧

コンテンツID/Slug
日付/並び順
 カテゴリ
 タイトル
 内容
 テキスト
 テキスト(オートコンプリート)
テキストエリア
 WYSIWYG
HTML
単一選択
 複数選択可
 日付フォーマット
 マスタ形式
 マスタ(チェックボックス)
関連情報選択
 真偽値
 画像(Kurocofilesにアップロード)
ファイル(Kurocofilesにアップロード)
ファイル(GCSにアップロード)
ファイル(S3にアップロード)
ファイル(ファイルマネージャーから)
動画ファイル(Vimeo)
APIフィールド
 カウンター
 リンク
 JSON
数値
 表組み(テーブル)
地図
 ブロックエディタ

ヒント

Kurocoをお申込みいただいたタイミングによっては、各項目のレスポンスがext_Xではなく、ext_col_XXとなる場合があります。
うまくいかない場合は Swagger UIでレスポンスをご確認ください。

デフォルト項目

コンテンツID/Slug

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	`コンテンツID/Slug`が表示されます。編集できません。
Slug	`topics_id/slug`が表示されます。編集できません。
自動発行する	有効にするとSlugが空欄でコンテンツが追加された場合にSlugを自動発行します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須	有効にすると必須入力になります。
入力制限	入力できる文字列を制限することができます。
正規表現	入力制限で[正規表現]を選択した場合は正規表現を記入します。
文字数制限	最小・最大の文字数を設定します。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "topics_id": id,
    "slug": "slug",
},

日付/並び順

コンテンツ編集画面の表示

日付を使う を選択時 Image from Gyazo

並び順を使う を選択時 Image from Gyazo

項目設定 - 全般

日付を使う を選択時 Image from Gyazo

並び順を使う を選択時 Image from Gyazo

項目	説明
項目名	`日付`または`並び順`が表示されます。編集できません。
Slug	`ymd` または `order_no`が表示されます。編集できません。
項目設定	`日付を使う`　または　`並び順を使う`　を選択します。
投稿時間も設定する	有効にすると時間の設定ができるようになります。項目設定で `日付を使う` を選択した場合に設定できます。
投稿時間と秒も設定する	有効にすると時間と秒の設定ができるようになります。項目設定で `日付を使う` を選択した場合に設定できます。
注釈	注釈を入力します。

カテゴリ

コンテンツ編集画面の表示

Image from Gyazo

備考

カテゴリが複数登録されている時のみ表示されます。

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	`カテゴリ`が表示されます。編集できません。
Slug	`contents_type`が表示されます。編集できません。
注釈	注釈を入力します。

JSONレスポンス

details: {
    "ymd": "2024-01-11",
    "order_no": 10,
},

タイトル

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	`タイトル`が表示されます。編集できません。
Slug	`subject`が表示されます。編集できません。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
入力制限	入力できる文字列を制限することができます。
正規表現	入力制限で[正規表現]を選択した場合は正規表現を記入します。
文字数制限	最小・最大の文字数を設定します。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "subject": "title",
},

内容

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	`内容`が表示されます。編集できません。
Slug	`contents`が表示されます。編集できません。
本文の入力方法	本文の入力方法を「WYSIWYG」「テキストエリア」「利用しない」から選択します。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
wysiwyg_options	追加のCSSやカラーコードを指定するときに使用します。

JSONレスポンス

details: {
    "contents": "text",
},

テキスト関連

テキスト

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
Placeholder	プレースホルダを入力します。
デフォルト値	デフォルト値を入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
文字数制限	最小・最大の文字数を設定します。
入力制限	選択した入力種別により、入力できる文字列を制限することができます。
正規表現	入力制限で[正規表現]を選択した場合は正規表現を記入します。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": "テキスト",
},

テキスト(オートコンプリート)

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
コンテンツ定義ID	オートコンプリート表示するコンテンツ定義グループIDを設定します
Field	オートコンプリート表示する拡張番号を設定します例:`subject`,`ext->>'1'`,`ext_1`
Placeholder	プレースホルダを入力します。
デフォルト値	項目のデフォルト値を入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X":"テストブログ",
},

テキストエリア

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
Placeholder	プレースホルダを入力します。
デフォルト値	デフォルト値を入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
文字数制限	最小・最大の文字数を設定します。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
入力欄のサイズ	表示するテキストエリアの横幅と縦幅を設定します。例：`200` px指定となります。単位を指定しての設定も可能です。例：`200px`, `50%`
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": "テキストエリア",
},

WYSIWYG

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
リソースを指定	パスを入力すると、ckfinder起動時に表示するディレクトリパスを指定できます。例: /files/user/test
API出力時にiframelyを利用するコードに自動変換	有効にするとエディタ内で使用された`<oembed>`のタグをIframelyで自動変換して、iframeのコードに自動変換します。
トークンを自動で付与する	有効にすると、動的アクセストークンのセキュリティでAPIリクエストを送った際、KurocoFiles(閲覧制限)(`/files/ltd/`)に保存したファイルのURLに`t=・・・`の認証パラメータが自動で追加されます。動的アクセストークンでWysiwyg内にltdフォルダのファイルを使用する場合は設定してください。
WYSIWYG プレースホルダー	プレースホルダーにする文字列をカンマ区切りで入力します。プレースホルダーを任意の文字列に変換するカスタム処理を作成して利用します。
デフォルト値	デフォルト値を入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
入力欄のサイズ	フィールドの横幅と縦幅を設定します。例：`200px`, `50%` 単位の指定が無い場合はpxとして動作します。
シンプルなツールバー	有効にするとシンプルなツールバーになります。
大きなカラーパレット	有効にすると16色以上のカラーコードの設定が可能になります。
フォントサイズをpx指定	有効にするとフォントサイズをpx指定するようになります。
段落挿入ボタン	有効にすると、ブロック要素(div/section/article)の前後に段落挿入ボタンを表示します。改行やWYSIWYG専用テンプレートをブロック要素の外に挿入したい場合に有効にしてください。
削除するプラグイン	不要なブラグインを記入します。設定方法の詳細はWYSIWYGエディタの使用方法を参照ください
カスタムカラー	カラーパレットに設定するカラーコードを設定します。設定方法の詳細はWYSIWYG カスタムカラーの設定方法を参照ください。
カスタマイズCSS	CSSのURLをセットすると、指定したCSSをエディタ内で読み込みます。
マークダウン使用	有効にするとソースモードの入力形式がマークダウンになります。
出力フォーマット	マークダウン使用を有効にしている場合に、APIからのレスポンス時の出力フォーマットを選択します。
WYSIWYG オプション	WYSIWYGの追加オプションを利用する場合に使用します。現在有効なオプションは以下になります。 `subscript::1`：上付き・下付きアイコンを追加します。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

"details": {
    "ext_X": "<p><strong>Wysiwyg</strong> テキストエリア</p>",
},

備考

WYSIWYGエディタでは、空のタグが消される、scriptタグが消される、不明なタグが補完されるなど、HTMLのタグに自動で修正が入る場合があります。 HTMLを厳密に管理したい場合はHTMLの項目を利用してください。

HTML

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
デフォルト値	項目のデフォルト値を入力します。 ※全てのタグを許可するを有効にしていてもデフォルト値に`<script>`タグの利用はできません。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
全てのタグを許可する	有効にすると全てのタグが利用可能になります。無効にした状態で利用できるタグは以下を参照してください。

デフォルトで利用できるタグ一覧

<blockquote>,<ruby>,<sup>,<sub>,<em>,<code>,<a>,<u>,<s>,<base>,<address>,<label>,<link> <center>,
<font>,<hr>,<ul>,<ol>,<li>,<strong>,<br>,<p>,<frame>,<noframes>,<b>,<i>,<rt>,<rb> <big>,<small>,
<img>,<b>,<photo>,<table>,<tr>,<td>,<th>,<thead>,<tbody>,<span>,<noembed>,<oembed>,<q> <style>,
<h1>,<h2>,<h3>,<h4>,<h5>,<h6>,<div>,<object>,<param>,<marquee>,<pre> <embed>,<map>,<area>,<dl>,
<dt>,<dd>,<iframe>,<input>,<select>,<option>,<textarea>,<noscript>,<form>,<>,<br/>,<hr/>,<abbr>,
<dfn>,<cite>,<button>,<ins>,<del> <caption>,<col>,<colgroup>,<tfoot>,<optgroup> <fb:activity>,
<fb:add-profile-tab>,<fb:bookmark>,<fb:comments>,<fb:friendpile>,<fb:like>,<fb:like-box>,
<fb:live-stream>,<fb:login-button>,<fb:pronoun>,<fb:recommendations>,<fb:serverFbml>,<fb:profile-pic>,
<fb:user-status>,<fb:comments-count> <g:plusone>,<gcse:search>,<gcse:searchresults-only>,
<gcse:searchbox-only>,<video>,<header>,<footer>,<nav>,<section>,<article> <aside>,<audio>,
<datalist>,<details>,<figcaption>,<figure>,<hgroup>,<keygen>,<mark>,<meter>,<output>,<progress>,
<rp>,<rt>,<source>,<picture>,<summary>,<time>,<wbr>,<main>

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
入力欄のサイズ	フィールドの横幅と縦幅を設定します。例：`200` px指定となります。単位を指定しての設定も可能です。例：`200px`, `50%`
シンプルなテキストエリアを利用する	有効にするとhtmlの入力欄がシンプルなテキストエリアになります。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X":  "<div>\r\nhtml <p>テキストエリア</p>\r\n</div>",
},

セレクション関連

単一選択

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
選択項目	選択項目のキーと値を設定します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
ラジオボタンを利用する	有効にするとコンテンツ編集画面の表示がラジオボタンになります。
セパレーター	各ラジオボタンを区分するための文字列を入力します。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

複数選択可

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
選択項目	選択項目のキーと値を設定します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
マルチセレクトを使用する	有効にするとチェックボックスの代わりにマルチセレクトを使用します。選択肢の数が多い場合に有効にしてください。選択肢の数が50を超える場合は自動でマルチセレクトが使用されます。
セパレーター	各ラジオボタンを区分するための文字列を入力します。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": [
        {
            "key": "1",
            "label": "複数選択_選択肢1"
        },
        {
            "key": "2",
            "label": "複数選択_選択肢2"
        }
    ],
},

日付フォーマット

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
Placeholder	プレースホルダを入力します。
デフォルト値	デフォルト値を入力します。 PHPのstrtotime関数で利用できる指定方式で相対的な日付が指定可能です。例）today / -12 hours
時間(hh:mm)も設定する	有効にすると時間の設定ができるようになります。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X":"2021-06-04",
},

マスタ形式

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
マスタ	利用するマスタのIDの指定します。
キー	キーとして使用する列番号を指定します。
値	値として使用する列番号を指定します。
デフォルト値	初期遷移時に選択済みにしたい値を指定します。
親ID	親IDを指定します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": { 
        "key": "key",
        "label": "0"
     },
},

マスタ(チェックボックス)

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
マスタ	利用するマスタのIDの指定します。
キー	キーとして使用する列番号を指定します。
値	値として使用する列番号を指定します。
デフォルト値	初期遷移時に選択済みにしたいキーをカンマ区切りで指定します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": [
        {
            "key": "key1",
            "label": "label1"
        },
        {
            "key": "key2",
            "label": "label2"
        }
    ],
},

真偽値

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
デフォルト値	設定されるデフォルト値をtrue/falseから選択します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

なし

JSONレスポンス

details: {
    "ext_X": false
},

ファイル関連

画像(KurocoFilesにアップロード)

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
許可する拡張子	アップロードを許可する画像の拡張子を指定します。例：`png`,`jpg` 注意:`jpg`等を指定した場合、ファイル選択ダイアログでは`jpg`と同じMIMEタイプを持つ`jpeg`,`jpe`,`jif`,`jfif`も選択できるようになります。アップロードは指定した拡張子のみに制限されます。指定が無い場合は次の拡張子が許可されます。`jpg`,`jpeg`,`gif`,`png`,`svg`,`webp`
最大アップロードファイルサイズ(MB)	アップロード可能な画像のサイズに制限をかけます。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
キャプション入力欄を非表示	有効にすると、コンテンツ編集画面で画像の説明の入力欄を非表示にします。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": {
        "id": "sample_0",
        "url": "https://sample.g.kuroco-img.app/v=1623673449/files/topics/sample.png",
        "desc": "",
        "url_org": "https://hasebetest.g.kuroco-img.app/files/topics/sample.png"
    },
},

ファイル(KurocoFilesにアップロード)

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
許可する拡張子	アップロードを許可するファイルの拡張子を指定します。例：`png`,`jpg` 注意:`jpg`等を指定した場合、ファイル選択ダイアログでは`jpg`と同じMIMEタイプを持つ`jpeg`,`jpe`,`jif`,`jfif`も選択できるようになります。アップロードは指定した拡張子のみに制限されます。指定が無い場合は全ての拡張子が許可されます。参考：ファイルマネージャーで利用できるファイルの種類を教えてください
最大アップロードファイルサイズ(MB)	アップロード可能なファイルのサイズに制限をかけます。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
入力欄を非表示	有効にすると、コンテンツ編集画面でファイル名の入力欄を非表示にします。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": {
      "id": "sample_0",
      "url": "https://sample.g.kuroco-img.app/v=1623673449/files/topics/sample_0.pdf",
      "url_org": "https://sample.g.kuroco-img.app/files/topics/sample_0.pdf",
      "dl_link": "https://sample.g.kuroco.app/direct/topics/topics_file_download/?topics_id=960&ext_no=09&index=0",
      "desc": "test"
    },
},

ファイル(GCSにアップロード)

ファイル(GCS)はFirebaseとの連携後に利用可能です。
Firebaseとの連携方法は以下のドキュメントを参考にしてください。
Firebaseと連携して、Storageにファイルを保存する

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
インライン	有効にすると、管理画面からコンテンツをクリックした際にブラウザで表示されます。APIのレスポンスは変わりません。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目説明

必須設定有効にすると必須入力になります。

許可する拡張子アップロードを許可するファイルの拡張子を指定します。
例：png,jpg
注意:jpg等を指定した場合、ファイル選択ダイアログではjpgと同じMIMEタイプを持つjpeg,jpe,jif,jfifも選択できるようになります。アップロードは指定した拡張子のみに制限されます。

指定が無い場合は全ての拡張子が許可されます。
参考：ファイルマネージャーで利用できるファイルの種類を教えてください

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
入力欄を非表示	有効にすると、コンテンツ編集画面でファイル名の入力欄を非表示にします。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": {
      "id": "sample_0",
      "url": "https://storage.googleapis.com/kuroco-test.appspot.com/files/topics/sample.png?X-Goog-Algorithm=xxxxx",
      "desc": ""
    },
},

ファイル(S3にアップロード)

ファイル(S3)はAmazon S3との連携後に利用可能です。
Amazon S3との連携方法は以下のドキュメントを参考にしてください。
Amazon S3と連携して、Storageにファイルを保存する

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
インライン	有効にすると、管理画面からコンテンツをクリックした際にブラウザで表示されます。APIのレスポンスは変わりません。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目説明

必須設定有効にすると必須入力になります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
入力欄を非表示	有効にすると、コンテンツ編集画面でファイル名の入力欄を非表示にします。
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": {
      "id": "sample_0",
      "url": "https://kuroco-sample.s3.ap-northeast-1.amazonaws.com/files/topics/sample_0.jpeg?response-content-disposition=xxxxx",
      "desc": ""
    },
},

ファイル(ファイルマネージャーから)

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
リソースを指定	ckfinder起動時に表示したいディレクトリパス指定します。例: `/files/user/`
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X":"https://sample.g.kuroco-img.app/v=1621239477/files/user/sample.png",
},

動画ファイル(Vimeo)

動画ファイル(Vimeo)はFirebaseおよびVimeoとの連携後に利用可能です。
利用方法は以下のドキュメントを参考にしてください。
Vimeoと連携して動画をアップロードする

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
許可する拡張子	アップロードを許可するファイルの拡張子を指定します。例：`mp4` 指定が無い場合、Kuroco側での制限はありません。ただし、Vimeoで利用できる拡張子は基本的には次のようになります。`3GP`、`AVI`、`MOV`、`MP4`、`MPG`、`MTS`、`M2TS`

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_col_14": {
      "id": "sample_0",
      "url": "https://player.vimeo.com/video/xxxxxxxxx",
      "desc": "",
      "image_url": "https://sample.g.kuroco-img.app/v=1234567890/files/topics/sample_0.jpg"
    },
}

その他

APIフィールド

APIフィールドは指定したエンドポイントからのレスポンスデータを使うために利用します。
詳しい設定方法はOpenWeatherMapを利用して現在の天気を入力するAPIフィールドを設定するを参考にしてください

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
ポップアップタイトル	ポップアップウィンドウ内に表示されるメインタイトルを指定します。
[pop_up]ウェブフック	ポップアップウィンドウを表示した際に指定したURLにウェブフックを送信し、レスポンスに格納されたdataの値でカラム選択状態を作ります。送信する項目は以下です。・topics_id:Strings ・hash:Strings ・value:Strings レスポンスは`{"data":["127", "18", "628"]}`の形式で受け取り、配列の値が各カラムの「保存する値」で指定した値となるようにしてください。
[on_select]ウェブフック	最終カラムの選択時に指定したURLにウェブフックを送信します。送信する項目は以下です。・topics_id:Strings ・hash:Strings ・selected_date:Array ・value_list:Array
[on_save]ウェブフック	[選択]をクリックした際に指定したURLにウェブフックを送信し、「保存する値」の代わりにwebhookからのdataの値を保存します。送信する項目は以下です。・topics_id:Strings ・hash:Strings ・selected_date:Array ・value_list:Array レスポンスは`{"data":{"value":"668","display_value":"668"}}`の形式で受け取るようにしてください。
API設定-タイトル	ポップアップウィンドウ内の項目タイトルを指定します。
API設定-URL	ポップアップウィンドウ内で使用するエンドポイントを指定します。`%key%`の形式で前カラムのレスポンスデータを使用できます。
API設定-データ一覧パス	レスポンスデータのうち、使用するフィールドを指定します。
API設定-保存する値	[選択]をクリックした際に保存されるデータを設定します。`%key%`の形式でレスポンスデータを使用できます。
API設定-表示形式	ポップアップウィンドウ内に表示されるデータを設定します。`%key%`の形式でレスポンスデータを使用できます。
API設定-プレビュー URL	プレビュー表示に使用するURLを指定します。`%key%`の形式でレスポンスデータを使用できます。URLはiframeでの表示を許可されている必要があります。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

ポップアップウィンドウ例

Image from Gyazo

JSONレスポンス

details: {
    "ext_X":"選択された値",
},

カウンター

カウンターは Topics::increment のエンドポイントを叩くことで値を増減させることができます。
PV数を設定する用途等で利用します。
GoogleAnalyticsのPV数を元にアクセスランキングを実装する方法

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

なし

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

なし

JSONレスポンス

details: {
    "ext_X": X,
},

リンク

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": { 
        "url": "https://kuroco.app/",
        "title": "Kuroco"
    },
},

JSON

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
デフォルト値	デフォルト値を入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
JSONスキーマ	JSONスキーマを設定します。例： `{"number": 123, "street_name": "MyStreet"}`形式のJSONに制限する `{ "type": "object", "properties": { "number": { "type": "number" }, "street_name": { "type": "string" } }, "additionalProperties": false, "required": ["number", "street_name"] }` JSONスキーマの構文についてはJSON Schemaを参照してください。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
入力欄のサイズ	フィールドの横幅と縦幅を設定します。例：`200` px指定となります。単位を指定しての設定も可能です。例：`200px`, `50%`
シンプルなテキストエリアを利用する	有効にするとJSONの入力欄がシンプルなテキストエリアになります。

JSONレスポンス

details: {
    "ext_X": 入力されたJSONデータ
},

数値

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。
数値の範囲	最小・最大の値を設定します。
入力制限	入力できる数値を制限することができます。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

なし

JSONレスポンス

details: {
    "ext_X":123,
},

表組み(テーブル)

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
行の数	テーブルの行の数を指定します。
列の数	テーブルの列の数を指定します。
セルの設定	セルの値を入力します。上から2行目、左から3列目のセルを指定する場合は`2-3`と記述します。自動で追加されるヘッダ行が0行目になります。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": {
      "1": {
        "1": "1-1",
        "2": "1-2",
        "3": "1-3"
      },
      "2": {
        "1": "2-1",
        "2": "2-2",
        "3": "2-3"
      }
    },
},

地図

コンテンツ編集画面の表示

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。
デフォルト	地図のデフォルト表示を設定します。
注釈	注釈を入力します。

項目設定 - 入力制限

Image from Gyazo

項目	説明
必須設定	有効にすると必須入力になります。

項目設定 - 検索設定

Image from Gyazo

項目	説明
インデックス付与	有効にするとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

項目設定 - カスタムテンプレート

Image from Gyazo

項目	説明
テンプレート編集	コンテンツ編集画面の表示を変更したい場合に使用します。

JSONレスポンス

details: {
    "ext_X": {
      "gmap_x": "139.7435938",
      "gmap_y": "35.7009012",
      "gmap_zoom": "16",
      "gmap_type": "roadmap",
      "gmap_place_id": "ChIJbSFfyl2MGGARIoFxX2bg0hE",
      "jp_lon": "139.0.11.2",
      "jp_lat": "34.59.48.2"
    },
},

レイアウト

ブロックエディタ提供版: β版

項目設定 - グループ設定

ブロックエディタはグループ化した項目のトップに設置して利用します。
ブロックとして利用したい項目種別をグループに含めるように設定してください。
また、グループの繰り返し回数が設定できるブロックの数となります。

Image from Gyazo

項目設定 - 全般

Image from Gyazo

項目	説明
項目名	コンテンツ編集画面の表示名を入力します。
Slug	Slugを入力します。

項目設定 - 入力制限

設定なし

項目設定 - カスタムテンプレート

設定なし

JSONレスポンス

details: {
    "block_editor": [
      {
        "block": "ext_26",
        "h1": "H1 text",
        "h2": "",
        "image": {},
        "p": ""
      },
      {
        "block": "ext_28",
        "h1": "",
        "h2": "",
        "image": {},
        "p": "content"
      },
      ・
      ・
},

サポート

お探しのページは見つかりましたか？解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。

フォームから問い合わせをする

Slackコミュニティに参加する

項目一覧​

デフォルト項目​

コンテンツID/Slug​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - カスタムテンプレート​

JSONレスポンス​

日付/並び順​

コンテンツ編集画面の表示​

項目設定 - 全般​

カテゴリ​

コンテンツ編集画面の表示​

項目設定 - 全般​

JSONレスポンス​

タイトル​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - 検索設定​

項目設定 - カスタムテンプレート​

JSONレスポンス​

内容​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - カスタムテンプレート​

JSONレスポンス​

テキスト関連​

テキスト​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - 検索設定​

項目設定 - カスタムテンプレート​

JSONレスポンス​

テキスト(オートコンプリート)​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - 検索設定​

項目設定 - カスタムテンプレート​

JSONレスポンス​

テキストエリア​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - 検索設定​

項目設定 - カスタムテンプレート​

JSONレスポンス​

WYSIWYG​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - 検索設定​

項目設定 - カスタムテンプレート​

JSONレスポンス​

HTML​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

デフォルトで利用できるタグ一覧​

項目設定 - カスタムテンプレート​

JSONレスポンス​

セレクション関連​

単一選択​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - 検索設定​

項目設定 - カスタムテンプレート​

複数選択可​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目設定 - 入力制限​

項目設定 - 検索設定​

項目設定 - カスタムテンプレート​

JSONレスポンス​

日付フォーマット​

コンテンツ編集画面の表示​

項目設定 - 全般​

項目一覧

デフォルト項目

コンテンツID/Slug

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - カスタムテンプレート

JSONレスポンス

日付/並び順

コンテンツ編集画面の表示

項目設定 - 全般

カテゴリ

コンテンツ編集画面の表示

項目設定 - 全般

JSONレスポンス

タイトル

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - 検索設定

項目設定 - カスタムテンプレート

JSONレスポンス

内容

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - カスタムテンプレート

JSONレスポンス

テキスト関連

テキスト

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - 検索設定

項目設定 - カスタムテンプレート

JSONレスポンス

テキスト(オートコンプリート)

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - 検索設定

項目設定 - カスタムテンプレート

JSONレスポンス

テキストエリア

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - 検索設定

項目設定 - カスタムテンプレート

JSONレスポンス

WYSIWYG

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - 検索設定

項目設定 - カスタムテンプレート

JSONレスポンス

HTML

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

デフォルトで利用できるタグ一覧

項目設定 - カスタムテンプレート

JSONレスポンス

セレクション関連

単一選択

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - 検索設定

項目設定 - カスタムテンプレート

複数選択可

コンテンツ編集画面の表示

項目設定 - 全般

項目設定 - 入力制限

項目設定 - 検索設定

項目設定 - カスタムテンプレート

JSONレスポンス

日付フォーマット

コンテンツ編集画面の表示

項目設定 - 全般