デベロッパーネットワークトップ > オークション > ウォッチリストに追加
オークション

ウォッチリストに追加

本APIは提供を終了いたします。
詳細につきましては、以下をご覧ください。
【再掲】【重要】オークションWeb API提供終了（2018年2月22日）のお知らせ

リクエストURL
XML
https://auctions.yahooapis.jp/AuctionWebService/V1/watchList

ログインしているYahoo! JAPAN IDでウォッチリストに追加します。

リクエストパラメータ

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

パラメータ 値 説明
output string XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
  • xml ：xmlレスポンス(デフォルト)
  • php ：PHPserializeレスポンス
  • json ：JSONPレスポンス
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
auctionID（必須） string ウォッチリストへ追加する対象のオークションIDです。

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
・Yahoo! ID連携
・Yahoo! ID連携によるAPIアクセス実装方法

※アプリケーションIDを取得する際に「マイ・オークション関連の機能」スコープを選択してください。
スコープの詳細は、「スコープに関して」でご確認ください。


サンプルリクエストURL

https://auctions.yahooapis.jp/AuctionWebService/V1/watchList?auctionID=<ウォッチリストに追加するオークションID>

サンプルリクエスト

GET /AuctionWebService/V1/watchList?auctionID=<ウォッチリストに追加するオークションID> HTTP/1.1
Host: auctions.yahooapis.jp
Authorization: Bearer <アクセストークン> 

レスポンスフィールド

ウォッチリストに追加APIのスキーマの記述は、以下になります。

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含みます。

  • totalResultsAvailable：該当件数の総個数です。（1固定）
  • totalResultsReturned：返された値の個数です。（1固定）
  • firstResultPosition：最初のデータが何個目に当たるかです。（1固定）

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/WatchListURL ウォッチリストを参照のリクエストURLです。（OAuthのAuthorizationヘッダは含まれていませんのでご注意ください）


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
    <Result>
        <MyAuctionUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/openWatchList</MyAuctionUrl>
    </Result>
</ResultSet>


エラー

ウォッチリストに追加はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

このWeb APIはOAuth対応のWeb APIに共通のエラーメッセージおよびコードを返します。



利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。（無料）
まずはヘルプページのお問い合わせフォームからご相談ください。