本文へスキップ

作品のレビューの一覧

GET/v1/works/{id}/reviews

作品の公開済みレビューを、参考になった順、日付順、スコア順で、絞り込みとともに返します。

リクエスト

Shell
curl "https://api.nogitsu.com/v1/works/01a0cb02-0a14-7877-911d-5b4dde76df72/reviews"

パラメーター

  • id

    パス必須

    項目のID(UUID)。

    テキスト

  • sort

    クエリ任意

    結果の順序。

    テキスト

    使用できる値helpfulnewesthighestlowest

    既定値:helpful

  • score

    クエリ任意

    このスコアを付けたレビューのみ。

    整数

    1〜10

  • language

    クエリ任意

    この言語で書かれたレビューのみ。

    テキスト

  • completedOnly

    クエリ任意

    true で作品を完了したメンバーのレビューのみ。

    テキスト

  • detailed

    クエリ任意

    true で600文字以上の長いレビューのみ。

    テキスト

  • cursor

    クエリ任意

    前のページの nextCursor の値。最初のページでは省略します。

    テキスト

  • limit

    クエリ任意

    1ページに返す項目数。

    整数

    1〜20既定値:20

レスポンス

リクエストが成功すると、次のJSONとともに200が返ります。

  • itemsオブジェクトのリスト
    • idテキスト (uuid)
    • authorオブジェクト
      • usernameテキスト
      • displayNameテキスト
      • avatarUrlテキスト (uri)null になる場合あり
    • titleテキストnull になる場合あり
    • bodyオブジェクトnull になる場合あり
      • blocks複数の形式のいずれかのリスト
        1. 選択肢1

          • typeテキスト
            使用できる値paragraph
          • children複数の形式のいずれかのリスト
            1. 選択肢1

            2. 選択肢2

            3. 選択肢3

            4. 選択肢4

            5. 選択肢5

        2. 選択肢2

          • typeテキスト
            使用できる値heading
          • children複数の形式のいずれかのリスト
            1. 選択肢1

            2. 選択肢2

            3. 選択肢3

            4. 選択肢4

            5. 選択肢5

        3. 選択肢3

          • typeテキスト
            使用できる値quote
          • childrenRichTextBlockのリスト
        4. 選択肢4

          • typeテキスト
            使用できる値list
          • isOrderedtrue または false
          • itemsRichTextBlockのリストのリスト
        5. 選択肢5

          • typeテキスト
            使用できる値code
          • textテキスト
    • bodyLength整数

      0〜9007199254740991

    • hasSpoilertrue または false
    • spoilerUnit数値null になる場合あり

      0以上

    • sourceSpoilerオブジェクトnull になる場合あり
      • kindテキスト
        使用できる値mangamanhwamanhuawebtoonnovelother
      • unit数値null になる場合あり

        0以上

    • prosテキストのリストnull になる場合あり
    • consテキストのリストnull になる場合あり
    • imagesオブジェクトのリスト
      • urlテキスト (uri)
      • width整数

        0〜9007199254740991

      • height整数

        0〜9007199254740991

      • altテキストnull になる場合あり
      • variantWidths整数のリスト

        0〜9007199254740991

    • languageテキスト
    • scoreHalfPoints整数null になる場合あり

      1〜20

    • categoryScoresオブジェクト
    • trackingStatusテキストnull になる場合あり
      使用できる値plannedcurrentcompletedpauseddroppedrewatching
    • progressUnits数値null になる場合あり

      0以上

    • progressTotal整数null になる場合あり

      0〜9007199254740991

    • repeatCount整数

      0〜9007199254740991

    • authorStatsオブジェクト
      • reviewCount整数

        0〜9007199254740991

      • helpfulCount整数

        0〜9007199254740991

    • helpfulCount整数

      0〜9007199254740991

    • unhelpfulCount整数

      0〜9007199254740991

    • replyCount整数

      0〜9007199254740991

    • createdAtテキスト (date-time)
    • editedAtテキスト (date-time)null になる場合あり
  • nextCursorテキストnull になる場合あり

エラー

他の操作と同様に、この操作も無効なパラメーターでは400、何も見つからない場合は404、リクエストが多すぎる場合は429を返すことがあります。すべてのエラーは同じ形式です。

エラーについて読む