平素よりmicroCMSをご利用いただき、誠にありがとうございます。

このたび、2025年5月26日（月）に予定している拡張フィールド機能の仕様変更についてご案内いたします。
今回の変更により、一部のご利用方法においては影響が生じる可能性があるため、事前にご連絡させていただきました。

変更内容

拡張フィールドを利用しているAPIにおいて、コンテンツの「新規作成画面」または「編集画面」を開いた際、microCMS管理画面側から、拡張フィールドとして登録されているアプリケーション（※1）に送信される初期データに、context オブジェクトが追加されます。
 
なお、今回の変更はコンテンツAPIのレスポンスには影響ありません。

上記のシーケンス図において、①のタイミングで送信されるデータ（MICROCMS_GET_DEFAULT_DATA）が今回の変更対象となります。

（※1）拡張フィールドとして登録されたアプリケーションは、コンテンツの新規作成画面および編集画面上では iframe 要素として読み込まれて表示されます。以降、本記事では説明を簡略化するため、このアプリケーションを「iframe要素」と表記します。

変更後のデータ例（※太字が追加部分）

{
 "id": "some-id", // iframe識別子が入ります。
 "action": "MICROCMS_GET_DEFAULT_DATA",
 "user": {
  "email": "example@microcms.co.jp"
 },
 "message": {
  "data": "iframeでデータを登録しています" // 拡張フィールドの実データが入ります。
 },
 "context": {
  "type": "new_content",
  "endpoint": "some-api",
  "content": {
   "id": null
  }
 }
}

追加される context オブジェクトの内容

type

"new_content" または "edit_content" のいずれかが入ります。
コンテンツの新規作成時は "new_content" が、編集時には "edit_content" が入ります。

endpoint

コンテンツAPIのエンドポイント名が入ります。

content（id）

コンテンツのIDが入ります。
コンテンツの新規作成時は null が、編集時には実際のコンテンツIDが入ります。

変更の背景

従来、拡張フィールドでは「どのコンテンツ／APIから呼び出されているのか」をiframe要素側で把握することができませんでした。
 
今回の仕様変更により、microCMSから MICROCMS_GET_DEFAULT_DATA として送信される初期データに context オブジェクトが追加されるため、呼び出し元のコンテンツやAPIの判別が可能となります。

影響の可能性があるサービス

以下の両方の条件を満たす場合、本仕様変更により影響を受ける可能性があります。

1. APIで拡張フィールドを利用している
2. iframe要素内で、microCMSから送信される初期データをもとに処理を実行している

推奨される対応

大多数のケースでは、対応は不要です。
 
もし、iframe要素で初期データの構造に依存した処理を実装されている場合は、追加される context オブジェクトによる影響をご確認の上、必要に応じて処理をご調整ください。

変更予定日

2025年5月26日（月） アップデート以降
※ 不具合や想定外の事項があった場合、リリース日は変更となる可能性がございます。

本件に関するお問い合わせ先

今後もより使いやすいサービスになるよう改善を続けてまいります。
ご不明点がございましたら、お気軽にお問い合せくださいませ。
引き続き、microCMSをよろしくお願いいたします。

microCMSサポート窓口
support@microcms.io