REST API V1の作品へのレビュー

作品へのレビューを取得・投稿・編集・削除するエンドポイントです。

リクエストの送り方やページネーションについてはREST API V1の概要をご参照ください。
エピソードごとの感想はREST API V1のエピソードへの記録で扱います。

GET /v1/reviews

作品へのレビューを取得することができます。

フィールド

名前	概要
id	レビューID
title	[非推奨] レビュータイトル
body	感想
rating_animation_state	レビューしたときに付けられたレーティング (作画)。bad average good great の4種類のうち1つが入っています。
rating_music_state	レビューしたときに付けられたレーティング (音楽)。bad average good great の4種類のうち1つが入っています。
rating_story_state	レビューしたときに付けられたレーティング (ストーリー)。bad average good great の4種類のうち1つが入っています。
rating_character_state	レビューしたときに付けられたレーティング (キャラクター)。bad average good great の4種類のうち1つが入っています。
rating_overall_state	レビューしたときに付けられたレーティング (全体)。bad average good great の4種類のうち1つが入っています。
likes_count	Likeされた数
impressions_count	PV数
modified_at	レビューが編集された日時
created_at	レビューが投稿された日時
user	このレビューを投稿した利用者の情報。取得できるフィールドはREST API V1のユーザと同じです。
work	このレビューが紐づく作品情報。取得できるフィールドはREST API V1の作品と同じです。

パラメータ

名前	概要	使用例
fields	レスポンスボディに含まれるデータのフィールドを絞り込みます。	fields=id,body
filter_ids	レビューをレビューIDで絞り込みます。	filter_ids=1,2,3
filter_work_id	レビューを作品IDで絞り込みます。	filter_work_id=1111
filter_has_review_body	レビューを感想のあるなしで絞り込みます。感想付きのレビューのみに絞り込むときは true を、感想の無いレビューのみに絞り込むときは false を指定します。	filter_has_review_body=true
page	ページ数を指定します。	page=2
per_page	1ページに何件取得するかを指定します。デフォルトは 25 件で、50 件まで指定できます。	per_page=30
sort_id	レビューをレビューIDで並び替えます。asc または desc が指定できます。	sort_id=desc
sort_likes_count	レビューをLikeされた数で並び替えます。asc または desc が指定できます。	sort_likes_count=desc

リクエスト例

$ curl -X GET https://api.annict.com/v1/reviews?filter_work_id=3994&access_token=(access_token)

{
  "reviews": [
    {
      "id": 594,
      "title": "あぁ^～心がぴょんぴょんするんじゃぁ^～",
      "body": "みんなかわいい",
      "rating_animation_state": "good",
      "rating_music_state": "good",
      "rating_story_state": "good",
      "rating_character_state": "great",
      "rating_overall_state": "great",
      "likes_count": 0,
      "impressions_count": 1,
      "modified_at": null,
      "created_at": "2017-06-24T18:51:35.075Z",
      "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "アニメ好きが高じてこのサービスを作りました。",
        "url": "http://shimba.co",
        "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
        "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
        "records_count": 1906,
        "followings_count": 258,
        "followers_count": 205,
        "wanna_watch_count": 237,
        "watching_count": 103,
        "watched_count": 335,
        "on_hold_count": 45,
        "stop_watching_count": 244,
        "created_at": "2014-03-02T15:38:40.000Z"
      },
      "work": {
        "id": 3994,
        "title": "ご注文はうさぎですか？",
        "title_kana": "ごちゅうもんはうさぎですか",
        "title_en": "Is the Order a Rabbit?",
        "media": "tv",
        "media_text": "TV",
        "released_on": "2014-04-10",
        "released_on_about": "",
        "official_site_url": "http://www.gochiusa.com/",
        "wikipedia_url": "http://ja.wikipedia.org/wiki/%E3%81%94%E6%B3%A8%E6%96%87%E3%81%AF%E3%81%86%E3%81%95%E3%81%8E%E3%81%A7%E3%81%99%E3%81%8B",
        "twitter_username": "usagi_anime",
        "twitter_hashtag": "gochiusa",
        "images": {
          "recommended_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
          "facebook": {
            "og_image_url": ""
          },
          "twitter": {
            "mini_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=mini",
            "normal_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=normal",
            "bigger_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
            "original_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=original",
            "image_url": ""
          }
        },
        "episodes_count": 12,
        "watchers_count": 1463,
        "reviews_count": 6,
        "no_episodes": false,
        "season_name": "2014-spring",
        "season_name_text": "2014年春"
      }
    }
  ],
  "total_count": 6,
  "next_page": null,
  "prev_page": null
}

