ショッピング

おすすめ情報モジュール

Version 1

リクエストURL

XML

http://shopping.yahooapis.jp/ShoppingWebService/V1/getModule

PHPserialize

http://shopping.yahooapis.jp/ShoppingWebService/V1/php/getModule

JSONP

http://shopping.yahooapis.jp/ShoppingWebService/V1/json/getModule

Yahoo!ショッピングで提供する最新のおすすめ情報を、モジュール単位で取得できるAPIです。おすすめ情報は季節やトレンドにあわせて更新されます。

リクエストパラメータ

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

パラメータ	値	説明
appid （必須）	string	アプリケーションID。詳細はこちらをご覧ください。
affiliate_type	yid/vc	Yahoo! JAPANアフィリエイト（yid）とバリューコマースアフィリエイト(vc)の選択。例：affiliate_type=yid
affiliate_id	string	Yahoo! JAPANアフィリエイトIDもしくは、バリューコマースアフィリエイトIDを入力。
callback	string	JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力する。
category_id （デフォルト1）	integer	取得したいおすすめ情報モジュールがあるカテゴリ階層のカテゴリIDを指定します。
position (必須）	eventrecommend hotitem querybox itembox special pickup	eventrecommend /hotitem/querybox/itembox/special/pickupのいずれかを指定します。 eventrecommend：開催中の販促イベント情報や話題の商品情報へのリンクを掲載しているモジュール情報。（更新頻度高） hotitem：話題商品の情報を掲載しているモジュール情報。（更新頻度高　Yahoo!ショッピングトップページにのみ存在するモジュールです） querybox：話題のキーワードと代表画像を掲載しているモジュール情報。（更新頻度高） itembox：特定のテーマに沿って商品を紹介するモジュール情報。（更新頻度中） special：不定期なイベント情報等を紹介するモジュール情報。（更新頻度低） pickup：Yahoo!ショッピングのスタッフが選んだ商品のモジュール情報（更新頻度中　Yahoo!ショッピングカテゴリページにのみ存在するモジュールです） ※Yahoo!ショッピングで現在掲載中のモジュールの情報を取得していただけます。positionで指定したモジュールが存在しない場合、デフォルトでトップページのeventrecommendの値を返します。

サンプルリクエストURL

http://shopping.yahooapis.jp/ShoppingWebService/V1/getModule?appid=<あなたのアプリケーションID>&position=hotitem

レスポンスフィールド

おすすめ情報モジュールWeb APIのスキーマの記述は、以下のURLをご覧ください。
http://shopping.yahooapis.jp/ShoppingWebService/V1/getModule.xsd

フィールド	説明
ResultSet	totalResultsReturned: 返された値の個数
CategoryId	リクエストしたカテゴリID
Position	リクエストしたPosition
ModuleTitle	モジュールのタイトル名
Hit	index:おすすめ情報の順番
Title	おすすめ情報の見出し文言
Url	見出し文言からのリンク先URL/アフィリエイトURL
EventStart	販促イベント開始時期（RFC）
EventEnd	販促イベント終了時期（RFC）
Original	Yahoo!ショッピングのおすすめ情報モジュールで使用しているオリジナルサイズの画像 eventrecommend：56×56（トップページ）、76×76 hotitem：56×56 querybox：76×76 itembox：76×76 special：76×76 pickup：106×106
Small	76×76サイズの画像URL（オリジナルサイズの画像以外がない場合は空）
Medium	146×146サイズの画像URL（オリジナルサイズの画像以外がない場合は空）
SubTitle	おすすめ情報の補足文言
Url	補足文言からのリンク先URL/アフィリエイトURL

サンプルレスポンス

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

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet xsi:schemaLocation="urn:yahoo:jp:getModule http://shopping.yahooapis.jp/ShoppingWebService/V1/getModule.xsd" xmlns="urn:yahoo:jp:getModule" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" totalResultsReturned="12">
   <Result>
      <CategoryId>1</CategoryId>
      <Position>eventrecommend</Position>
      <ModuleTitle>Yahoo!ショッピングのおすすめ</ModuleTitle>
      <Hit index="1">
         <Title>皆様ありがとう！　9周年</Title>

         <Url>http://contents.shopping.yahoo.co.jp/event/anniversary/</Url>
         <EventTerm>
            <Start>2008-09-05T23:50:00+09:00</Start>
            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00048_anniversary01.jpg</Original>

            <Small />
            <Medium />
         </Image>
         <SubTitles>
            <SubTitle>
               <Title>お得企画を連発しちゃうぞ</Title>
               <Url />
            </SubTitle>

         </SubTitles>
      </Hit>
      <Hit index="2">
         <Title>9月15日は敬老の日</Title>
         <Url>http://contents.shopping.yahoo.co.jp/event/keirou/</Url>
         <EventTerm>
            <Start>2008-08-19T13:00:00+09:00</Start>

            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00050_keirou.jpg</Original>
            <Small />
            <Medium />
         </Image>
         <SubTitles>

            <SubTitle>
               <Title>まだ間に合う、急いで！</Title>
               <Url />
            </SubTitle>
         </SubTitles>
      </Hit>
      <Hit index="3">
         <Title>デキるOLファッション</Title>

         <Url>http://contents.shopping.yahoo.co.jp/fair/fashion/autumn_women_s_collection_2/</Url>
         <EventTerm>
            <Start>2008-09-10T10:28:00+09:00</Start>
            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00061_ol56.gif</Original>

            <Small />
            <Medium />
         </Image>
         <SubTitles>
            <SubTitle>
               <Title>仕事もデートもばっちり！</Title>
               <Url />
            </SubTitle>

         </SubTitles>
      </Hit>
      <Hit index="4">
         <Title>カジュアル時計＆アクセ</Title>
         <Url>http://contents.shopping.yahoo.co.jp/fair/fashion/casual_item/</Url>
         <EventTerm>
            <Start>2008-09-02T10:35:00+09:00</Start>

            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00052_casual56.gif</Original>
            <Small />
            <Medium />
         </Image>
         <SubTitles>

            <SubTitle>
               <Title>気分もスタイリングも新鮮</Title>
               <Url />
            </SubTitle>
         </SubTitles>
      </Hit>
      <Hit index="5">
         <Title>作って集めて、楽しもう！</Title>

         <Url>http://contents.shopping.yahoo.co.jp/fair/instrument_hobby_learning/autumn_art/</Url>
         <EventTerm>
            <Start>2008-09-09T10:36:00+09:00</Start>
            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00059_art56.gif</Original>

            <Small />
            <Medium />

         </Image>
         <SubTitles>
            <SubTitle>
               <Title>フィギュア、絵画ほか</Title>
               <Url />
            </SubTitle>

         </SubTitles>
      </Hit>
      <Hit index="6">
         <Title>新作メンズボトムス＆小物</Title>
         <Url>http://contents.shopping.yahoo.co.jp/fair/fashion/autumn_men_s_collection_2/</Url>
         <EventTerm>
            <Start>2008-09-10T10:33:00+09:00</Start>

            <End />
         </EventTerm>
         <Image>
            <Original>http://images.shopping.yahoo.co.jp/img/promotion/scl/theme/56/00058_mens-bottoms56.gif</Original>
            <Small />
            <Medium />
         </Image>
         <SubTitles>

            <SubTitle>
               <Title>デニムやカーゴが勢ぞろい</Title>
               <Url />
            </SubTitle>
         </SubTitles>
      </Hit>
      <Hit index="7">
         <Title>話題のダイエットグッズ</Title>

         <Url>http://contents.shopping.yahoo.co.jp/fair/diet_and_health/diet_10/</Url>
         <EventTerm>
            <Start>2008-09-08T10:52:00+09:00</Start>
            <End />
         </EventTerm>
         <Image>
            <Original />
            <Small />

            <Medium />
         </Image>
         <SubTitles>
            <SubTitle>
               <Title />
               <Url />
            </SubTitle>
         </SubTitles>
      </Hit>

      <Hit index="8">
         <Title>大粒ブドウを味わおう</Title>
         <Url>http://shopping.yahoo.co.jp/category/1045/?uIv=on&view=grid</Url>
         <EventTerm>
            <Start>2008-09-09T10:58:00+09:00</Start>
            <End />
         </EventTerm>

         <Image>
            <Original />
            <Small />
            <Medium />
         </Image>
         <SubTitles>
            <SubTitle>
               <Title />
               <Url />

            </SubTitle>
         </SubTitles>
      </Hit>
      <Hit index="9">
         <Title>島の味、石垣島ラー油</Title>
         <Url>http://shopping.yahoo.co.jp/search?p=%C0%D0%B3%C0%C5%E7%A5%E9%A1%BC%CC%FD&view=grid&cid=2498&b=0&uIv=on&x=30&y=12</Url>

         <EventTerm>
            <Start>2008-09-11T17:56:00+09:00</Start>
            <End />
         </EventTerm>
         <Image>
            <Original />
            <Small />
            <Medium />

         </Image>
         <SubTitles>
            <SubTitle>
               <Title />
               <Url />
            </SubTitle>
         </SubTitles>
      </Hit>
      <Hit index="10">

         <Title>秋インテリアに模様替え</Title>
         <Url>http://contents.shopping.yahoo.co.jp/theme/home_and_interior/mystyle_interior/pickup/09/index.html</Url>
         <EventTerm>
            <Start>2008-09-05T12:35:00+09:00</Start>
            <End />
         </EventTerm>
         <Image>

            <Original />
            <Small />
            <Medium />
         </Image>
         <SubTitles>
            <SubTitle>
               <Title />
               <Url />
            </SubTitle>

         </SubTitles>
      </Hit>
      <Hit index="11">
         <Title>誕生日にお花を贈ろう</Title>
         <Url>http://contents.shopping.yahoo.co.jp/theme/home_and_interior/flower_gift/</Url>
         <EventTerm>
            <Start>2008-08-25T12:41:00+09:00</Start>

            <End />
         </EventTerm>
         <Image>
            <Original />
            <Small />
            <Medium />
         </Image>
         <SubTitles>
            <SubTitle>

               <Title />
               <Url />
            </SubTitle>
         </SubTitles>
      </Hit>
      <Hit index="12">
         <Title>収納雑貨で出っ放し卒業</Title>
         <Url>http://shopping.yahoo.co.jp/category/3664/recommend</Url>

         <EventTerm>
            <Start>2008-09-08T10:52:00+09:00</Start>
            <End />
         </EventTerm>
         <Image>
            <Original />
            <Small />
            <Medium />

         </Image>
         <SubTitles>
            <SubTitle>
               <Title />
               <Url />
            </SubTitle>
         </SubTitles>
      </Hit>
   </Result></ResultSet>

エラー

おすすめ情報モジュールWeb APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用制限

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

おすすめ情報モジュール

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

エラー

利用制限

おすすめ情報モジュールを使用した開発に関するQ＆A

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

Web APIとその他のサービス

API

その他

関連ドキュメント

開発者ブログ

開発者コミュニティ

開発のヒント

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