メインコンテンツまでスキップ

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

コンテンツ定義は、デフォルトで下記４つのフィールド項目を所有しています。

  • トピックスID/Slug
  • 日付
  • タイトル
  • コンテンツ(Wysiwyg)

Image (fetched from Gyazo) フィールド項目はコンテンツ定義編集の項目設定で追加できます。

参考: コンテンツ定義編集 項目設定

Image from Gyazo

また、拡張項目は[設定]をクリックして設定画面を開くと、入力制限や表示させる内容を設定できます。

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

拡張項目一覧​

テキスト
テキスト(オートコンプリート)
テキストエリア
Wysiwyg
html
選択形式
複数選択(チェックボックス)
日付フォーマット
マスタ形式
関連情報選択
画像(Kurocofilesにアップロード)
ファイル(Kurocofilesにアップロード)
ファイル(GCSにアップロード)
ファイル(S3にアップロード)
ファイル(ファイルマネージャーから)
動画ファイル(Vimeo)
カウンター
リンク
地図
数値
表組(テーブル)

ヒント

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

テキスト関連​

テキスト​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
入力制限入力できる文字列を制限することができます。
正規表現入力制限で[正規表現]を選択した場合は正規表現を記入します。
文字数制限最小・最大の文字数を設定します。

JSONレスポンス​

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

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

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

Image from Gyazo

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
拡張項目コンテンツ定義IDオートコンプリート表示するコンテンツ定義グループIDを設定します
Fieldオートコンプリート表示する拡張番号を設定します
例:ext_col_04

JSONレスポンス​

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

テキストエリア​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
拡張項目横幅表示するテキストエリアの横幅を設定します。
縦幅表示するテキストエリアの縦幅を設定します。
文字数制限最小・最大の文字数を設定します。

JSONレスポンス​

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

Wysiwyg​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
拡張項目色指定色の変更ができます。
横幅フィールドの横幅を指定します。
縦幅フィールドの縦幅を指定します。
削除するプラグイン不要なブラグインを記入します。
設定方法の詳細はWYSIWYGエディタの使用方法を参照ください
カスタムカラーカラーパレットに設定するカラーコードを設定します。
設定方法の詳細はWYSIWYG カスタムカラーの設定方法を参照ください。
大きなカラーパレットチェックを入れると16色以上のカラーコードの設定が可能になります。
シンプルなツールバーチェックを入れると、シンプルなツールバーになります。
フォントサイズをpx指定チェックを入れるとフォントサイズをpx指定するようになります。
Custom CSSCSSのURLをセットすると、指定したCSSをエディタ内で読み込みます。
リソースを指定パスを入力すると、ckfinder起動時に表示するディレクトリパスを指定できます。
例: /file/user/
API出力時にiframelyを利用するコードに自動変換チェックを入れるとエディタ内で使用された<oembed>のタグをIframelyで自動変換して、iframeのコードに自動変換します。
WYSIWYG プレースホルダープレースホルダーにする文字列をカンマ区切りで入力します。プレースホルダーを任意の文字列に変換するカスタム処理を作成して利用します。

JSONレスポンス​

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

html​

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

Image from Gyazo

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目横幅表示するhtml入力エリアの横幅を設定します。
縦幅表示するhtml入力エリアの縦幅を設定します。
全てのタグを許可するチェックを入れると全てのタグが利用可能になります。
scriptを許可チェックを入れるとscriptが利用可能になります。
シンプルなテキストエリアを利用するチェックを入れるとhtmlの入力にがシンプルなテキストエリアになります。

JSONレスポンス​

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

セレクション関連​

選択形式​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力項目必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
選択項目key選択項目のKeyを記入します。
　Value選択項目のValueを記入します。
　デフォルトチェックを入れると対象の項目がデフォルトで選択された状態になります。
　Add選択項目を追加します。
　Delete選択項目を削除します。

JSONレスポンス​

details: {
    "ext_X": { 
        "key": "1",
        "label": "選択肢1" 
    },
},

複数選択(チェックボックス)​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
選択項目key選択項目のKeyを記入します。
Value選択項目のValueを記入します。
デフォルトチェックを入れると対象の項目がデフォルトで選択された状態になります。
Add選択項目を追加します。
Delete選択項目を削除します。

JSONレスポンス​

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

日付フォーマット​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
拡張項目時間(hh:mm)も設定するチェックを入れると時間の設定ができるようになります。

