ショッピング

販促イベント検索

Version 1

リクエスト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

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

リクエストパラメータ

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

パラメータ	値	説明
appid （必須）	string	アプリケーションID。詳細はこちらをご覧ください。
affiliate_type	yid/vc	yid（Yahoo! JAPANアフィリエイト）とvc（バリューコマースアフィリエイト）の選択 f 例：affiliate_type=yid
affiliate_id	string	Yahoo! JAPANアフィリエイトIDもしくは、バリューコマースアフィリエイト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=<あなたのアプリケーションID>&event_type=all

レスポンスフィールド

販促イベント検索Web APIのスキーマの記述は、以下のURLをご覧ください。
http://shopping.yahooapis.jp/ShoppingWebService/V1/eventSearch.xsd

フィールド	説明
ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable: 検索数HIT数 totalResultsReturned: 返された値の個数 firstResultPosition: 最初のデータが何個目にあたるか（最初＝1）
EventType	リクエストしたevent_type
Hit	index: おすすめ情報の順番おすすめ情報の順番
Code	イベントID
EventTitle	販促イベント名
EventType	販促イベント情報の種類
Id	販促イベント情報に関連するカテゴリIDリスト
Url	販促イベント情報ページへのURLまたはアフィリエイトURL
EventStart	販促イベント開始時期（RFC）
EventEnd	販促イベント終了時期（RFC）
Original	販促イベント情報で使用しているオリジナルサイズの画像
ExtraSmall	画像極小　56×56サイズの画像（オリジナルサイズの画像以外がない場合は空）
Small	画像小　76×76サイズの画像URL（オリジナルサイズの画像以外がない場合は空）
Medium	画像中　146×146サイズの画像URL（オリジナルサイズの画像以外がない場合は空）
EventTitle	関連販促イベント名
Url	補足文言からのリンク先URLまたはアフィリエイトURL
EventStart	関連販促イベント開始時期（RFC）
EventEnd	関連販促イベント終了時期（RFC）
Description	販促イベント情報詳細
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="15" totalResultsReturned="5" firstResultPosition="1">
   <Result>
      <EventType>All</EventType>
      <Hit index="1">
         <EventCode>85</EventCode>
         <EventTitle>ブランドアウトレット PREMIUM BRAND Avenue OUTLET</EventTitle>
         <EventType>Special</EventType>
         <Url>http://contents.shopping.yahoo.co.jp/theme/fashion/brand_outlet/</Url>
         <EventTerm>
            <Start />
            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/fashion/76/00037_outlet.jpg</Original>
            <ExtraSmall />
            <Small>http://images.shopping.yahoo.co.jp/img/promotion/scl/fashion/76/00037_outlet.jpg</Small>
            <Medium />
         </Image>
         <Children>
         </Children>
         <Description />
         <EventIdPath>
            <Event>
               <Id>85</Id>
            </Event>
         </EventIdPath>
      </Hit>
      <Hit index="2">
         <EventCode>1</EventCode>
         <EventTitle>うまいもの王者決定戦</EventTitle>
         <EventType>Special</EventType>
         <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/</Url>
         <EventTerm>
            <Start>2008-09-11T12:00:00+09:00</Start>
            <End>2008-10-16T23:59:00+09:00</End>
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00001_umaimono7.jpg</Original>
            <ExtraSmall>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00001_umaimono7.jpg</ExtraSmall>
            <Small>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/76/00001_umaimono7.gif</Small>
            <Medium />
         </Image>
         <Children>
            <Child>
               <EventCode>16</EventCode>
               <EventTitle>食べたいものに投票しよう</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/18/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T11:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>11</EventCode>
               <EventTitle>ソフトドリンク部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/10/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>15</EventCode>
               <EventTitle>受賞記念セール</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/17/</Url>
               <EventTerm>
                  <Start>2008-10-10T12:00:00+09:00</Start>
                  <End>2008-10-16T11:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>2</EventCode>
               <EventTitle>スイーツ部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/01/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>14</EventCode>
               <EventTitle>ポイント10倍ストア大集合！</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/16/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-09-16T11:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>8</EventCode>
               <EventTitle>日本酒部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/07/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>5</EventCode>
               <EventTitle>お惣菜部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/04/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>7</EventCode>
               <EventTitle>ワイン部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/06/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>10</EventCode>
               <EventTitle>フルーツ、野菜部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/09/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>12</EventCode>
               <EventTitle>パン部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/11/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>13</EventCode>
               <EventTitle>新人賞</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/12/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>6</EventCode>
               <EventTitle>焼酎部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/05/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>3</EventCode>
               <EventTitle>魚介部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/02/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>9</EventCode>
               <EventTitle>ビール、発泡酒部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/08/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
            <Child>
               <EventCode>4</EventCode>
               <EventTitle>お肉部門</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/event/food_and_drink/umaimono/03/</Url>
               <EventTerm>
                  <Start>2008-09-11T12:00:00+09:00</Start>
                  <End>2008-10-16T23:59:00+09:00</End>
               </EventTerm>
            </Child>
         </Children>
         <Description />
         <EventIdPath>
            <Event>
               <Id>1</Id>
            </Event>
         </EventIdPath>
      </Hit>
      <Hit index="3">
         <EventCode>84</EventCode>
         <EventTitle>Ecoでショッピング</EventTitle>
         <EventType>Special</EventType>
         <Url>http://contents.shopping.yahoo.co.jp/event/eco/</Url>
         <EventTerm>
            <Start />
            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00001_eco.gif</Original>
            <ExtraSmall>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00001_eco.gif</ExtraSmall>
            <Small />
            <Medium />
         </Image>
         <Children>
         </Children>
         <Description />
         <EventIdPath>
            <Event>
               <Id>84</Id>
            </Event>
         </EventIdPath>
      </Hit>
      <Hit index="4">
         <EventCode>73</EventCode>
         <EventTitle>バースデープレゼント〜誕生日プレゼント〜</EventTitle>
         <EventType>Special</EventType>
         <Url>http://contents.shopping.yahoo.co.jp/theme/home_and_interior/flower_gift/</Url>
         <EventTerm>
            <Start />
            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/flower/76/00037_b_present_f.gif</Original>
            <ExtraSmall />
            <Small>http://images.shopping.yahoo.co.jp/img/promotion/scl/flower/76/00037_b_present_f.gif</Small>
            <Medium />
         </Image>
         <Children>
            <Child>
               <EventCode>75</EventCode>
               <EventTitle>バックナンバー</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/theme/home_and_interior/flower_gift/style/backnumber/index.html</Url>
               <EventTerm>
                  <Start />
                  <End />
               </EventTerm>
            </Child>
         </Children>
         <Description />
         <EventIdPath>
            <Event>
               <Id>73</Id>
            </Event>
         </EventIdPath>
      </Hit>
      <Hit index="5">
         <EventCode>66</EventCode>
         <EventTitle>テレビで見たものキャッチ！グルメ、美容健康</EventTitle>
         <EventType>Special</EventType>
         <Url>http://contents.shopping.yahoo.co.jp/theme/tv/index.html</Url>
         <EventTerm>
            <Start />
            <End />
         </EventTerm>
         <Image>
         </Image>
         <Children>
            <Child>
               <EventCode>67</EventCode>
               <EventTitle>テレビで見たものキャッチ！書籍、CD、DVD</EventTitle>
               <Url>http://contents.shopping.yahoo.co.jp/theme/tv/books_and_dvd.html</Url>
               <EventTerm>
                  <Start />
                  <End />
               </EventTerm>
            </Child>
         </Children>
         <Description />
         <EventIdPath>
            <Event>
               <Id>66</Id>
            </Event>
         </EventIdPath>
      </Hit>
   </Result>
</ResultSet>

エラー

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

利用制限

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

販促イベント検索

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

エラー

利用制限

販促イベント検索を使用した開発に関するQ＆A

お役立ち度の高い解決済みの質問

Web APIとその他のサービス

API

その他

関連ドキュメント

開発者ブログ

開発者コミュニティ

開発のヒント

法人デベロッパー専用お問い合わせ