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

更新情報

2020/06/10

松田承一

この記事は公開後、1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

みなさん、こんにちは。
ウォンタ株式会社代表取締役の松田です。
本日はAPIへの機能追加に関するお知らせです！

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

これまで、コンテンツに自動で付与される日時は以下の2つのみでした。

作成日時（createdAt）
更新日時（updatedAt）

本日以降、新たなフィールドのひとつである公開日時が追加され、自動的にAPIのレスポンスに含まれるようになりました。

公開日時（publishedAt）

APIのレスポンスを確認する

さっそくですが実際にAPIを叩いて公開日時を確認してみましょう。
まずは適当なコンテンツを作成・公開し、次にcurlコマンドなどでコンテンツAPIを叩きます。

$curl "https://XXXX.microcms.io/api/v1/YOUR_API/CONTENT_ID" -H "X-MICROCMS-API-KEY: e32c0ea2-457d-4ce3-82c9-7b6287acab99"

すると以下のようなレスポンスが返ってくることが確認できるでしょう。これまであったcreatedAtやupdatedAtに加え、publishedAtもレスポンスに含まれています。

{
    "id": "4zac6bjwz",
    "createdAt": "2020-06-09T08:49:11.347Z",
    "updatedAt": "2020-06-09T08:49:11.347Z",
    "publishedAt": "2020-06-09T08:49:11.347Z",
    "title": "適当なコンテンツ"
}

公開日時とは？

今回追加された公開日時の仕様を説明していきます。
まず、公開日時とはその名の通りコンテンツが公開された日時を示します。

本日現在のmicroCMSでは、コンテンツに3つのステータスのうちいずれかひとつの状態となります。

公開中
下書き中
公開中かつ下書き中

このうち、「下書き中」から「公開中」に変更された日時が今回追加された公開日時となります。
公開日時は公開してある記事を一度下書きにした後、再度公開を行った場合にも値が変化しますのでご留意ください。
以下のいくつかのパターンで、公開日時がどのように設定されるかを確認してみましょう。

下書き中：公開日時は存在しない。
下書き中→公開中：公開日時が付与される。
下書き中→公開中→下書き中→公開中：2回目に公開したタイミングで公開日時が更新される。
下書き中→公開中→公開中かつ下書き中→公開中：記事のリライトなどの想定。1回目の公開以降、下書き保存は追加されるものの常に公開状態。そのため2回目の公開時にも公開日時は更新されない。

注意点

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

本日の更新情報は以上となります。
ぜひ公開日時（publishedAt）を便利にお取り扱いください！