JSONレスポンス​

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

マスタ形式​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
拡張項目マスタ利用するマスタのIDの指定します。
キーキーとして使用する列番号を指定します。
値値として使用する列番号を指定します。
デフォルト初期遷移時に選択済みにしたい値を指定します。

JSONレスポンス​

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

関連情報選択​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。
拡張項目モジュール関連情報として選択させる機能を指定します。
グループIDモジュールをコンテンツに設定した場合に、関連情報として選択させるグループのIDを指定します。
カテゴリIDモジュールをコンテンツに設定した場合に、関連情報として選択させるカテゴリのIDを指定します。
権限設定で絞り込むinsert,update,deleteを指定して、そのうちログインしているユーザーが実行できる関連情報が取得されます。
自分のみログインしているユーザーが作成した関連情報だけが取得されます。
セキュリティ無効閲覧制限を無効にして関連情報取得可能になります。
並び順並び順を設定します。
topics_id=ASCのように指定してください。組み合わせで指定したい場合はsubject=ASC,topics_id=ASCのように指定できます。

JSONレスポンス​

details: {
    "ext_X": {
        "module_type": "topics",
        "module_id": 959
    },
},

ファイル関連​

画像(Kurocofilesにアップロード)​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目拡張子Valueアップロードを許可する画像の拡張子を指定します。
Addアップロードを許可する画像の拡張子を追加します。
Deleteアップロードを許可する画像の拡張子を削除します。
最大アップロードファイルサイズ(MB)アップロード可能な画像のサイズに制限をかけます。
キャプション入力欄を非表示チェックを入れると、コンテンツ編集画面で画像の説明の入力欄を非表示にします。

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 (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目拡張子の設定Valueアップロードを許可するファイルの拡張子を指定します。
Addアップロードを許可するファイルの拡張子を追加します。
Deleteアップロードを許可するファイルの拡張子を削除します。
入力欄を非表示チェックを入れると、コンテンツ編集画面でファイル名の入力欄を非表示にします。
最大アップロードファイルサイズ(MB)アップロード可能なファイルのサイズに制限をかけます。

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 (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目Valueアップロードを許可するファイルの拡張子を指定します。
Add拡張子の設定を追加します。
Delete拡張子の設定を削除します。
入力欄を非表示チェックを入れると、コンテンツ編集画面でファイル名の入力欄を非表示にします。

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

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目Valueアップロードを許可するファイルの拡張子を指定します。
Add拡張子の設定を追加します。
Delete拡張子の設定を削除します。
入力欄を非表示チェックを入れると、コンテンツ編集画面でファイル名の入力欄を非表示にします。

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 (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目リソースを指定ckfinder起動時に表示したいディレクトリパス指定します。
例: /file/user/

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

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目拡張子の設定Valueアップロードを許可するファイルの拡張子を指定します。
Addアップロードを許可するファイルの拡張子を追加します。
Deleteアップロードを許可するファイルの拡張子を削除します。

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"
    },
}

その他​

カウンター​

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

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

Image from Gyazo

項目設定​

Image from Gyazo

JSONレスポンス​

details: {
    "ext_X": X,
},

リンク​

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

Image (fetched from Gyazo)

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。

JSONレスポンス​

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

地図​

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

Image (fetched 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

項目説明
入力関連必須チェックを入れると必須入力になります。
入力制限入力できる数値を制限することができます。
数値の範囲入力できる数値の範囲を指定します。
検索可能チェックを入れるとデータベースにインデックスが貼られ、検索結果が速くレスポンスされるようになります。

JSONレスポンス​

details: {
    "ext_X":123,
},

表組(テーブル)​

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

Image from Gyazo

項目設定​

Image from Gyazo

項目説明
入力関連必須チェックを入れると必須入力になります。
拡張項目行の数テーブルの行の数を指定します。
列の数テーブルの列の数を指定します。
セルの設定セル設定を行うセルを指定します。
上から2行目、左から3列目のセルを指定する場合は2-3と記述します。
自動で追加されるヘッダ行が0行目になります。
値予め表示する値を記入します。
LOCKチェックを入れるとセルの編集をLOCKします。
　Addセルの設定を追加します。
　Deleteセルの設定を削除します。

JSONレスポンス​

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

サポート

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

フォームから問い合わせをする
Slackコミュニティに参加する