オークション

評価

Version 1

リクエストURL

XML

http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating

特定のYahoo! JAPAN IDの評価を参照する機能を提供します。

リクエストパラメータ

「RESTリクエストの構築（GET）」および、「RESTリクエストの構築（POST）」をご参照ください。

パラメータ	値	説明
appid（必須）	string	アプリケーションID。詳細はこちらをご覧ください。
id（必須）	string	評価を参照する対象のYahoo! JAPAN IDです。
auctionID	string	オプションパラメータ。authorパラメータとセットで指定することにより、該当のオークション/評価者との評価のやりとりがすべて返されます。
author	string	オプションパラメータ（評価者のYahoo! JAPAN ID）。auctionIDパラメータとセットで指定することにより、該当のオークション/評価者との評価のやりとりがすべて返されます。
page	integer:1（デフォルト）	評価のページ番号です。デフォルトは1となり最初のページを返します。

サンプルリクエストURL

http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?appid=<あなたのアプリケーションID>&id=<評価を参照する対象のYahoo! JAPAN ID>

レスポンスフィールド

評価Web APIのスキーマの記述は、以下のURLをご覧ください。
http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating.xsd

フィールド	説明
ResultSet	クエリーレスポンスのすべてを含みます。 totalResultsAvailable: 評価の総件数です。 totalResultsReturned: 返された値の件数です。 firstResultPosition: 最初のデータが何件目にあたるかです。
TotalGoodRating	非常に良い・良いの評価の総数です。
TotalBadRating	非常に悪い・悪いの評価の総数です。
Result	各個別レスポンスを含みます。 totalRatingFieldAvailable: RatingField件数の総個数です。
AuctionID	オークションIDです。
Title	商品のタイトルです。
Id	落札者のYahoo! JAPAN IDです。
ItemListURL	落札者の出品リストを取得するリクエストURLです。（appidは含まれていませんのでご注意ください）
RatingURL	評価参照APIへのリクエストURLです。（appidは含まれていませんのでご注意ください）
EndTime	終了日時です。RFC3339に準拠した表現を用います。（例：2004-04-01T12:00:00+09:00）
Rating	veryGood 非常に良い good 良い normal どちらでもない bad 悪い veryBad 非常に悪い
IsMore	コメントはコメント者、返答者それぞれの最新のコメント1件ずつ（計2件）のみresponseに含まれます。コメント総数が2件以上ある際には、本値がtrueとなります。すべてのコメントを取得するには、requestパラメータにauctionIDとauthorをセットで指定してください。 auctionIDとauthorをセットで指定した際（全件表示）には、false固定となります。
RatingField	コメントの個別レスポンスフィールドです。
Comment	コメントまたは返答の内容です。
Date	コメント日時です。RFC3339に準拠した表現を用います。(例：2004-04-01T12:00:00+09:00)
SellerOrWinner	seller 出品者からの返答 winner 落札者からのコメント

サンプルレスポンス

以下は、YID=abc123456xyzの評価一覧です。

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="220" totalResultsReturned="50" firstResultPosition="101">
    <TotalGoodRating>123</TotalGoodRating>
    <TotalBadRating>11</TotalBadRating>
    <Result totalRatingFieldAvailable=2>
        <AuctionID>x12345678</AuctionID>
        <Title>商品名1</Title>
        <Author>
            <Id>rater_1</Id>
            <ItemListURL>http://auctions.yahooapis.jp/AuctionWebService/V1/SellingList?sellerID=rater_1</ItemListURL>
            <RatingURL>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=rater_1</RatingURL>
        </Author>
        <EndTime>2004-04-08T12:00:00+09:00</EndTime>
        <Rating>veryGood</Rating>
        <IsMore>false</IsMore>
        <RatingField>
            <Comment>非常に良い品をありがとうございました。</Comment>
            <Date>2004-04-08T12:00:00+09:00</Date>
            <SellerOrWinner>winner</SellerOrWinner>
        </RatingField>
        <RatingField>
            <Comment>こちらこそご落札ありがとうございました。</Comment>
            <Date>2004-04-08T12:00:00+09:00</Date>
            <SellerOrWinner>seller</SellerOrWinner>
        </RatingField>
    </Result>
    <Result totalRatingFieldAvailable=3>
        <AuctionID>c987654321</AuctionID>
        <Title>商品名2</Title>
        <Author>
            <Id>rater_2</Id>
            <ItemListURL>http://auctions.yahooapis.jp/AuctionWebService/V1/SellingList?sellerID=rater_2</ItemListURL>
            <RatingURL>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=rater_2</RatingURL>
        </Author>
        <EndTime>2004-04-08T12:00:00+09:00</EndTime>
        <Rating>veryBad</Rating>
        <IsMore>true</IsMore>
        <RatingField>
            <Comment>振込み金額が足りない旨のメール送信しています。メールを確認してください。</Comment>
            <Date>2004-04-08T12:00:00+09:00</Date>
            <SellerOrWinner>seller</SellerOrWinner>
        </RatingField>
        <RatingField>
            <Comment>メールなんて届いていません。早く送ってください。</Comment>
            <Date>2004-04-08T12:00:00+09:00</Date>
            <SellerOrWinner>winner</SellerOrWinner>
        </RatingField>
    </Result>

