ドキュメントの目次
  1. はじめに
  2. コンテンツとコレクション
  3. 公開API
  4. CMS SDK
  5. 素材ライブラリ
  6. データの受け渡し(ZIP)
  7. 管理API

コンテンツとコレクション

Magic CMS Cloud では、サイトの中に「リソース」を作ってデータを管理します。リソースには、1件だけのデータを持つ「コンテンツ」と、並び順を持つ複数件のデータを持つ「コレクション」の2種類があります。このページでは、リソースの作り方、項目の型と値のルール、公開・公開停止・過去の版への切り替え・削除について説明します。

2つの種類

種類 値 データ件数 主な用途
コンテンツ content 1件 会社概要、トップページの見出し、フッターの文言
コレクション collection 複数件(並び順あり) お知らせ、実績、スタッフ紹介、FAQ

フォームはリソースとして作成できません。フォームは別製品の Magic Form Cloud で管理します。

リソースを作成する

サイト画面の「+ 新規作成」から、次の3つを入力します。

入力 ルール
種類 コンテンツ または コレクション
名前 管理画面に表示される名前(例:お知らせ)
識別キー 英小文字で始まり、英小文字・数字・_・- のみ。80文字まで。サイト内で重複不可(例:news)

識別キーは公開APIのURL(/api/public/v1/sites/SITE_ID/resources/news)や SDK の cms.get('news') で使います。

作成直後のリソースには、次の2項目があらかじめ用意されています。

識別キー 項目名 型 必須 公開
title タイトル テキスト はい はい
body 本文 複数行 いいえ はい

項目を定義する

リソース画面の「項目・設定」タブで項目を追加・変更し、「項目・設定の下書きを保存」を押します。1リソースあたり最大100項目です。

列 説明
識別キー 英字で始まり、英数字・_・- のみ、128文字まで。リソース内で重複不可。APIの values のキーになります。
項目名 管理画面での表示名(255文字まで)。下に任意の「説明」(1000文字まで)を付けられます。
型 下表の型から選びます。
必須 オンにすると、値の省略や空の値を保存できません。
公開 オンの項目だけが公開APIで返されます。
選択候補 「選択」「単一選択」で使う候補。1行に `値

項目の定義を保存すると、リソースの版番号が進みます。別の画面や管理APIで同時に更新されていた場合は保存が拒否されるので(「別の操作で更新されています。」)、再読み込みしてから操作し直してください。

項目の型と値のルール

管理画面の表示 型の値 保存できる値 公開APIでの形
テキスト text 文字列 文字列
複数行 textarea 文字列 文字列
メール email メールアドレス形式の文字列 文字列
URL url http:// または https:// で始まり空白を含まない文字列 文字列
数値 number 数値 数値
はい/いいえ boolean はい または いいえ true / false
日付 date YYYY-MM-DD 形式の実在する日付 文字列
選択 select 選択候補の値のいずれか 文字列
単一選択 radio 選択候補の値のいずれか 文字列
同意 checkbox はい または いいえ(必須にすると「はい」のみ) true / false
電話番号 tel 文字列 文字列
非表示 hidden 文字列 文字列
装飾文(HTML) rich_text 許可されたタグだけで書いた HTML 文字列(HTML)
文書(HTML) document 許可されたタグだけで書いた HTML 文字列(HTML)
素材URL asset http://・https:// で始まるURL、または /assets/ で始まるパス 文字列
リンク link 安全なリンク先(下記) {"url": "..."}

共通のルールは次のとおりです。

  • 文字列の値は100,000文字までです。
  • メール・URL・日付・選択などの形式チェックは、値が空でないときに行われます。
  • 必須でない「数値」「リンク」を空欄で保存すると、値は null になります。
  • 定義にない識別キーの値は保存できません。

装飾文・文書(HTML)で使えるタグ

保存時に HTML が検証され、許可されていない要素や属性があると保存できません(自動で取り除くことはしません)。

  • 要素:p br strong em b i u s del ins sub sup span a code pre blockquote ul ol li h1〜h6 hr table thead tbody tfoot tr th td caption
  • 属性:href title colspan rowspan scope start reversed
  • script・style・img などの要素、class・style・イベント属性は使えません。

リンク先として使える値

「リンク」型の値と、HTML の href には次の形式が使えます。

  • http:// または https:// で始まるURL
  • mailto:、tel:、# で始まる値
  • / で始まるサイト内パス(// で始まるものを除く)

公開項目と非公開項目

「公開」がオフの項目は、管理画面と管理APIでだけ扱える項目です。社内メモや下書き用の情報に使えます。

  • 公開API・SDK のレスポンスでは、fields と各レコードの values から除かれます。
  • 公開APIの検索(q)の対象にもなりません。除外したうえで検索・ページ分けが行われます。
  • 公開・非公開の設定は公開版に記録されます。設定を変えたら、もう一度公開すると反映されます。
  • データの受け渡し(ZIP) の書き出しファイルには非公開項目も含まれます。

データ(レコード)を保存する

「データ」タブで値を入力し、「データを保存」を押します。保存先は下書きです。

入力 ルール
識別キー 英数字で始まり、英数字・_・- のみ、180文字まで。リソース内で重複不可(例:news-001)。公開APIの entry パラメーターで1件を指定するときに使います。
並び順 -1,000,000〜1,000,000 の整数。小さい順に並び、同じ値なら識別キー順です。
  • コンテンツのデータは常に1件で、識別キーは main に固定されます。
  • コレクションは「+ データを追加」で何件でも追加できます。新規追加時の並び順には、既存の件数が初期値として入ります。
  • 「削除」を押すと下書きからそのデータが消えます。公開中の版から消すには、再度公開してください。

公開する

リソース画面上部の「保存済みの下書きを公開」を押すと、保存済みの項目定義とデータがそのまま新しい公開版になり、すぐに公開APIで返されるようになります。画面上で保存していない入力は含まれません。

  • 公開時に、すべてのデータが現在の項目定義に合っているか検証されます。項目の型や必須を変えた後に、古いデータが合わなくなっていると公開できません。データを直してから公開してください。
  • コンテンツは、データを保存してからでないと公開できません。
  • 項目の構成(識別キーや型)を変えて公開すると、静的サイト側の表示処理も合わせて直す必要がある場合があります。

公開を停止する

「公開停止」を押すと、そのリソースは公開APIから取得できなくなります(404)。下書きと公開履歴は残るので、再び公開したり、過去の版を公開したりできます。

過去の公開版に切り替える

「接続・公開履歴」タブに、公開日時と版IDの先頭8文字が新しい順に最大20件表示されます。現在の版には「公開中」と表示されます。ほかの版の「この版を公開」を押すと、公開版がその版に切り替わります。

  • 下書きは変更されません。切り替え後に「保存済みの下書きを公開」を押すと、下書きの内容が新しい版として公開されます。
  • 切り替えは管理画面でのみ行えます(管理APIにはありません)。

リソースを削除する

リソース画面下部の「リソースを削除」から削除します。データ・公開履歴もあわせて削除され、公開APIからも取得できなくなります。元に戻せません。

サイトを削除した場合は、サイト内のすべてのリソース・公開履歴・素材が削除されます。

関連ページ