genko.meDocs

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

スキーマとコンテンツをJSONで書き出す・取り込む手順と、microCMS・Newtからの移行。

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

スキーマを取り込む

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

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

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

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

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

microCMSのスキーマJSON

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

microCMSの種類genko.meの種類
textテキストフィールド
textAreaテキストエリア
richEditorリッチエディタ
media画像
number数字
boolean真偽値
date日時
selectセレクトフィールド

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

NewtのコンテンツJSONから項目を推測する

Newtにはモデル(スキーマ)の書き出しがありません。そのため、Newtのコンテンツを書き出したJSONを読み込むと、値の形から項目を推測します。items配列を持つJSON、またはコンテンツの配列を選んでください。

値の形推測する種類
true / false真偽値
数値数字
ISO 8601の日時日時
HTMLタグを含む文字列リッチエディタ
改行を含む、または120文字を超える文字列テキストエリア
その他の文字列テキストフィールド
srcまたはurlを持つオブジェクト画像

フィールドIDと表示名には、JSONのキーをそのまま使います。先頭20件まで見るため、1件目が空の項目も拾えます。配列(参照・複数選択)と、20件すべてが空の項目は読み込まず、理由を一覧に表示します。

**推測した項目は当たりを付けたものです。**読み込んだ項目はすべて一覧に表示するので、種類・表示名・必須設定を確認してから保存してください。_idと_sysは項目になりません。

コンテンツを書き出す

  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 配列、またはフィールド値の配列を取り込めます。

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

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

言語別の書き出しと取り込み

多言語を有効にしたAPIでは、エクスポート画面の「書き出す言語」を選べます。メイン言語は従来どおり全原稿を書き出します。サブ言語はその言語版が作成済みの原稿だけを、下書きも含めて書き出します。CSVとJSONに対応し、JSONは従来の形式にlangを加えます。画像・ファイルの本体と編集履歴は含まれません。

サブ言語へ取り込むときは「取り込む言語」を選び、ファイルを読み込みます。リスト形式では、ファイルのコンテンツIDとメイン言語の原稿のIDが一致する行だけを対象にします。一致しない行は件数とIDを表示してスキップし、メイン言語の原稿は新しく作りません。ファイル内で同じIDが複数回出た場合は最初の行だけを使い、重複行を報告します。オブジェクト形式は1件だけを受け付け、ファイルのIDがメイン言語のオブジェクトのIDと一致しない場合は取り込みません。

対象の言語版が未作成ならメイン言語から下書きを作って値を入れます。既存の版なら値を置き換えます。画面で選んだ「下書き」または「公開中」を適用し、ファイルの状態・日時は引き継ぎません。途中で失敗した場合は反映済みの版が残るので、表示されたIDを確認して残りを取り込み直してください。Newtの画像移行と画像ZIPも使えますが、画像を移すのはIDが一致した行だけです。容量とメディアの権限は通常の取り込みと同じように確認されます。

別APIで管理していた翻訳をまとめる場合は、元APIからコンテンツを書き出し、移行先の1つのAPIでサブ言語を有効にしてから取り込みます。両APIの形式とフィールドID・種類、各原稿のコンテンツIDをそろえてください。まず下書きとして取り込み、件数と内容を確認してから公開すると安全です。多言語コンテンツに全体の設定手順があります。

NewtのコンテンツJSON

NewtのAPIで取得したitems配列を持つJSON(Content APIのレスポンス)は、整形せずそのまま取り込めます。コンテンツの配列だけのJSONも読み込めます。

json
{  "skip": 0,  "limit": 100,  "total": 1,  "items": [    {      "_id": "68c0a1b2c3d4e5f600000001",      "_sys": { "createdAt": "2026-09-01T00:00:00.000Z" },      "title": "最初の記事",      "body": "<p>本文</p>"    }  ]}

_idと_sys以外のキーをフィールド値として読み、_idはコンテンツIDとして引き継ぎます。フィールドIDをNewtのキーと同じ名前にしておくと、そのまま取り込めます。

