microCMS

【仕様変更】ファイルフィールドへの値の追加について

microCMS編集部

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

この度、2024年4月1日に予定されている機能追加によって、ご利用方法によっては、ご利用中のサービスに影響を及ぼす可能性があるため、ご連絡いたしました。

追加内容

1. ファイルフィールドを利用しているAPIにおいて、コンテンツAPI(GET)のレスポンスに、ファイルサイズに関するデータ(fileSizeプロパティ)が追加されます。
 
◼️ 変更前

"file": {
 "url": "https://files.microcms-assets.io/assets/xxxx/yyyy/sample.pdf"
}

 
◼️ 変更後

"file": {
  "url": "https://files.microcms-assets.io/assets/xxxx/yyyy/sample.pdf",
  "fileSize": 7200000
}

 
※ ファイルサイズの単位はByteです。
 
2. ファイルフィールドを利用しているAPIにおいて、コンテンツのWebhook(カスタム通知)のリクエストボディに、ファイルサイズに関するデータ(fileSizeプロパティ)が追加されます。

※ 変更内容は1番と同様です。

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

以下の2点の両方に当てはまっている場合、影響の可能性があります。

  • コンテンツAPI(GET)もしくはコンテンツのWebhook(カスタム通知)を利用している
  • ファイルフィールドを利用している

影響内容

  1. ファイルフィールドのレスポンスの処理で、urlを取り出さずに、全体のオブジェクトを利用している場合、処理されるデータ内容が変更されます
  2. 1回のリクエストで大量のコンテンツを取得しているケースにおいて、レスポンスサイズの上限(約5MB)を超過して、エラーとなる可能性があります

推奨される対応

ほとんどの場合において、対応は必要ありません。
 
上記の「影響内容」が関係する場合は、それぞれの項目について、以下のような対応が考えられます。

  1. urlの値を取り出して、後続の処理を実施する
  2. limitパラメータoffsetパラメータを利用して、1回あたりに取得するコンテンツの件数を減らす

変更予定日

2024年4月1日(月) アップデート以降
※ リリース時間は午前中を予定しています。
※ 不具合や想定外の事項があった場合、リリース日は変更となる可能性がございます。

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

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

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

まずは、無料で試してみましょう。

APIベースの日本製ヘッドレスCMS「microCMS」を使えば、 ものの数分でAPIの作成ができます。

microCMSを無料で始める

microCMSについてお問い合わせ

初期費用無料・14日間の無料トライアル付き。ご不明な点はお気軽にお問い合わせください。

お問い合わせ

microCMS公式アカウント

microCMSは各公式アカウントで最新情報をお届けしています。
フォローよろしくお願いします。

  • X
  • Discord
  • github

ABOUT ME

microCMS編集部
microCMS関連情報や技術情報など役立つコンテンツをお届けします!