マイ・オークション表示(落札者一覧)
※2012/11/7以前に取得されたOAuth1.0のConsumer Keyをご利用頂く場合のリクエストURLは
http://auctions.yahooapis.jp/AuctionWebService/V1/myWinnerList となります
ログインしているYahoo! JAPAN IDのマイ・オークションの「落札者一覧」を参照します。
リクエストパラメータ
「RESTリクエストの構築(GET)」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
output | string |
XML、PHPserialize、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/myWinnerList?サンプルリクエスト
GET /AuctionWebService/V1/myWinnerList?Host: auctions.yahooapis.jp
Authorization: Bearer <アクセストークン>
レスポンスフィールド
マイ・オークション表示(落札者一覧)APIのスキーマの記述は、以下になります。
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含み、次の属性を持ちます。
|
/ResultSet/Result | 各個別レスポンスを含みます。 |
/ResultSet/Result/AuctionID | オークションIDです。 |
/ResultSet/Result/Title | 商品のタイトルです。 |
/ResultSet/Result/EndTime | 終了日時です。RFC3339に準拠した表現を用います。(例:2004-04-01T12:00:00+09:00) |
/ResultSet/Result/AuctionItemUrl | 商品詳細のURLです。 |
/ResultSet/Result/Image | 画像(サムネイル) の情報です。 |
/ResultSet/Result/Image/Url | 画像(サムネイル)のURLです。 |
/ResultSet/Result/Image/Width | 画像(サムネイル)の幅です。 |
/ResultSet/Result/Image/Height | 画像(サムネイル)の高さです。 |
/ResultSet/Result/Option | 各オプションの設定状況です。 |
/ResultSet/Result/Option/FeaturedIconUrl | 注目のオークション設定アイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/FreeShippingIconUrl | 「送料無料」のアイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/WrappingIconUrl | 「贈答品」アイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/BuynowIconUrl | 「即決価格あり」アイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/EasyPaymentIconUrl | 「Yahoo!かんたん決済」アイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/GiftIconUrl | 「目立ち」アイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/ItemStatusNewIconUrl | 「新品」アイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/CharityOptionIconUrl | 「チャリティオプション」アイコンのURLです。(10%用と100%用あり) |
/ResultSet/Result/Option/PointIconUrl | 「Tポイント」アイコンのURLです。設定されていない場合は空 |
/ResultSet/Result/Option/IsBold | 太字の設定です。(あり:true なし:false) |
/ResultSet/Result/Option/IsBackGroundColor | 背景色の設定です。(あり:true なし:false) |
/ResultSet/Result/Option/IsCharity | チャリティオプション設定についてです。(あり:true なし:false) |
/ResultSet/Result/HighestBidders | 現在の最高額入札者(複数含め)の情報です。
|
/ResultSet/Result/HighestBidders/Bidder | 1人の最高額入札者に関する情報です。 |
/ResultSet/Result/Highestbidders/Bidder/Id | 落札者のYahoo! JAPAN IDです。 |
/ResultSet/Result/Highestbidders/Bidder/ItemListUrl | 落札者の出品リストを取得するリクエストURLです。(appidは含まれていませんのでご注意ください)。 |
/ResultSet/Result/HighestBidders/Bidder/HighestPrice | 落札価格です。¥記号やカンマは含みません。小数点第二位までの精度です。 |
/ResultSet/Result/Highestbidders/Bidder/Message | 取引関連の情報です。 |
/ResultSet/Result/Highestbidders/Bidder/Message/Title | 投稿タイトルです。 「連絡先、支払い、発送などについて」 「入金を確認しました」 「商品を発送しました」 「送付先住所、支払い、発送などについて」 「支払いが完了しました」 「商品を受け取りました」 「その他」 のいずれかになります。(取引メッセージがなければ空) |
/ResultSet/Result/Highestbidders/Bidder/Message/ContributeIconUrl | 落札者からメッセージが投稿された場合に付く「落札者」アイコンのURLです。 出品者の取引メッセージである、または取引メッセージがなければ空 |
/ResultSet/Result/Highestbidders/Bidder/Message/SendTime | 落札者のメッセージ送信日時です。RFC3339に準拠した表現を用います。(例:2004-04-01T12:00:00+09:00) 取引メッセージがなければ空が返却されます。 |
/ResultSet/Result/Highestbidders/Bidder/IsTradingNaviAuction | 取引ナビ(ベータ版)を利用したオークションの場合はtrueとなります。それ以外の場合はfalseとなります。 |
/ResultSet/Result/Highestbidders/Bidder/TradingNaviMessage | 取引ナビ(ベータ版)の取引メッセージ情報です。取引メッセージがない場合は表示されません。 |
/ResultSet/Result/Highestbidders/Bidder/TradingNaviMessage/SendTime | 取引ナビ(ベータ版)の取引メッセージ投稿時間です。 |
/ResultSet/Result/Highestbidders/Bidder/TradingNaviMessage/Sender | 取引ナビ(ベータ版)の取引メッセージ投稿者です。
|
/ResultSet/Result/Highestbidders/Bidder/Progress | 取引ナビ(ベータ版)の取引進行度です。取引進行度情報がない場合は表示されません。
|
/ResultSet/Result/CharityOption | チャリティオプションに関する情報です。 |
/ResultSet/Result/CharityOption | チャリティオプションの情報です。 |
/ResultSet/Result/CharityOption/Proportion | チャリティオプション寄付率、未設定の場合は0 |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?> <ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:myWinnerList" xsi:schemaLocation="urn:yahoo:jp:auc:myWinnerList http://auctions.yahooapis.jp/AuctionWebService/V1/myWinnerList.xsd" totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1"> <Result> <AuctionID>x125511</AuctionID> <Title>テスト商品です。入札はお控えください4</Title> <EndTime>2013-02-13T15:31:46+09:00</EndTime> <AuctionItemUrl>http://page20.auctions.yahoo.co.jp/jp/auction/y125511</AuctionItemUrl> <Image> <Url>http://i.yimg.jp/images/auct/template/ui/auc_mod/na_200x150.gif</Url> <Width>200</Width> <Height>150</Height> </Image> <CharityOption> <Proportion>0</Proportion> </CharityOption> <Option> <EscrowIconUrl></EscrowIconUrl> <FeaturedIconUrl></FeaturedIconUrl> <FreeShippingIconUrl></FreeShippingIconUrl> <WrappingIconUrl></WrappingIconUrl> <BuynowIconUrl></BuynowIconUrl> <EasyPaymentIconUrl></EasyPaymentIconUrl> <GiftIconUrl></GiftIconUrl> <ItemStatusNewIconUrl></ItemStatusNewIconUrl> <YBankIconUrl></YBankIconUrl> <EnglishIconUrl></EnglishIconUrl> <StarClubIconUrl></StarClubIconUrl> <CharityOptionIconUrl></CharityOptionIconUrl> <PointIconUrl></PointIconUrl> <IsBold>false</IsBold> <IsBackGroundColor>false</IsBackGroundColor> <IsCharity>false</IsCharity> </Option> <HighestBidders totalHighestBidders="1"> <Bidder> <Id>HOGEHOGE</Id> <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=HOGEHOGE</ItemListUrl> <HighestPrice>100 円</HighestPrice> <Message> <Title></Title> <ContributeIconUrl></ContributeIconUrl> <SendTime></SendTime> </Message> </Bidder> </HighestBidders> </Result> </ResultSet>
サンプルレスポンス(PHPserialize)
a: 1: { s: 9: "ResultSet"; a: 4: { s: 21: "totalResultsAvailable"; s: 1: "1"; s: 20: "totalResultsReturned"; s: 1: "1"; s: 19: "firstResultPosition"; s: 1: "1"; s: 6: "Result"; a: 8: { s: 9: "AuctionID"; s: 7: "x125511"; s: 5: "Title"; s: 55: "テスト商品です。入札はお控えください4"; s: 7: "EndTime"; s: 25: "2013-02-13T15:31:46+09:00"; s: 14: "AuctionItemUrl"; s: 53: "http://page20.auctions.yahoo.co.jp/jp/auction/y125511"; s: 5: "Image"; a: 3: { s: 3: "Url"; s: 63: "http://i.yimg.jp/images/auct/template/ui/auc_mod/na_200x150.gif"; s: 5: "Width"; s: 3: "200"; s: 6: "Height"; s: 3: "150"; } s: 13: "CharityOption"; a: 1: { s: 10: "Proportion"; s: 1: "0"; } s: 6: "Option"; a: 16: { s: 13: "EscrowIconUrl"; s: 0: ""; s: 15: "FeaturedIconUrl"; s: 0: ""; s: 19: "FreeShippingIconUrl"; s: 0: ""; s: 15: "WrappingIconUrl"; s: 0: ""; s: 13: "BuynowIconUrl"; s: 0: ""; s: 18: "EasyPaymentIconUrl"; s: 0: ""; s: 11: "GiftIconUrl"; s: 0: ""; s: 20: "ItemStatusNewIconUrl"; s: 0: ""; s: 12: "YBankIconUrl"; s: 0: ""; s: 14: "EnglishIconUrl"; s: 0: ""; s: 15: "StarClubIconUrl"; s: 0: ""; s: 20: "CharityOptionIconUrl"; s: 0: ""; s: 12: "PointIconUrl"; s: 0: ""; s: 6: "IsBold"; b: 0; s: 17: "IsBackGroundColor"; b: 0; s: 9: "IsCharity"; b: 0; } s: 14: "HighestBidders"; a: 2: { s: 6: "Bidder"; a: 4: { s: 2: "Id"; s: 17: "HOGEHOGE"; s: 11: "ItemListUrl"; s: 88: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=HOGEHOGE"; s: 12: "HighestPrice"; s: 7: "100 円"; s: 7: "Message"; a: 3: { s: 5: "Title"; s: 0: ""; s: 17: "ContributeIconUrl"; s: 0: ""; s: 8: "SendTime"; s: 0: ""; } } s: 19: "totalHighestBidders"; s: 1: "1"; } } } }
サンプルレスポンス(JSONP)
loaded({ "ResultSet": { "@attributes": { "totalResultsAvailable": "1", "totalResultsReturned": "1", "firstResultPosition": "1" }, "Result": { "AuctionID": "x125511", "Title": "\u30c6\u30b9\u30c8\u5546\u54c1\u3067\u3059\u3002\u5165\u672d\u306f\u304a\u63a7\u3048\u304f\u3060\u3055\u30444", "EndTime": "2013-02-13T15:31:46+09:00", "AuctionItemUrl": "http:\/\/page20.auctions.yahoo.co.jp\/jp\/auction\/y125511", "Image": { "Url": "http:\/\/i.yimg.jp\/images\/auct\/template\/ui\/auc_mod\/na_200x150.gif", "Width": "200", "Height": "150" }, "CharityOption": { "Proportion": "0" }, "Option": { "EscrowIconUrl": {}, "FeaturedIconUrl": {}, "FreeShippingIconUrl": {}, "WrappingIconUrl": {}, "BuynowIconUrl": {}, "EasyPaymentIconUrl": {}, "GiftIconUrl": {}, "ItemStatusNewIconUrl": {}, "YBankIconUrl": {}, "EnglishIconUrl": {}, "StarClubIconUrl": {}, "CharityOptionIconUrl": {}, "PointIconUrl": {}, "IsBold": "false", "IsBackGroundColor": "false", "IsCharity": "false" }, "HighestBidders": { "@attributes": { "totalHighestBidders": "1" }, "Bidder": { "Id": "HOGEHOGE", "ItemListUrl": "http:\/\/auctions.yahooapis.jp\/AuctionWebService\/V2\/sellingList?sellerID=HOGEHOGE", "HighestPrice": "100 \u5186", "Message": { "Title": {}, "ContributeIconUrl": {}, "SendTime": {} } } } } } })
エラー
マイ・オークション表示(落札者一覧)はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
※このWeb APIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。