「Newt の画像を genko.me に移す」は既定でオンです。Newtが稼働している間(2026年11月24日まで)に取り込むと、画像フィールドと本文中のNewt画像をgenko.meのメディアへコピーし、参照を置き換えます。取得できなかった画像は、取り込み後に記事・フィールド・URL・理由を表示します。画像フィールドは空になり、必須画像を移せなかった記事は保存しません。本文中の画像は元のURLが残るため、手動で修正してください。

画像ZIPから取り込む(Newt終了後も使えます)

Newtは2026年11月24日に終了し、以降は画像のURLにアクセスできなくなります。JSONに加えて、Newtの画像ZIPを一緒に取り込めば、終了後でも画像を移せます。URLを取得できなかった画像にも使えます。

  1. Newtのスペース設定を開き、「一般」の「アセットの一括ダウンロード」でZIPをダウンロードします。ZIPが複数に分かれる場合は、すべて保存してください。
  2. コンテンツJSONを選ぶと出る「Newt の画像 ZIP を追加(任意・複数可)」で、ZIPを選びます。
  3. 取り込みを実行します。
  • 突き合わせ: 画像URLの末尾2区間(https://{スペース}.assets.newt.so/v1/{フォルダ}/{ファイル}の{フォルダ}/{ファイル})と、ZIP内の同じ並びのファイルを対応させます。ZIPの中に上位のフォルダがあっても構いません。同じ画像が複数のZIPにある場合は、先に見つかったものを使います。
  • 取得の順序: ZIPにある画像はZIPから、無い画像は「Newt の画像を genko.me に移す」がオンのときだけURLから取得します。ZIPを追加してこの設定をオフにすると、ZIPにある画像だけを移します。
  • ブラウザ内で読みます: ZIPはブラウザで開き、必要な画像だけを1枚ずつ取り出して、通常のアップロードと同じ経路で送ります。使わない画像は読み込まず、ZIPそのものも送信しません。プランの上限や容量は、通常のアップロードと同じく保存時にサーバーが検証します。
  • 制限: 1枚あたり50MBまで、形式はjpg・jpeg・png・webp・gif・avifです。それ以外のファイルや大きすぎる画像は移さず、取り込み後の一覧に理由を表示します。
  • 読めない場合: ZIPとして開けないファイルは、ファイル名を表示して、ほかのZIPと取り込みを続けます。パスワード付き・壊れている・未対応の圧縮方式の画像は、その1枚だけを移せなかった画像として一覧に出します。URLからの取得がオンなら、その画像はURLから取得を試みます。

PDFなど画像以外のファイル、参照・リレーション、公開状態・日時は移行しません。

コンテンツIDの引き継ぎ

「記事IDを引き継ぐ」は既定でオンです。ファイルにコンテンツIDがあれば、そのIDのまま取り込みます。サイトのURLに記事IDを使っている場合、転送の設定が要らなくなります。

  • 使えるID: 英数字・ハイフン・アンダースコアの64文字以内です。/や空白など、URLに置けない文字を含むファイルは取り込みを始めません。
  • IDが重複した場合: 同じIDのコンテンツが同じAPIに既にあると、その1件で取り込みを止め、重複したIDを表示します。そこまでに保存した原稿は残ります。
  • チェックを外した場合: ファイル内のIDを使わず、新しいIDを発行します。同じファイルをもう一度取り込むときは、チェックを外してください。
  • IDが無い場合: 新しいIDを発行します。

IDは同じAPIの中で重複しなければよく、別のAPIでは同じIDを使えます。

既存コンテンツへの影響

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

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

途中で失敗した場合

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

CSVの入力形式

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

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

フィールドセルの内容
テキスト・リッチテキスト文字列・HTML。改行やカンマを含むセルは引用符で囲む
数字2026、1.5など
真偽値true / false(大文字のTRUE / FALSEも可)
日時2026-01-01T00:00:00Zなど
単一選択選択肢の値
複数選択・複数参照セル内でカンマ区切り、またはJSON配列
単一参照移行先に存在するコンテンツのID
画像・ファイル・連携ブロックgenko.meの保存値に対応するJSON

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

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

最終更新: 2026年10月3日

目次