POST /v1/me/reviews

作品へのレビューが投稿できます。

このリクエストには「読み込み + 書き込み」のスコープを持つアクセストークンが必要になります。

パラメータ

名前	概要	データ例
work_id	[必須] 作品ID	3994
body	[必須] 感想	みんなかわいい
title	[非推奨] タイトル。現在このプロパティに入力された文字列は感想にマージされます。	あぁ^～心がぴょんぴょんするんじゃぁ^～
rating_animation_state	レーティング (作画)。bad average good great が入力できます。	great
rating_music_state	レーティング (音楽)。bad average good great が入力できます。	great
rating_story_state	レーティング (ストーリー)。bad average good great が入力できます。	great
rating_character_state	レーティング (キャラクター)。bad average good great が入力できます。	great
rating_overall_state	レーティング (全体)。bad average good great が入力できます。	great
share_twitter	レビューをTwitterにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。	true
share_facebook	レビューをFacebookにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。	true

title を指定すると、title と body を改行2つでつないだ文字列が感想として保存されます。

リクエスト例

$ curl -X POST "https://api.annict.com/v1/me/reviews?work_id=3994&body=みんなかわいい&rating_overall_state=great&access_token=(access_token)"

レスポンスは、投稿したレビュー1件を GET /v1/reviews の reviews に入る要素と同じ形式で返します。

PATCH /v1/me/reviews/:id

作成したレビューを編集することができます。

このリクエストには「読み込み + 書き込み」のスコープを持つアクセストークンが必要になります。

パラメータ

名前	概要	データ例
id	[必須] レビューID	595
body	[必須] 感想	みんなかわいい
title	[非推奨] タイトル。現在このプロパティに入力された文字列は感想にマージされます。	あぁ^～心がぴょんぴょんするんじゃぁ^～
rating_animation_state	レーティング (作画)。bad average good great が入力できます。	great
rating_music_state	レーティング (音楽)。bad average good great が入力できます。	great
rating_story_state	レーティング (ストーリー)。bad average good great が入力できます。	great
rating_character_state	レーティング (キャラクター)。bad average good great が入力できます。	great
rating_overall_state	レーティング (全体)。bad average good great が入力できます。	great
share_twitter	レビューをTwitterにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。	true
share_facebook	レビューをFacebookにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。	true

リクエスト例

$ curl -X PATCH "https://api.annict.com/v1/me/reviews/595?body=みんなかわいい！！&access_token=(access_token)"

レスポンスは POST /v1/me/reviews と同じ形式です。
編集したレビューは modified_at に編集した日時が入ります。

DELETE /v1/me/reviews/:id

作成したレビューを削除することができます。

このリクエストには「読み込み + 書き込み」のスコープを持つアクセストークンが必要になります。

パラメータ

名前	概要	データ例
id	[必須] レビューID	595

リクエスト例

$ curl -X DELETE "https://api.annict.com/v1/me/reviews/595?access_token=(access_token)"

HTTP/1.1 204 No Content

関連する項目

• REST API V1の概要
• REST API V1の作品
• REST API V1のエピソードへの記録
• REST API V1のアクティビティ
• 開発者向けヘルプ