インポートとエクスポート

スキーマは入力項目の再利用に、コンテンツは原稿のコピーに使えます。スキーマはJSON、コンテンツはJSONとCSVに対応します。スキーマの操作にはオーナー権限、コンテンツの取り込みには編集者以上の権限が必要です。閲覧者もコンテンツを書き出せます。

スキーマを取り込む

1. API作成画面の「スキーマを定義する」、または既存APIの「スキーマ」を開きます。
2. 「スキーマの入出力」の「インポート」からJSONを選びます。
3. 項目数と、引き継げない設定の説明を確認します。
4. 「編集画面に読み込む」を押すと、編集中のフィールド一覧がファイルの内容に置き換わります。この時点では保存されません。
5. 必須項目や詳細設定を調整し、APIを作成するか「変更を保存」へ進みます。既存APIでは差分を確認して保存します。

追加途中のフィールドがある場合は、追加を完了するかキャンセルしてからインポートしてください。API名、エンドポイント、API形式は変更されません。

「エクスポート」は現在の編集画面にあるフィールドを、未保存の変更も含めて書き出します。フィールドの順序、ID、表示名、種類、必須設定、詳細設定を含みます。

{
  "format": "genko.schema",
  "version": 1,
  "fields": [
    { "id": "title", "name": "タイトル", "type": "text", "required": true }
  ]
}

fieldsを持つオブジェクトや、フィールド定義の配列も取り込めます。フィールド数は1〜50項目で、重複IDや不正な種類がある場合は読み込みません。

microCMSのスキーマJSON

microCMSから書き出したapiFieldsを持つJSONにも対応します。

ID・表示名・必須設定を引き継ぎ、セレクトの選択肢と複数選択設定を変換します。独自の入力制約、説明、配列の初期値など、変換できない設定は読み込み前に表示します。カスタムフィールドや上表以外の種類を含むファイルは、そのままでは取り込めません。必要な項目をgenko.meのフィールドへ設計し直してください。

コンテンツを書き出す

1. 対象APIを開き、画面上部の「コンテンツの入出力」を押します。
2. 「エクスポート」タブを選び、「CSVで全件を書き出す」または「JSONで書き出す」を押します。

検索結果に関係なく、下書き・公開済み・予約・公開終了を含む全件を書き出します。100件を超える場合も続きのページを取得します。書き出し中の追加や削除で件数・順序が変わった場合はエラーになるため、他の画面での編集を止めて再実行してください。

JSONにはワークスペース名、APIとフィールドの定義、コンテンツID、状態、日時、フィールド値を含みます。APIキー、下書きキー、編集履歴は含みません。メディアはURLとIDだけで、画像・ファイルの本体は含みません。

コンテンツを取り込む

1. 取り込み先のAPIを作成し、スキーマを合わせます。
2. 「コンテンツの入出力」の「インポート」タブでCSVまたはJSONを選択します。ファイルのドロップでも読み込めます。
3. 検証結果と件数を確認し、取り込み後の状態を「下書き」または「公開中」から選んで取り込みボタンを押します。
4. 完了後、原稿を確認して公開します。

入力用テンプレートは「入力用CSV・ファイル形式の説明」を開き、「入力用CSVをダウンロード」から取得できます。

genko.meのエクスポートJSONに加えて、entries / contents 配列、またはフィールド値の配列を取り込めます。

{
  "contents": [
    { "title": "最初の記事" },
    { "title": "次の記事" }
  ]
}

1ファイルは最大10MB、1回の取り込みは最大1,000件です。書き出しも10MBまで対応します。取り込む全件をスキーマに照らして検証し、不明なフィールドや必須項目の不足があると保存を開始しません。保存時もサーバーで権限、フィールド値、プランの上限を検証します。

既存コンテンツへの影響

• リスト形式: すべて新しいIDで追加します。取り込み後の状態は画面で選択します。同じファイルを再度取り込むと、別の原稿として追加されます。
• オブジェクト形式: 1件だけ取り込めます。既存の内容があれば、確認後に置き換え、選択した状態にします。下書きを選ぶと公開が停止するため、必要な内容は先に書き出してください。
• 状態・日時: ファイル内の公開状態は使用せず、画面で選んだ状態を適用します。「公開中」は保存に成功した原稿からすぐに配信されます。公開予約、公開終了日時、作成日時は引き継ぎません。元の値を保持するバックアップ復元ではありません。
• メディアと参照: ファイル本体のコピーや参照IDの自動置換は行いません。同じワークスペースでは既存のメディアや参照先を利用します。別ワークスペースのメディア・参照を含むgenko.meのJSONは取り込みを止めます。移行先で登録し直してください。

microCMSのコンテンツは、フィールド値をgenko.meの形式に合わせる必要があります。例えば画像はURLだけではなく、genko.meで登録したメディアIDが必要です。フィールド値の形式も確認してください。

途中で失敗した場合

取り込みは1件ずつ保存します。途中で通信やプラン上限のエラーが起きると、保存済み件数を表示して停止します。成功した原稿は残ります。通信が切れた最後の1件は保存されている可能性があるため、一覧を確認して、未登録の分だけを別ファイルにして取り込んでください。処理中は画面を閉じないでください。

CSVの入力形式

「入力用CSVをダウンロード」から、そのAPIのフィールドIDとサンプル行を含むテンプレートを取得できます。2行目以降を実際の原稿に置き換えて取り込みます。UTF-8のBOMあり・なし、CRLF・LF、引用符で囲まれたセル内改行に対応します。

1行目はidと各フィールドIDです。microCMSのテンプレートにある改行入りの「コンテンツID」列も認識します。CSV内のIDは取り込み時に引き継がず、新しいIDを発行します。既存オブジェクトを置き換える場合は、取り込み先のIDを維持します。

空欄は未指定として扱います。必須項目を満たさない場合は、保存前にエラーを表示します。列数の不一致、重複ヘッダー、不明なフィールドも取り込めません。

microCMSの画像URLを指定しても、ファイルはコピーされません。先にgenko.meへメディアを登録し、メディアIDを含む値に置き換えてください。参照IDも自動変換されません。CSVはコンテンツIDとフィールド値を書き出し、状態や日時などを含めて保存する場合はJSONを使用してください。