オークション

入札履歴

リクエストURL
XML
http://auctions.yahooapis.jp/AuctionWebService/V1/BidHistory

ヤフオク!の入札履歴の表示機能を提供します。

リクエストパラメータ

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

パラメータ 説明
appid(必須) string アプリケーションID。詳細はこちらをご覧ください。
output string XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
  • xml :xmlレスポンス(デフォルト)
  • php :PHPserializeレスポンス
  • json :JSONPレスポンス
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
auctionID(必須) string 入札履歴情報取得を実施する対象のオークションIDです。
page integer:1(デフォルト) 入札履歴のページ番号です。デフォルトは1となり最初のページを返します。

サンプルリクエストURL

http://auctions.yahooapis.jp/AuctionWebService/V1/BidHistory?appid=<あなたのアプリケーションID>&auctionID=<商品(オークション)のID>


レスポンスフィールド

入札履歴APIのスキーマの記述は、以下になります。

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含みます。
  • totalResultsAvailable: 履歴件数の総個数です。
  • totalResultsReturned: 履歴の返された個数です。
  • firstResultPosition: 最初のデータが何個目にあたるかです。
/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Bidder 入札者のYahoo! JAPAN IDです。
/ResultSet/Result/Rating 評価を表現するフィールドです。
/ResultSet/Result/Rating/Point 評価ポイントです。新規または今までの評価ポイント総計が0の場合は、0を設定します。新規かどうかを判別する場合は「IsNotRated」をご利用ください。
/ResultSet/Result/Rating/IsNotRated【NEW】 新規の際にtrueとなります。
/ResultSet/Result/Rating/IsSuspended 停止中の際、trueとなります。
/ResultSet/Result/Rating/IsDeleted 登録削除済みの際、trueとなります。
/ResultSet/Result/Price 現在の価格(入札価格)です。
  • isPriceMask:価格マスクされているか。あり(価格を提供しない)の際、trueとなります。
/ResultSet/Result/Quantity 入札した個数です。
/ResultSet/Result/Date 最後に手動で入札した時間です。RFC3339に準拠した表現を用います。(例:2004-04-01T12:00:00+09:00)
/ResultSet/Result/ItemListURL 入札者の出品リストへのリクエストURLです。
/ResultSet/Result/RatingURL 入札者の評価ページへのURLです。
/ResultSet/Result/IsHighestBidder 最高額入札者の際にはtrueとなります。
/ResultSet/Result/IsWinner 落札者の際にはtrueとなります。



サンプルレスポンス

<ResultSet totalResultsAvailable="3" totalResultsReturned="3" firstResultPosition="1">
  <Result>
    <Bidder>mas*****</Bidder>
    <Rating>
      <Point>612</Point>
      <IsNotRated>false</IsNotRated>
      <IsSuspended>false</IsSuspended>
      <IsDeleted>false</IsDeleted>
    </Rating>
    <Price isPriceMask="false">1200.00</Price>
    <Quantity>1</Quantity>
    <Date>2013-02-23T22:14:51+09:00</Date>
    <IsHighestBidder>true</IsHighestBidder>
    <IsWinner>false</IsWinner>
  </Result>
  <Result>
    <Bidder>blo*****</Bidder>
    <Rating>
      <Point>145</Point>
      <IsNotRated>false</IsNotRated>
      <IsSuspended>false</IsSuspended>
      <IsDeleted>false</IsDeleted>
    </Rating>
    <Price isPriceMask="false">1100.00</Price>
    <Quantity>1</Quantity>
    <Date>2013-02-23T09:35:18+09:00</Date>
    <IsHighestBidder>false</IsHighestBidder>
    <IsWinner>false</IsWinner>
  </Result>
  <Result>
    <Bidder>nen*****</Bidder>
    <Rating>
      <Point>467</Point>
      <IsNotRated>false</IsNotRated>
      <IsSuspended>false</IsSuspended>
      <IsDeleted>false</IsDeleted>
    </Rating>
    <Price isPriceMask="false">1000.00</Price>
    <Quantity>1</Quantity>
    <Date>2013-02-23T00:26:34+09:00</Date>
    <IsHighestBidder>false</IsHighestBidder>
    <IsWinner>false</IsWinner>
  </Result>
