メインコンテンツまでスキップ

非公開のコンテンツをAPIのレスポンスに含めることはできますか?

可能です。
非公開のコンテンツも取得するためのパラメータ(ignore_open_flg)がございますので、有効にしてレスポンスを確認してください。

注意

ignore_open_flgを有効にしたエンドポイントは、公開前のコンテンツもレスポンスに含みます。
利用者を限定する場合は、APIのセキュリティ設定やエンドポイントの権限設定を併せて確認してください。詳細はAPIセキュリティをご覧ください。

設定方法

サイドメニューより[API]をクリックし、対象のエンドポイントの[編集]をクリックします。
Image from Gyazo

詳細設定のignore_open_flgのパラメータにチェックを入れて更新します。
Image from Gyazo

レスポンスの確認

エンドポイントを設定したAPIの[Swagger UI]をクリックします。
Image from Gyazo

対象のエンドポイントの[Try it out]をクリックします。
Image from Gyazo

[Execute]をクリックします。
Image from Gyazo

公開設定が「非公開にする」のコンテンツもレスポンスされていることを確認できます。
Image from Gyazo

非公開のカテゴリ・タグに紐づくコンテンツ

カテゴリやタグが非公開の場合は、次のパラメータを併せて有効にします。

パラメータ説明
ignore_category_open_flgチェックを入れると非公開カテゴリのコンテンツもレスポンスに含めます。
ignore_tag_open_flgチェックを入れると非公開タグのコンテンツもレスポンスに含めます。

「一覧に表示する > 載せない」で登録したコンテンツの場合

「一覧に表示する > 載せない」で登録したコンテンツは、ignore_open_flgではなくget_unlisted_dataで取得します。設定方法は「一覧に表示する > 載せない」で登録したコンテンツをAPIのレスポンスに含めることはできますか?をご覧ください。

関連ドキュメント


サポート

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。