→ 公開日時はpublishedAt、更新日時はrevisedAtをご利用ください。
公開日時/更新日時のいずれも、コンテンツに自動的に付与される値をご活用いただけます。公開日時には publishedAt
を、更新日時には revisedAt
をお使いください。
公開日時について
記事の公開日時には publishedAt
をお使いいただけます。
publishedAt
はコンテンツ編集画面内のインターフェースから変更ができます。
「公開日時」欄の日付をクリックするとモーダルウィンドウが開き、日時を指定できます。
また、publishedAt
はコンテンツAPIの書き込み系のリクエスト(POST/PUT/PATCH)からの変更にも対応しています。詳細は、以下のドキュメントをご覧ください。
自動で付与されるフィールドの指定方法 - POST /api/v1/{endpoint}|microCMSドキュメント
コンテンツを公開後に更新(上書き)した後も、publishedAt
は更新されません。コンテンツが更新された日時を表示したい場合、後述する revisedAt
をご利用ください。
更新日時について
記事の更新日時には revisedAt
をお使いいただけます。
revisedAt
はコンテンツを更新した際に自動的に上書きされます。なお、下書き保存時には値が更新されず、公開したタイミングでのみ値が更新されます。
更新日時の実装例
microCMS公式ドキュメントの各記事に表示している「最終更新日時」にも revisedAt
を利用しています。
自動付与される値の違いと使い分け
createdAt
microCMS上にコンテンツを作成した日時です。コンテンツの公開日ではありません。
コンテンツの作成以降、値は更新されません。
createdAt
は記事を作成したタイミングが値となるため、ウェブサイトの表示に利用すると、下書き状態で記事を作成したタイミングが露出するなどの不都合があります。
基本的には、内部での管理などに利用いただく値となります。
updatedAt
コンテンツを更新した日時です。
updatedAt
は下書きを保存した場合でも更新される値となるため、ウェブサイトの表示に利用すると、下書きを保存したタイミングが露出したり、意図せず記事の並び順が変わるなどの不都合があります。
createdAt
と同じく、基本的には、内部での管理などに利用いただく値となります。
publishedAt
コンテンツを公開した日時です。
「公開中かつ下書き中」の記事を公開した場合は値は更新されないため、コンテンツの更新に影響されない公開日時としてご利用いただけます。
また、管理画面の「公開日時」から任意の日付に変更することも可能です。
コンテンツの公開日時をウェブサイトに表示したい場合は、publishedAt
をご利用ください。
revisedAt
公開中のコンテンツを更新した日時です。
updatedAt
とは異なり、下書きの保存では更新されない値となるため、下書きの保存などに影響されない更新日時としてご利用いただけます。
コンテンツの更新日時をウェブサイトに表示したい場合は、revisedAt
をご利用ください。
revisedAt
および updatedAt
はコンテンツAPIの書き込み系のリクエスト(POST/PUT/PATCH)からは変更できません。
日時を手動で管理したい場合は、APIスキーマにて設定できる「日時フィールド」をお使いください。