</ResultSet>

サンプルレスポンス(PHPserialize)

a: 1: {
  s: 9: "ResultSet";
  a: 4: {
    s: 21: "totalResultsAvailable";
    s: 1: "3";
    s: 20: "totalResultsReturned";
    s: 1: "3";
    s: 19: "firstResultPosition";
    s: 1: "1";
    s: 6: "Result";
    a: 3: {
      i: 0;
      a: 7: {
        s: 6: "Bidder";
        s: 8: "mas*****";
        s: 6: "Rating";
        a: 3: {
          s: 5: "Point";
          s: 3: "612";
          s: 10: "IsNotRated";
          s: 5: "false";
          s: 11: "IsSuspended";
          b: 0;
          s: 9: "IsDeleted";
          b: 0;
        }
        s: 5: "Price";
        s: 7: "1200.00";
        s: 16: "PriceIsPriceMask";
        s: 5: "false";
        s: 8: "Quantity";
        s: 1: "1";
        s: 4: "Date";
        s: 28: "
2013-02-23T22:14:51+09:00		";
        s: 15: "IsHighestBidder";
        b: 1;
        s: 8: "IsWinner";
        b: 0;
      }
      i: 1;
      a: 7: {
        s: 6: "Bidder";
        s: 8: "blo*****";
        s: 6: "Rating";
        a: 3: {
          s: 5: "Point";
          s: 3: "145";
          s: 10: "IsNotRated";
          s: 5: "false";
          s: 11: "IsSuspended";
          b: 0;
          s: 9: "IsDeleted";
          b: 0;
        }
        s: 5: "Price";
        s: 7: "1100.00";
        s: 16: "PriceIsPriceMask";
        s: 5: "false";
        s: 8: "Quantity";
        s: 1: "1";
        s: 4: "Date";
        s: 28: "
2013-02-23T09:35:18+09:00		";
        s: 15: "IsHighestBidder";
        b: 0;
        s: 8: "IsWinner";
        b: 0;
      }
      i: 2;
      a: 7: {
        s: 6: "Bidder";
        s: 8: "nen*****";
        s: 6: "Rating";
        a: 3: {
          s: 5: "Point";
          s: 3: "467";
          s: 10: "IsNotRated";
          s: 5: "false";
          s: 11: "IsSuspended";
          b: 0;
          s: 9: "IsDeleted";
          b: 0;
        }
        s: 5: "Price";
        s: 7: "1000.00";
        s: 16: "PriceIsPriceMask";
        s: 5: "false";
        s: 8: "Quantity";
        s: 1: "1";
        s: 4: "Date";
        s: 28: "
2013-02-23T00:26:34+09:00		";
        s: 15: "IsHighestBidder";
        b: 0;
        s: 8: "IsWinner";
        b: 0;
      }
    }
  }
}

サンプルレスポンス(JSONP)

loaded({
  ResultSet: {@attributes: {
      totalResultsAvailable: "3",
      totalResultsReturned: "3",
      firstResultPosition: "1"
    },
    Result: [{
      Bidder: "mas*****",
      Rating: {
        Point: "612",
        IsNotRated: "false",
        IsSuspended: "false",
        IsDeleted: "false"
      },
      Price: "1200.00",
      Quantity: "1",
      Date: " 2013-02-23T22:14:51+09:00	 ",
      IsHighestBidder: "true",
      IsWinner: "false"
    }, {
      Bidder: "blo*****",
      Rating: {
        Point: "145",
        IsNotRated: "false",
        IsSuspended: "false",
        IsDeleted: "false"
      },
      Price: "1100.00",
      Quantity: "1",
      Date: " 2013-02-23T09:35:18+09:00	 ",
      IsHighestBidder: "false",
      IsWinner: "false"
    }, {
      Bidder: "nen*****",
      Rating: {
        Point: "467",
        IsNotRated: "false",
        IsSuspended: "false",
        IsDeleted: "false"
      },
      Price: "1000.00",
      Quantity: "1",
      Date: " 2013-02-23T00:26:34+09:00	 ",
      IsHighestBidder: "false",
      IsWinner: "false"
    }]
  }
})



エラー

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