（以下 <Result totalRatingFieldAvailable> 要素繰り返し）

</ResultSet>

以下は、YID=abc123456xyzに対する、YID=rater_1からの評価一覧です。

<?xml version="1.0" encoding="UTF-8" ?> 
 <ResultSet totalResultsAvailable="72" totalResultsReturned="50" firstResultPosition="1">
    <TotalGoodRating>17</TotalGoodRating> 
    <TotalBadRating>16</TotalBadRating> 
    <Result totalRatingFieldAvailable="2">
        <AuctionID>x12345678</AuctionID> 
        <Title>商品1</Title> 
        <Author>
            <Id>rater_1</Id> 
            <ItemListURL>http://auctions.yahooapis.jp/AuctionWebService/V1/SellingList?sellerID=rater_1</ItemListURL> 
            <RatingURL>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=rater_1</RatingURL> 
        </Author>
        <EndTime>2008-08-04T18:17:39+09:00</EndTime> 
        <Rating>veryGood</Rating> 
        <IsMore>true</IsMore> 
        <RatingField>
            <Comment>非常に良い品をありがとうございました。</Comment> 
            <Date>2008-08-04T18:25:20+09:00</Date> 
            <SellerOrWinner>seller</SellerOrWinner> 
        </RatingField>
        <RatingField>
            <Comment>こちらこそ落札ありがとうございました。</Comment> 
            <Date>2008-08-06T14:50:38+09:00</Date> 
            <SellerOrWinner>winner</SellerOrWinner> 
        </RatingField>
    </Result>
    <Result totalRatingFieldAvailable="1">
        <AuctionID>y12345678</AuctionID> 
        <Title>商品3</Title> 
        <Author>
            <Id>rater_1</Id> 
            <ItemListURL>http://auctions.yahooapis.jp/AuctionWebService/V1/SellingList?sellerID=rater_1</ItemListURL> 
            <RatingURL>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=rater_1</RatingURL> 
        </Author>
        <EndTime>2008-08-04T18:17:32+09:00</EndTime> 
        <Rating>veryGood</Rating> 
        <IsMore>false</IsMore> 
        <RatingField>
            <Comment>とても良い品をありがとうございました。</Comment> 
            <Date>2008-08-04T18:25:06+09:00</Date> 
            <SellerOrWinner>seller</SellerOrWinner> 
        </RatingField>
    </Result>

（以下 <Result totalRatingFieldAvailable> 要素繰り返し）

</ResultSet>

以下は、auctionID=c987654321のすべての評価のやりとりです。

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
    <TotalGoodRating>123</TotalGoodRating>
    <TotalBadRating>11</TotalBadRating>
    <Result totalRatingFieldAvailable=3>
        <AuctionID>c987654321</AuctionID>
        <Title>商品名2</Title>
        <Author>
            <Id>rater_2</Id>
            <ItemListURL>http://auctions.yahooapis.jp/AuctionWebService/V1/SellingList?sellerID=rater_2</ItemListURL>
            <RatingURL>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=rater_2</RatingURL>
        </Author>
        <EndTime>2004-04-08T12:00:00+09:00</EndTime>
        <Rating>veryBad</Rating>
        <IsMore>false</IsMore>
        <RatingField>
            <Comment>振込み金額が足りない旨のメール送信しています。メールを確認してください。</Comment>
            <Date>2004-04-08T12:00:00+09:00</Date>
            <SellerOrWinner>seller</SellerOrWinner>
        </RatingField>
        <RatingField>
            <Comment>メールなんて届いていません。早く送ってください。</Comment>
            <Date>2004-04-08T12:00:00+09:00</Date>
            <SellerOrWinner>winner</SellerOrWinner>
        </RatingField>
        <RatingField>
            <Comment>送りました。確認してください。</Comment>
            <Date>2004-04-08T12:00:00+09:00</Date>
            <SellerOrWinner>winner</SellerOrWinner>
        </RatingField>
    </Result>

（以下 <Result totalRatingFieldAvailable> 要素繰り返し）

</ResultSet>

エラー

評価Web APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

評価

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

エラー

評価を使用した開発に関するQ＆A

お役立ち度の高い解決済みの質問

Web APIとその他のサービス

API

その他

このAPIを使ったサンプルコード

関連ドキュメント

開発者ブログ

開発者コミュニティ

開発のヒント

法人デベロッパー専用お問い合わせ