【重要】販促イベント検索終了のお知らせ(2016/3/31)
2016年03月31日に提供を終了しました。

販促イベント検索

Yahoo!ショッピング内で公開している販促イベント情報を検索するAPIです。季節販促、ポイントキャンペーン等の販促イベント情報をリアルタイムで取得できます。

リクエストURL

XML
http://shopping.yahooapis.jp/ShoppingWebService/V1/eventSearch
PHPserialize
http://shopping.yahooapis.jp/ShoppingWebService/V1/php/eventSearch
JSONP
http://shopping.yahooapis.jp/ShoppingWebService/V1/json/eventSearch

リクエストパラメータ

「Web APIの使い方#GETとは」をご参照ください。

パラメータ 値 説明
appid
（必須）		 string Client ID（アプリケーションID）。詳細はこちらをご覧ください。
affiliate_type vc バリューコマースアフィリエイト（vc）を選択
例：affiliate_type=vc
affiliate_id string バリューコマースアフィリエイトIDを入力
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力
event_type all/point/season/special/store 取得したい販促情報の種類を指定します。
デフォルトはall（全販促イベント）、point（ポイントキャンペーン）、season（季節販促イベント）、special（特集）、store（ストアのおすすめ販促イベント）
event_id integer 結果リストに含まれるイベントIDによる絞り込み検索
sort score/date 販促イベント情報の並べ替え
score（おすすめ順）、date（新着順）
hits integer
（デフォルト：5） 		取得する検索結果数。デフォルトは5、最大値は20
offset integer 何件目から表示させるか（1件目は0）の設定

サンプルリクエストURL

http://shopping.yahooapis.jp/ShoppingWebService/V1/eventSearch?appid=<あなたのClient ID（アプリケーションID）>&event_type=all

レスポンスフィールド

販促イベント検索APIのスキーマの記述は、以下になります。

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

  • totalResultsAvailable: 検索数HIT数
  • totalResultsReturned: 返された値の個数
  • firstResultPosition: 最初のデータが何個目にあたるか（最初＝1）
/ResultSet/Result/EventType リクエストしたevent_type
/ResultSet/Result/Hit

  • index: おすすめ情報の順番おすすめ情報の順番
/ResultSet/Result/Hit/EventCode イベントコード
/ResultSet/Result/Hit/EventTitle 販促イベント名
/ResultSet/Result/Hit/EventType 販促イベント情報の種類
/ResultSet/Result/Hit/Url 販促イベント情報ページへのURLまたはアフィリエイトURL
/ResultSet/Result/Hit/EventTerm/Start 販促イベント開始時期（RFC）
/ResultSet/Result/Hit/EventTerm/End 販促イベント終了時期（RFC）
/ResultSet/Result/Hit/Image/Original 販促イベント情報で使用しているオリジナルサイズの画像
/ResultSet/Result/Hit/Image/ExtraSmall 画像極小　56×56サイズの画像（オリジナルサイズの画像以外がない場合は空）
/ResultSet/Result/Hit/Image/Small 画像小　76×76サイズの画像URL（オリジナルサイズの画像以外がない場合は空）
/ResultSet/Result/Hit/Image/Medium 画像中　146×146サイズの画像URL（オリジナルサイズの画像以外がない場合は空）
/ResultSet/Result/Hit/Children/Child/EventCode 関連販促イベントコード
/ResultSet/Result/Hit/Children/Child/EventTitle 関連販促イベント名
/ResultSet/Result/Hit/Children/Child/Url 補足文言からのリンク先URLまたはアフィリエイトURL
/ResultSet/Result/Hit/Children/Child/EventTerm/Start 関連販促イベント開始時期（RFC）
/ResultSet/Result/Hit/Children/Child/EventTerm/End 関連販促イベント終了時期（RFC）
/ResultSet/Result/Hit/Description 販促イベント情報詳細
/ResultSet/Result/Hit/EventIdPath/Event/Id 現在の販促イベントコードまでのパス

サンプルレスポンス

