こんにちは。本日の更新情報をお知らせします。
コンテンツのステータスに新しく「公開終了」ステータスが追加されました。
公開中のコンテンツを公開終了することでこのステータスが付与されるようになります。
変更内容
以前までコンテンツのステータスは大きく分けて「公開中」「下書き中」2つのステータスがありました。
今回のアップデートにより、「公開終了」ステータスが追加されます。
コンテンツのステータスが公開終了になるケースを説明します。
以下のように「公開中」ステータスのコンテンツ編集画面で、「公開終了にする」をクリックします。
クリックすると、コンテンツのステータスが「公開終了」になります。
「公開終了」ステータスのコンテンツはAPIで呼び出したり、下書き追加をすることができません。
再編集や、ステージング環境で表示を確認などは「下書きに戻す」をクリックして「下書き中」ステータスに戻すことで可能です。
また再度公開をしたい場合は、「再公開」をクリックしてください。
「公開中」コンテンツをこれまで通り「下書き」ステータスに戻したい場合は三点リーダーをクリックして「下書きに戻す」を選択してください。
APIでの呼び出し
前述した通り、コンテンツAPIで「公開終了」ステータスのコンテンツを呼び出すことはできません。
「公開中」もしくは「下書き中」ステータスに変更してそれぞれコンテンツAPIで呼び出しを行なってください。
マネジメントAPI(ベータ)では「公開終了」ステータスのコンテンツを呼び出すことができます。
マネジメントAPIについて詳しくはドキュメントをご覧ください
https://document.microcms.io/management-api
以下のようにして「公開終了」ステータスのコンテンツも含めて呼び出すことができます。
curl https://service_id.microcms-management.io/api/v1/contents/api_name -H "X-MICROCMS-API-KEY: XXXXXXXXXX"
以下はレスポンスの例になります。コンテンツステータス「CLOSED」とclosedAt(公開終了した時刻)がレスポンスに含まれます。
{
"id": "string",
"createdAt": "2022-03-01T04:49:01.635Z",
"updatedAt": "2022-03-01T05:05:54.711Z",
"publishedAt": "2022-03-01T04:49:01.635Z",
"revisedAt": "2022-03-01T04:49:01.635Z",
"closedAt": "2022-03-01T05:05:54.711Z",
"status": [
"CLOSED"
],
"draftKey": "string",
"createdBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
"updatedBy": "681dcd71-b7b9-4149-b45b-5e96eb51fecf",
"reservationTime": null
}
マネジメントAPIではPATCH APIを用いることで、コンテンツの公開状態をAPI経由で変更することができますが、「公開終了」にステータスを変更することはできません。
つまり
{"status": ["CLOSED"]}
のように指定することはできません。
マネジメントAPIのPATCH APIについては以下のドキュメントも合わせてご覧ください。
https://document.microcms.io/management-api/patch-contents-status
公開開始・公開停止予約
「公開終了」ステータスのコンテンツを公開開始・公開停止予約することもできます。
予約をするには、三点リーダーのアイコンをクリックして「予約」をクリックします。
クリックすると予約設定画面が開くので、公開開始・公開停止予約をしたい時刻を設定します。
「公開終了」ステータスのコンテンツは
- 公開停止予約のみ(公開開始予約を先にする必要がある)
- 過去にさかのぼった日時の公開開始
の予約はできません。
設定ボタンをクリックすると、「予約中」ステータスになり公開開始時刻になるとコンテンツが公開されます。
権限
コンテンツの公開権限(全権限)を持つユーザーのみ公開中のコンテンツのステータスを「公開終了」に変更することができます。
また「下書きまで」の権限を持つメンバーは「公開終了」ステータスのコンテンツを「下書き中」に戻すことができます。
最後に
「公開終了」ステータスの追加により、コンテンツ管理がよりしやすくなるかと思います。ぜひお試しください。
また、コンテンツのステータスを自在にカスタマイズできる機能のリリースを予定しています。
これからもより使いやすいサービスとなるよう改善・機能追加を進めていきます。ぜひご期待ください!
-----
microCMSは日々改善を進めています。
ご意見・ご要望は管理画面右下のチャット、公式Twitter、お問い合わせからお気軽にご連絡ください!
引き続きmicroCMSをよろしくお願いいたします!