コンテンツに自動付与される値
コンテンツを保存すると、自動でいくつかの値が付与されます。
自動で付与された値は管理画面で確認や変更ができます。また、コンテンツAPIでも取得できます。
id:コンテンツのID
作成したコンテンツのIDです。コンテンツIDの設定に沿った文字列で構成されます。
コンテンツIDは、管理画面上で編集することができます。
また、APIごとに一意な値になるため、スラッグ(URLの一部の文字列)として利用することもできます。
- Information
オブジェクト形式のAPIにはidは付与されません。
updatedAt:コンテンツの更新日時
コンテンツを更新した日時です。
値が更新されるタイミング
以下のいずれかの操作を行った際に、値が更新されます。
管理画面での操作
- [公開]ボタンをクリックしたとき
- [再公開]ボタンをクリックしたとき
- [下書き保存]ボタンをクリックしたとき
- [下書きを追加]ボタンをクリックしたとき
- [下書きの破棄]ボタンをクリックしたとき
- [下書きに戻す]ボタンをクリックしたとき
- [公開終了にする]ボタンをクリックしたとき
- 公開開始予約/公開停止予約により、公開状態が変化したとき
- コンテンツIDを変更したとき
APIでの操作
コンテンツAPI
マネジメントAPI
- ステータス変更したとき(※「下書き中」→「公開中」のみ)
publishedAt:コンテンツの公開日時
コンテンツを公開した日時です。
値が更新されるタイミング
以下のいずれかの操作を行った際に、値が付与または更新されます。
管理画面での操作
- [公開]ボタンをクリックしたとき(※「公開中かつ下書き中」のコンテンツを除く)
- [再公開]ボタンをクリックしたとき
- 管理画面上で任意の公開日時に編集したとき
APIでの操作
コンテンツAPI
- POST APIでコンテンツを登録したとき(※ status=draft パラメータが付与された場合を除く)
- PUT APIでコンテンツを登録したとき(※ status=draft パラメータが付与された場合を除く)
マネジメントAPI
- ステータス変更したとき(※「下書き中」→「公開中」のみ)
公開日時が更新されるタイミングの例
公開日時が更新されるタイミングの例をいくつか示します。
【例1】公開後、リライトをした後に、再公開した場合
1. 下書き中 → 公開中: 公開日時が付与される
2. 公開中 → 公開中かつ下書き中(リライトをし、下書きを追加する): 公開日時は更新されない
3. 公開中かつ下書き中 → 公開中: 公開日時は更新されない
【例2】公開後、下書きに戻した後に、再公開した場合
1. 下書き中 → 公開中: 公開日時が付与される
2. 公開中 → 下書き中(下書きに戻す): 公開日時は更新されない
3. 下書き中 → 公開中: 公開日時は更新される
revisedAt:コンテンツの改定日時
公開中のコンテンツが更新された日時です。
値が更新されるタイミング
以下のいずれかの操作を行った際に、値が付与または更新されます。
管理画面での操作
- [公開]ボタンをクリックしたとき
- [再公開]ボタンをクリックしたとき
- 公開開始予約により、コンテンツが公開されたとき
APIでの操作
コンテンツAPI
- POST APIでコンテンツを登録したとき(※ status=draft パラメータが付与された場合を除く)
- PUT APIでコンテンツを登録したとき(※ status=draft パラメータが付与された場合を除く)
- PATCH APIでコンテンツを更新したとき
マネジメントAPI
- ステータス変更したとき(※「下書き中」→「公開中」のみ)
改定日時が更新されるタイミングの例
改定日時が更新されるタイミングの例を示します。
【例1】公開後、リライトをした後に、再公開した場合
1. 下書き中 → 公開中: 改定日時が付与される
2. 公開中 → 公開中かつ下書き中(リライトをし、下書きを追加する): 改定日時は更新されない
3. 公開中かつ下書き中 → 公開中: 改定日時は更新される
- Tips
更新日時(updatedAt)との違いとして、改定日時(revisedAt)は下書き保存時には値が更新されません。
ですので、記事コンテンツなどで「更新日」の表記が必要な場合には改定日時をお使いいただけます。