以下は、allを指定しリクエストした場合のレスポンスです。

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet xsi:schemaLocation="urn:yahoo:jp:eventSearch http://shopping.yahooapis.jp/ShoppingWebService/V1/eventSearch.xsd" xmlns="urn:yahoo:jp:eventSearch" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" totalResultsAvailable="70" totalResultsReturned="5" firstResultPosition="1">
<Result>
 <EventType>All</EventType>
 <Hit index="1">
   <EventCode>1357</EventCode>
   <EventTitle>暑い夏に備えてパワーチャージ！　スタミナグルメ特集</EventTitle>
   <EventType>Store</EventType>
   <Url>http://sales.shopping.yahoo.co.jp/fair/food/recommend_item_2/</Url>
   <EventTerm>
     <Start>2012-07-03T12:00:00+09:00</Start>
     <End>2012-07-17T12:00:59+09:00</End>
   </EventTerm>
   <Image>
     <Original>http://i.yimg.jp/images/shp_edit/promotion/scl/food/56/00413_stamina56-1.jpg</Original>
     <ExtraSmall>http://i.yimg.jp/images/shp_edit/promotion/scl/food/56/00413_stamina56-1.jpg</ExtraSmall>
     <Small>http://i.yimg.jp/images/shp_edit/promotion/scl/food/76/01867_stamina76.jpg</Small>
     <Medium/>
   </Image>
   <Children></Children>
   <Description>暑い夏に備えてパワーチャージ！　スタミナグルメ特集</Description>
   <EventIdPath>
     <Event>
       <Id/>
     </Event>
   </EventIdPath>
 </Hit>
 <Hit index="2">
   <EventCode>1455</EventCode>
   <EventTitle>おうちでほっこりおいしさ堪能　お取り寄せグルメ＆スイーツセール！</EventTitle>
   <EventType>Store</EventType>
   <Url>http://sales.shopping.yahoo.co.jp/fair/food/redtagsale_1/</Url>
   <EventTerm>
     <Start>2012-12-18T12:00:00+09:00</Start>
     <End>2012-12-24T12:00:59+09:00</End>
   </EventTerm>
   <Image>
     <Original>http://i.yimg.jp/images/shp_edit/promotion/scl/food/56/00426_otoriyose56.jpg</Original>
     <ExtraSmall>http://i.yimg.jp/images/shp_edit/promotion/scl/food/56/00426_otoriyose56.jpg</ExtraSmall>
     <Small>http://i.yimg.jp/images/shp_edit/promotion/scl/food/76/01882_otoriyose76.jpg</Small>
     <Medium/>
   </Image>
   <Children></Children>
   <Description>おうちでほっこりおいしさ堪能　お取り寄せグルメ＆スイーツセール！</Description>
   <EventIdPath>
     <Event>
       <Id>1455</Id>
     </Event>
   </EventIdPath>
 </Hit>
 <Hit index="3">
   <EventCode>1347</EventCode>
   <EventTitle>夏に差がつく！　モテる男のTシャツ・ポロシャツ</EventTitle>
   <EventType>Store</EventType>
   <Url>http://sales.shopping.yahoo.co.jp/fair/fashion/summer_item_4/</Url>
   <EventTerm>
     <Start>2012-06-20T12:00:00+09:00</Start>
     <End>2012-07-04T12:00:59+09:00</End>
   </EventTerm>
   <Image>
     <Original>http://i.yimg.jp/images/shp_edit/promotion/scl/mens/56/0050_tshirtpolo56-1.jpg</Original>
     <ExtraSmall>http://i.yimg.jp/images/shp_edit/promotion/scl/mens/56/0050_tshirtpolo56-1.jpg</ExtraSmall>
     <Small>http://i.yimg.jp/images/shp_edit/promotion/scl/mens/76/0989_tshirtpolo76-1.jpg</Small>
     <Medium/>
   </Image>
   <Children>
     <Child>
       <EventCode>1349</EventCode>
       <EventTitle>夏に差がつく！　モテる男のTシャツ・ポロシャツ　ポロシャツ</EventTitle>
       <Url>http://sales.shopping.yahoo.co.jp/fair/fashion/summer_item_4/02/</Url>
       <EventTerm>
         <Start>2012-06-20T12:00:00+09:00</Start>
         <End>2012-07-04T12:00:59+09:00</End>
       </EventTerm>
     </Child>
     <Child>
       <EventCode>1348</EventCode>
       <EventTitle>夏に差がつく！　モテる男のTシャツ・ポロシャツ　Tシャツ</EventTitle>
       <Url>http://sales.shopping.yahoo.co.jp/fair/fashion/summer_item_4/01/</Url>
       <EventTerm>
         <Start>2012-06-20T12:00:00+09:00</Start>
         <End>2012-07-04T12:00:59+09:00</End>
       </EventTerm>
     </Child>
   </Children>
   <Description>夏に差がつく！　モテる男のTシャツ・ポロシャツ</Description>
   <EventIdPath>
     <Event>
       <Id/>
     </Event>
   </EventIdPath>
 </Hit>
 <Hit index="4">
   <EventCode>1364</EventCode>
   <EventTitle>紫外線や冷房の乾燥に負けない、憧れボディを目指して！　コスメ、ダイエットセール</EventTitle>
   <EventType>Store</EventType>
   <Url>http://sales.shopping.yahoo.co.jp/fair/diet_and_health/diet_08/</Url>
   <EventTerm>
     <Start>2012-08-07T12:00:00+09:00</Start>
     <End>2012-08-28T12:00:59+09:00</End>
   </EventTerm>
   <Image>
     <Original>http://i.yimg.jp/images/shp_edit/promotion/scl/diet/56/00032_cosmedietsale56-1.jpg</Original>
     <ExtraSmall>http://i.yimg.jp/images/shp_edit/promotion/scl/diet/56/00032_cosmedietsale56-1.jpg</ExtraSmall>
     <Small>http://i.yimg.jp/images/shp_edit/promotion/scl/diet/76/00034_cosmedietsale76-1.jpg</Small>
     <Medium/>
   </Image>
   <Children></Children>
   <Description>紫外線や冷房の乾燥に負けない、憧れボディを目指して！　コスメ、ダイエットセール</Description>
   <EventIdPath>
     <Event>
       <Id/>
     </Event>
   </EventIdPath>
 </Hit>
 <Hit index="5">
   <EventCode>927</EventCode>
   <EventTitle>プロの太鼓判！　冬のモテファッション図鑑　2009</EventTitle>
   <EventType>Store</EventType>
   <Url>http://contents.shopping.yahoo.co.jp/fair/fashion/mens_winter_wear_3</Url>
   <EventTerm>
     <Start>2009-12-08T12:00:00+09:00</Start>
     <End>2009-12-22T12:00:59+09:00</End>
   </EventTerm>
   <Image>
     <Original>http://i.yimg.jp/images/shp_edit/promotion/scl/mens/56/0006fuyumote56.jpg</Original>
     <ExtraSmall>http://i.yimg.jp/images/shp_edit/promotion/scl/mens/56/0006fuyumote56.jpg</ExtraSmall>
     <Small>http://i.yimg.jp/images/shp_edit/promotion/scl/mens/76/0550fuyumote76.jpg</Small>
     <Medium/>
   </Image>
   <Children>
     <Child>
       <EventCode>929</EventCode>
       <EventTitle>プロの太鼓判！　冬のモテファッション図鑑　2009　ボトムス</EventTitle>
       <Url>http://contents.shopping.yahoo.co.jp/fair/fashion/mens_winter_wear_3/inner</Url>
       <EventTerm>
         <Start>2009-12-08T12:00:00+09:00</Start>
         <End>2009-12-22T12:00:59+09:00</End>
       </EventTerm>
     </Child>
     <Child>
       <EventCode>928</EventCode>
       <EventTitle>プロの太鼓判！　冬のモテファッション図鑑　2009　トップス</EventTitle>
       <Url>http://contents.shopping.yahoo.co.jp/fair/fashion/mens_winter_wear_3/outer</Url>
       <EventTerm>
         <Start>2009-12-08T12:00:00+09:00</Start>
         <End>2009-12-22T12:00:59+09:00</End>
       </EventTerm>
     </Child>
   </Children>
   <Description>プロの太鼓判！　冬のモテファッション図鑑　2009</Description>
   <EventIdPath>
     <Event>
       <Id/>
     </Event>
   </EventIdPath>
 </Hit>
</Result>
</ResultSet>

エラー

販促イベント検索はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

このAPIに関する利用約款はこちら。

アプリケーションの管理

目次

利用のルール

開発のヒント