ウォッチリストリマインダーの設定

Version 1

リクエストURL

XML

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

ログインしているYahoo! JAPAN IDでウォッチリストリマインダーの設定を行います。

リクエストパラメータ

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

パラメータ	値	説明
auctionID（必須）	string	ウォッチリストリマインダーを設定するオークションIDです。

※上記のパラメータ以外にOAuthのAuthorizationヘッダが必要になります。OAuthのAuthorizationヘッダについては、以下のサイトで詳細をご確認ください。
・OAuthのフロー
・OAuthを用いたAPIリクエスト
※Consumer Keyを取得する際に「マイ・オークション関連の機能」スコープを選択してください。スコープの詳細は、「スコープに関して」でご確認ください。

サンプルリクエストURL

http://auctions.yahooapis.jp/AuctionWebService/V1/reminder?auctionID=＜ウォッチリストリマインダーの設定をするオークションID＞ Authorization: OAuth realm="yahooapis.jp", oauth_consumer_key=<お客様のConsumer Key>, oauth_nonce=<ランダムな文字列>, oauth_signature_method="HMAC-SHA1", oauth_timestamp=<タイムスタンプ値>, oauth_token=<トークン値>, oauth_version="1.0", oauth_signature=<シグネチャの内容>

レスポンスフィールド

ウォッチリストリマインダーの設定Web APIのスキーマの記述は、以下のURLをご覧ください。
http://auctions.yahooapis.jp/AuctionWebService/V1/Reminder.xsd

フィールド	説明
ResultSet	クエリーレスポンスのすべてを含みます。 totalResultsAvailable：該当件数の総個数です。（1固定） totalResultsReturned：返された値の個数です。（1固定） firstResultPosition：最初のデータが何個目に当たるかです。（1固定）
Result	各個別レスポンスを含みます。
MyAuctionUrl	マイ・オークションのウォッチリストページへのリクエストURLです。（OAuthのAuthorizationヘッダは含まれていませんのでご注意ください）

サンプルレスポンス

以下は、auctionID=12346789 のクエリーの結果です。

<?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>

エラー

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

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

利用制限

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