コンテンツに自動付与される値
コンテンツの保存後、自動でいくつかの値が付与されます。
自動で付与された値は管理画面で確認や変更が可能なほか、コンテンツAPIでも取得が可能です。
contentId:コンテンツのid
作成したコンテンツのidです。
コンテンツIDの設定に沿った文字列で構成されます。(コンテンツIDの設定についてはこちら)
contentIdは管理画面上で編集が可能です。
コンテンツAPIではパスを示す部分ですので、スラッグとしての利用も可能です。
createdAt:コンテンツの作成日時
コンテンツを作成した日時です。
初回にコンテンツを作成した日時が含まれます。
updatedAt:コンテンツの更新日時
コンテンツを更新した日時です。
コンテンツの更新にあたる操作やイベントには以下が含まれます。
- 管理画面上での「公開」ボタン押下
- 管理画面上での「下書きを追加」ボタン押下
- 管理画面上での「下書きの破棄」ボタン押下
- 管理画面上での「下書きに戻す」ボタン押下
- 管理画面上での「公開終了にする」ボタン押下
- 公開予約・予約停止による公開状態の変化時
publishedAt:コンテンツの公開日時
コンテンツを公開した日時です。
現在のmicroCMSでは、コンテンツのステータスが以下の4つのうちのいずれかとなります。
- 公開中
- 公開終了
- 下書き中
- 公開中かつ下書き中
このうち、「公開終了」もしくは「下書き中」から、「公開中」に変更された日時がpublishedAtが変更される日時となります。
公開日時は、公開してある記事を一度下書きにした後、再度公開を行った場合にも値が変化します。
下記にいくつかのパターンと公開日時の状態を示します。
- 下書き中:公開日時は存在しない。
- 下書き中→公開中:公開日時が付与される。
- 下書き中→公開中→下書き中→公開中:2回目に公開したタイミングで公開日時が更新される。
- 下書き中→公開中→公開中かつ下書き中→公開中:記事のリライトなどの想定。1回目の公開以降、下書き保存は追加されるものの常に公開状態。そのため2回目の公開時にも公開日時は更新されない。
revisedAt:コンテンツの改定日時
公開状態のコンテンツが更新された日時です。
上記更新日時(updatedAt)との違いとして、改定日時(revisedAt)は下書き保存時には値が更新されません。
そのため記事などで「更新日」の表記が必要な場合には改定日時をお使いいただけます。
管理画面における公開ボタンの押下、もしくはPOST / PUT / PATCHといった書き込み系APIによる公開状態の更新時に値が更新されます。