microCMS

APIのレスポンスに改定日時が含まれるようになりました

更新情報
松田 承一

こんにちは、ウォンタ株式会社代表取締役の松田です。
本日の更新情報をお知らせいたします!

APIのレスポンスに改定日時が含まれるようになりました

コンテンツを保存した際に自動で付与される値としてrevisedAt(改定日時)が新たに含まれるようになりました。
この値を使うことで、例えば公開したコンテンツをいつ変更したかクライアントサイドにて表示できるようになります。

revisedAt値は自動で含まれるため特別な対応は何も必要ありません。
例えば以下のようにAPI呼び出せばその値を確認できます。

$curl "https://{DOMAIN}.microcms.io/api/v1/{YOUR_API}/{CONTENT_ID}" -H "X-API-KEY: {YOUR_API_KEY}"

{
  "id": "4zac6bjwz",
  "createdAt": "2020-11-23T08:49:11.347Z",
  "updatedAt": "2020-11-23T08:49:16.567Z",
  "publishedAt": "2020-11-23T08:49:15.150Z",
  "revisedAt": "2020-11-23T08:49:16.567Z",
  "title": "適当なコンテンツ"
}

revisedAt(改定日時)とは何か?

これまで、自動で付与される日時データとして以下の3つが存在していました。

  • createdAt:コンテンツの作成日時
  • updatedAt:コンテンツの更新日時(下書き、公開のどちらでも変更される)
  • publishedAt:コンテンツの公開日時


これに対してrevisedAtコンテンツの公開内容が更新された日時を示す値です。
実際のコンテンツ更新の流れで各日時の変化を考えてみましょう。

  1. コンテンツAを新規作成し公開 → createdAtupdatedAtpublishedAtrevisedAtの全ての値が付与される
  2. コンテンツAを下書き保存(公開かつ下書き状態になる:リライトを開始する) → updatedAtが更新される。publishedAtrevisedAtはそのまま。
  3. コンテンツAを公開(公開状態になる:リライト内容を公開する)→ updatedAtrevisedAtが更新される。publishedAtはそのまま。


このようにrevisedAtはコンテンツの公開内容が変わった場合のみ値が変更されます。

revisedAt(改定日時)の使い所

一例としてブログなどのメディアサイトを考えます。
こうしたサイトではコンテンツは主に記事となりますが、記事は公開後その内容をしばしば変更する必要があります。
そういった場合の「最後に変更をした日時」としてrevisedAtはご利用いただけます。
(これまでもupdatedAtはありましたが下書き保存だけでも更新される値のためこのような用途には不向きでした)

注意点

今回新たに導入されたrevisedAt(改定日時)は本日以降に新たに公開・編集されたコンテンツに対してのみ付与されます。
そのため作成や更新が昨日以前のコンテンツには付与されていませんのでご注意ください。

おわりに

新たに追加されたrevisedAt(改定日時)についてご案内しました。
こちらの内容はドキュメントでも確認できますので合わせてご確認ください。
本日は以上です!ありがとうございました。

-----

microCMSは日々改善を進めています。
ご意見・ご要望は管理画面右下のチャット、公式Twitterメールからお気軽にご連絡ください!
引き続きmicroCMSをよろしくお願いいたします!

ABOUT ME

松田 承一
ウォンタ株式会社の代表 / 家族=👨‍👩‍👧 / ヤフー→大学教員など→現職 / 管理画面付きAPIがすぐに作れるmicroCMSというサービス作ってます。

microCMSとは

  1. 開発者、編集者どちらも分かりやすい管理画面

  2. 細かな権限管理や豊富な外部サービス・データ連携

  3. 安心の日本製・日本語でのチャットサポート