Skip to main content

作品への記録

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_countLikeされた数
impressions_countPV数
created_atレビューが投稿された日時
modified_atレビューが編集された日時
userこのレビューを投稿した利用者の情報
workこのレビューが紐づく作品情報。取得できるフィールドは 作品 と同じです。

パラメータ​

名前概要使用例
fieldsレスポンスボディに含まれるデータのフィールドを絞り込みます。fields=id,title
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_page1ページに何件取得するかを指定します。デフォルトは 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,
                "created_at": "2014-03-02T15:38:40.000Z"
            },
            "work": {
                "id": 3994,
                "title": "ご注文はうさぎですか？",
                "title_kana": "ごちゅうもんはうさぎですか",
                "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%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
                "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,
                "season_name": "2014-spring",
                "season_name_text": "2014年春"
            }
        },
        ...
    ],
    "total_count": 6,
    "next_page": null,
    "prev_page": null
}

POST /v1/me/reviews​

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

このリクエストには write スコープが必要になります。

パラメータ​

名前概要データ例
work_id[必須] 作品ID3994
title[非推奨] タイトル。現在このプロパティに入力された文字列は感想にマージされます。あぁ^～心がぴょんぴょんするんじゃぁ^～
body[必須] 感想僕は、リゼちゃん！◯（ ´∀｀ ）◯
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 POST "https://api.annict.com/v1/me/reviews?work_id=3994&title=あぁ^～心がぴょんぴょんするんじゃぁ^～&body=みんなかわいい&rating_animation_state=good&rating_music_state=good&rating_story_state=good&rating_character_state=great&rating_overall_state=great&access_token=(access_token)"
{
    "id": 595,
    "title": "",
    "body": "あぁ^～心がぴょんぴょんするんじゃぁ^～\n\nみんなかわいい",
    "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": 0,
    "modified_at": null,
    "created_at": "2017-06-24T18:59:57.192Z",
    "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "",
        "url": null,
        "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": 123,
        "created_at": "2016-05-03T19:06:59.929Z"
    },
    "work": {
        "id": 3994,
        "title": "ご注文はうさぎですか？",
        "title_kana": "ごちゅうもんはうさぎですか",
        "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%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
        "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,
        "season_name": "2014-spring",
        "season_name_text": "2014年春"
    }
}

PATCH /v1/me/reviews/:id​

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

このリクエストには write スコープが必要になります。

パラメータ​

名前概要データ例
id[必須] 記録ID1016
title[非推奨] タイトル。現在このプロパティに入力された文字列は感想にマージされます。あぁ^～心がぴょんぴょんするんじゃぁ^～
body[必須] 感想僕は、リゼちゃん！◯（ ´∀｀ ）◯
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=みんなかわいい！！&rating_animation_state=good&rating_music_state=good&rating_story_state=good&rating_character_state=great&rating_overall_state=great&access_token=(access_token)"
{
    "id": 595,
    "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": "2017-06-24T19:07:46.257Z",
    "created_at": "2017-06-24T18:59:57.192Z",
    "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "",
        "url": null,
        "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": 123,
        "created_at": "2016-05-03T19:06:59.929Z"
    },
    "work": {
        "id": 3994,
        "title": "ご注文はうさぎですか？",
        "title_kana": "ごちゅうもんはうさぎですか",
        "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%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
        "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,
        "season_name": "2014-spring",
        "season_name_text": "2014年春"
    }
}

DELETE /v1/me/reviews/:id​

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

このリクエストには write スコープが必要になります。

パラメータ​

名前概要データ例
id[必須] 記録ID595

リクエスト例​

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