List of extension items available in the content structure
The content structure includes the following three field items by default.
- ContentID/Slug
- Date
- Title
Field items can be added in the Content structure editor.
Reference: Content structure
When you click on [Edit], it opens the item settings for additional field, allowing you to configure item types, input restrictions, and more.
The available settings vary depending on the item, so please refer to the following.
List of Items
ContentID/Slug
Date/Sort
Category
Title
Content
Single-line text
Single-line text (autocomplete)
Multi-line text
WYSIWYG
HTML
Single choice
Multiple choice
Date picker
Master selection
Master (checkbox)
Relational data selection
Bool
Image (upload to KurocoFiles)
File (upload to KurocoFiles)
File (upload to GCS)
File (upload to S3)
File (from File manager)
Video (Vimeo)
API field
Counter
Link
Number
Table
Location
tip
Depending on the timing of your Kuroco application, the response for each item may be ext_X instead of ext_col_XX.
If it doesn't work, please check the response in the Swagger UI.
Default Items
ContentID/Slug
Display in Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Displays Content ID/Slug. Cannot be edited. |
| Slug | Displays topics_id/slug. Cannot be edited. |
| Auto generate | When enabled, automatically generates a Slug if it is blank when adding content. |
| Annotation | Enter an annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required | When enabled, becomes a required input. |
| Input restriction | Limits the input string. |
| Regular expression | If [Regular Expression] is selected in Input Restriction, enter a regular expression. |
| Character limit | Set the minimum and maximum number of characters. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"topics_id": id,
"slug": "slug",
},
Date/Sort
Display of the Content Editing Screen
When Use Date is selected.
When Use Sort is selected.
Field settings - General
When Use Date is selected.
When Use Sort is selected.
| Item | Description |
|---|---|
| Field name | Displays DateorSort. Cannot be edited. |
| Slug | Displays ymd or order_no. Cannot be edited. |
| Field settings | Select 'Use Date' or 'Use Sort'. |
| Also include time (hh:mm) | When enabled, allows setting of time. Available when Use Date is selected in the Field settings. |
| Also include seconds (hh:mm:ss) | When enabled, allows setting of time and seconds. Available when Use Date is selected in the Field settings. |
| Annotation | Enter a annotation. |
Category
Display of the Content Editing Screen
info
Displayed only when multiple categories are registered.
Field settings - General
| Item | Description |
|---|---|
| Field name | Displays Category. Cannot be edited. |
| Slug | Displays contents_type. Cannot be edited. |
| Annotation | Enter a annotation. |
JSON Response
details: {
"ymd": "2024-01-11",
"order_no": 10,
},
Title
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Displays Title. Cannot be edited. |
| Slug | Displays subject. Cannot be edited. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Input restriction | Limits the input string. |
| Regular expression | If Regular Expression is selected in the input restrictions, enter a regular expression. |
| Character limit | Sets the minimum and maximum character limits. |
Field settings - Search setting
| Item | Description |
|---|---|
| Indexing | When enabled, an index is added to the database, and search results are responded quickly. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"subject": "title",
},
Content
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Displays content. Cannot be edited. |
| Slug | Displays contents. Cannot be edited. |
| Input Method for Body | Select the input method for the body from "WYSIWYG", "Text Area", or "Not Used". |
Field settings - Custom template
| Item | Description |
|---|---|
| wysiwyg_options | This is used when specifying additional CSS or color codes. |
JSON Response
details: {
"contents": "text",
},
Text Related
Single-line text
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Placeholder | Enter the placeholder. |
| Default values | Enter the default value. |
| Annotation | Enter the Annotation. |
Item Settings - Input Restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Input restriction | You can restrict the input string. |
| Character limit | Set the minimum and maximum number of characters. |
| Regular expression | If you select [Regular Expression] in the input restriction, enter the regular expression. |
Field settings - Search setting
| Item | Description |
|---|---|
| Indexing | When enabled, an index is added to the database, and search results are responded quickly. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": "text",
},
Single-line text (autocomplete)
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Content structure ID | Set the content structure group ID to display in autocomplete. |
| Field | Set the extension number to display in autocomplete. Example: subject,ext->>'1',ext_1 |
| Placeholder | Enter the placeholder. |
| Default values | Enter the default value. |
| Annotation | Enter the Annotation. |
Item Settings - Input Restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Search setting
| Item | Description |
|---|---|
| Indexing | When enabled, an index is added to the database, and search results are responded quickly. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X":"Test Blog",
},
Multi-line text
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Placeholder | Enter the placeholder. |
| Default values | Enter the default value. |
| Annotation | Enter the Annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Character limit | Set the minimum and maximum number of characters. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is added to the database, and search results are responded quickly. |
Field settings - Custom template
| Item | Description |
|---|---|
| Input field size | Set the width and height of the text area to be displayed. Example: 200It will be specified in pixels (px). It is also possible to set it by specifying the unit. Example: 200px, 50% |
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": "Text Area",
},
WYSIWYG
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Resource | Enter the path to specify the directory path to display when ckfinder is launched. Example: /files/user/test |
| Automatically convert to iframely code during API output | Enabling this will automatically convert the <oembed> tags used in the editor to Iframely and convert them to iframe code. |
| Grant tokens automatically | When enabled, API requests sent with dynamic access token security will automatically have the authentication parameter t=... added to the URLs of files stored in KurocoFiles(Restricted)(/files/ltd/).Please set this up when using files from the ltd folder within Wysiwyg with a dynamic access token. |
| WYSIWYG placeholder | Enter the string to be used as a placeholder, separated by commas. Create and use custom processing to convert the placeholder to any string. |
| Default values | Enter the default value. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | Enabling this will make it a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | Enabling this will add an index to the database, resulting in faster response times for search results. |
Field settings - Custom template
| Item | Description |
|---|---|
| Input field size | Specify the width and height of the field. Example: 200px, 50%If no unit is specified, it will work as pixels (px). |
| Simple toolbar | Enabling this will display a simplified toolbar. |
| Large color palette | Enabling this allows setting more than 16 color codes. |
| Use font size px | Enabling this will specify the font size in pixels. |
| Insert paragraph button | Enabling this will display paragraph insertion buttons before and after block elements (div/section/article). Please enable this option if you want to insert line breaks or WYSIWYG templates outside of block elements. |
| Delete plugin | Enter the unnecessary plugins. For detailed instructions, refer to How to Use WYSIWYG Editor. |
| Custom colors | Set the color codes to be included in the color palette. For detailed instructions, refer to How to Set WYSIWYG Custom Colors. |
| Custom CSS | Set the URL of the CSS to load the specified CSS in the editor. |
| Use markdown | Enabling this will change the input format in source mode to Markdown. |
| Output format | Select the output format for the response from the API when Use markdown is enabled. |
| WYSIWYG Options | This is used when utilizing additional WYSIWYG options. The currently enabled options are as follows.
|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
"details": {
"ext_X": "<p><strong>Wysiwyg</strong> Text Area</p>",
},
info
In a WYSIWYG editor, automatic corrections may occur for HTML tags, such as removal of empty tags, removal of script tags, and completion of unknown tags. If you want to strictly control the HTML, please use the HTML field.
HTML
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Default values | Enter the default value for the item. *Even if "Allow all tags" is enabled, the use of <script> tags is not allowed in the default value. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Allow all tags | When enabled, all tags can be used. See below for tags available with disabled. |
List of tags available by default
<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>
Field settings - Custom template
| Item | Description |
|---|---|
| Input field size | Specify the width and height of the field. Example: 200It will be specified in pixels (px). It is also possible to set it by specifying the unit. Example: 200px, 50% |
| Enable simple text editor | When enabled, the input for HTML becomes a simple text area. |
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": "<div>\r\nhtml <p>text area</p>\r\n</div>",
},
Selection Related
Single choice
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Selection Options | Set the key and value of the selection options. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is created in the database, and search results are responded quickly. |
Field settings - Custom template
| Item | Description |
|---|---|
| Use radio buttons | When enabled, the display of the content editing screen becomes radio buttons. |
| Separator | Enter a string to separate each radio button. |
| Template editor | Used when you want to change the display of the content editing screen. |
Multiple choice
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Selection Options | Set the key and value of the selection options. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | Enabling this makes it a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | Enabling this adds an index to the database, resulting in faster search results and responses. |
Field settings - Custom template
| Item | Description |
|---|---|
| Use multiselect | When enabled, use multi-select instead of checkboxes. Please Enable this when there are many options. If the number of options exceeds 50, multi-select will be used automatically. |
| Separator | Enter a string to separate each radio button. |
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": [
{
"key": "1",
"label": "Multiple Choice_Option 1"
},
{
"key": "2",
"label": "Multiple Choice_Option 2"
}
],
},
Date picker
Display on Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name on the content editing screen. |
| Slug | Enter the slug. |
| Placeholder | Enter the placeholder. |
| Default values | Enter the default value. Relative dates can be specified using the specified format that can be used with the PHP strtotime function. Ex.) today / -12 hours |
| Also include time (hh:mm) | Enabling this allows setting the time. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | Enabling this makes it a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | Enabling this adds an index to the database, resulting in faster search results and responses. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X":"2021-06-04",
},
Master selection
Display on Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name on the content editing screen. |
| Slug | Enter the slug. |
| Options:Master | Specify the ID of the master to be used. |
| Options:Key | Specify the column number to be used as the key. |
| Options:Value | Specify the column number to be used as the value. |
| Default values | Specify the value that should be pre-selected on initial transition. |
| Parent ID | Specify the parent ID. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | Enabling this makes it a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is created in the database, resulting in faster search results and responses. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": {
"key": "key",
"label": "0"
},
},
Master (checkbox)
Display on Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name on the content editing screen. |
| Slug | Enter the slug. |
| Options:Master | Specify the ID of the master to be used. |
| Options:Key | Specify the column number to be used as the key. |
| Options:Value | Specify the column number to be used as the value. |
| Default values | Please specify the keys you want to be selected during the initial transition, separated by commas. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | Enabling this makes it a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is created in the database, resulting in faster search results and responses. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": [
{
"key": "key1",
"label": "label1"
},
{
"key": "key2",
"label": "label2"
}
],
},
Relational data selection
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the Slug. |
| Module | Specify the function to be selected as related information. |
| Content structure ID | Specify the ID of the content structure to be selected as related information if the module is set to content. |
| Category ID | In the case of the module is set to content Specify the ID of the category to be selected as related information if the module is set to content. |
| Filter by Permission Settings | In the case of the module is set to content or member Retrieve related information that can be executed by users who are logged in by specifying insert, update, delete. |
| Only Mine | In the case of the module is set to content Only related information created by users who are logged in will be retrieved. |
| Disable Security | In the case of the module is set to content Disables access restrictions and allows retrieval of related information. |
| Sort Order | Set the sort order. Specify it as topics_id=ASC. If you want to specify multiple combinations, you can specify it as subject=ASC,topics_id=ASC. |
| Annotation | Enter an annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is created in the database, resulting in faster search results and responses. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": {
"module_type": "topics",
"module_id": 959
},
},
Bool
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the Slug. |
| Default values | Select the default value to be set as true/false. |
| Annotation | Enter an annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is applied to the database, resulting in faster search results and responses. |
Field settings - Custom template
None
JSON Response
details: {
"ext_X": false
},
File Related
Image (upload to KurocoFiles)
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Allowed file extension | Specify the file extensions allowed for upload. Example: png, jpgNote: If you specify jpg, files with the same MIME type, such as jpeg, jpe, jif, and jfif, can also be selected in the file selection dialog. However, the upload will be restricted to the specified file extensions only.If not specified, the following extensions are allowed: jpg, jpeg, gif, png, svg,webp. |
| Maximum upload file size (MB) | Limits the size of the uploaded image. |
Field settings - Custom template
| Item | Description |
|---|---|
| Hide caption | When enabled, hides the input field for image description in the content editing screen. |
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
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"
},
},
File (upload to KurocoFiles)
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Allowed file extensions | Specify the file extensions allowed for upload. Example: png, jpgNote: If you specify jpg, files with the same MIME type, such as jpeg, jpe, jif, and jfif, can also be selected in the file selection dialog. However, the upload will be restricted to the specified file extensions only.If not specified, all extensions are allowed. Reference: What file formats does the file manager support? |
| Maximum upload file size (MB) | Limits the size of the uploaded file. |
Field settings - Custom template
| Item | Description |
|---|---|
| Hide the input field | When enabled, hides the input field for file name in the content editing screen. |
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
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"
},
},
File (upload to GCS)
File (upload to GCS) is available after integration with Firebase. Please refer to the following document for details on how to work with Firebase. Cloud storage integration with Firebase
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Inline | When enabled, the content will be displayed in the browser when clicked from the admin screen. The API response remains the same. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Allowed file extensions | Specify the file extensions allowed for upload. Example: png, jpgNote: If you specify jpg, files with the same MIME type, such as jpeg, jpe, jif, and jfif, can also be selected in the file selection dialog. However, the upload will be restricted to the specified file extensions only.If not specified, all extensions are allowed. Reference: What file formats does the file manager support? |
Field settings - Custom template
| Item | Description |
|---|---|
| Hide the input field | When enabled, the input field for the file name will be hidden on the content editing screen. |
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": {
"id": "sample_0",
"url": "https://storage.googleapis.com/kuroco-test.appspot.com/files/topics/sample.png?X-Goog-Algorithm=xxxxx",
"desc": ""
},
},
File (upload to S3)
File (upload to S3) is available after integration with Amazon S3. Please refer to the following document for details on how to work with Amazon S3. Integrating and storing files with Amazon S3
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Inline | When enabled, the content will be displayed in the browser when clicked from the admin screen. The API response will not change. |
| Annotation | Enter an annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Allowed file extensions | Specify the file extensions allowed for upload. Example: png, jpgNote: If you specify jpg, files with the same MIME type, such as jpeg, jpe, jif, and jfif, can also be selected in the file selection dialog. However, the upload will be restricted to the specified file extensions only.If not specified, all extensions are allowed. Reference: What file formats does the file manager support? |
Field settings - Custom template
| Item | Description |
|---|---|
| Hide the input field | When enabled, the input field for the file name will be hidden on the content editing screen. |
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
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": ""
},
},
File (from File manager)
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Resource | Specify the directory path you want to display when ckfinder is launched. Example: /files/user/ |
| Annotation | Enter an annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X":"https://sample.g.kuroco-img.app/v=1621239477/files/user/sample.png",
},
Video (Vimeo)
Video(Vimeo) is available after integration with Vimeo.
Please refer to the following document for details on how to work with Vimeo.
How to Connect to Vimeo and Upload Videos
Display of the Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Annotation | Enter the annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Allowed file extension | Specify the file extensions allowed for upload. Example: mp4If not specified, there are no restrictions on the Kuroco side. However, the file extensions available on Vimeo are generally as follows: 3GP, AVI, MOV, MP4, MPG, MTS, M2TS |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
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"
},
}
Others
API field
API fields are used to utilize response data from the specified endpoints. For detailed configuration instructions, refer to Setting up API Fields for Current Weather Input with OpenWeatherMap.
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Dialog header | Specify the main title displayed in the popup window. |
| [pop_up] webhook | When the popup window is displayed, send a webhook to the specified URL and create the column selection state with the value stored in the response data. The items to be sent are as follows: - topics_id: Strings - hash: Strings - value: Strings The response should be received in the format {"data":["127", "18", "628"]}, with the values in the array becoming the values specified in the "Save Value" for each column. |
| [on_select] webhook | Send a webhook to the specified URL when the final column is selected. The items to be sent are as follows: - topics_id: Strings - hash: Strings - selected_date: Array - value_list: Array |
| [on_save] webhook | When [Select] is clicked, send a webhook to the specified URL and save the value from the data in the webhook instead of the "Save Value". The items to be sent are as follows: - topics_id: Strings - hash: Strings - selected_date: Array - value_list: Array The response should be received in the format {"data":{"value":"668","display_value":"668"}}. |
| API Settings - Title | Specify the item title in the popup window. |
| API Settings - URL | Specify the endpoint to be used in the popup window. The response data from the previous column can be used in the format %key%. |
| API Settings - Path to list | Specify the fields to be used from the response data. |
| API Settings - Saved format | Set the data to be saved when [Select] is clicked. The response data can be used in the format %key%. |
| API Settings - Display format | Set the data to be displayed in the popup window. The response data can be used in the format %key%. |
| API Settings - Preview URL | Specify the URL to be used for preview display. The response data can be used in the format %key%. The URL must allow display in an iframe. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
Popup Window Example
JSON Response
details: {
"ext_X":"Selected value",
},
Counter
The counter can be increased or decreased in value by hitting the Topics::increment endpoint. This is used to set the number of PV number etc. Implementing view-based page rankings in Google Analytics
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
None
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is added to the database, resulting in faster search results and responses. |
Field settings - Custom template
None
JSON Response
details: {
"ext_X": X,
},
Link
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Annotation | Enter the Annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": {
"url": "https://kuroco.app/",
"title": "Kuroco"
},
},
Number
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Annotation | Enter the Annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
| Numeric value range | Set the minimum and maximum values. |
| Input restriction | You can restrict the input to a specific range of numbers. |
Field settings - Search settings
| Item | Description |
|---|---|
| Indexing | When enabled, an index is created in the database, resulting in faster search results and responses. |
Field settings - Custom template
None
JSON Response
details: {
"ext_X":123,
},
Table
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Number of rows | Specify the number of rows in the table. |
| Number of columns | Specify the number of columns in the table. |
| Cell settings | Enter the value of the cell. To specify the cell in the second row from the top and the third column from the left, write 2-3.The automatically added header row will be the 0th row. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
details: {
"ext_X": {
"1": {
"1": "1-1",
"2": "1-2",
"3": "1-3"
},
"2": {
"1": "2-1",
"2": "2-2",
"3": "2-3"
}
},
},
Location
Display of Content Editing Screen
Field settings - General
| Item | Description |
|---|---|
| Field name | Enter the display name of the content editing screen. |
| Slug | Enter the slug. |
| Default | Sets the default view of the map. |
| Annotation | Enter a annotation. |
Field settings - Input restriction
| Item | Description |
|---|---|
| Required setting | When enabled, it becomes a required input. |
Field settings - Search settingsRelease version: βversion
| Item | Description |
|---|---|
| Indexing | When enabled, an index is created in the database, and search results are responded quickly. |
Field settings - Custom template
| Item | Description |
|---|---|
| Template editor | Used when you want to change the display of the content editing screen. |
JSON Response
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"
},
},
Support
If you have any other questions, please contact us or check out Our Slack Community.