ショッピング

おすすめ情報モジュール

変更履歴(2017年12月25日)

2018年2月28日(水)提供終了予定

リクエストURL
XML
https://shopping.yahooapis.jp/ShoppingWebService/V1/getModule
PHPserialize
https://shopping.yahooapis.jp/ShoppingWebService/V1/php/getModule
JSONP
https://shopping.yahooapis.jp/ShoppingWebService/V1/json/getModule

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

リクエストパラメータ

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

パラメータ 説明
appid
(必須)
string アプリケーションID。詳細はこちらをご覧ください。
affiliate_type vc バリューコマースアフィリエイト(vc)を選択。
例:affiliate_type=vc
affiliate_id string バリューコマースアフィリエイトIDを入力。
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力する。
category_id
(デフォルト1)
integer 取得したいおすすめ情報モジュールがあるカテゴリ階層のカテゴリIDを指定します。
position
(必須)
トップページ(category_id=1)
 ・querykeyword
 ・hotitem

カテゴリページ(category_id=1以外)
 ・basicpromotion
 ・bestpromotion
トップページ(category_id=1)の場合に以下のpositionを指定できます。
 ・querykeyword:検索人気キーワードをピックアップして紹介する情報。(更新頻度高)
 ・hotitem:話題情報の画像とキャッチコピーを掲載しているモジュール情報。(更新頻度中)

カテゴリページの場合に以下のpositionを指定できます。
 ・basicpromotion:画像ありのおすすめ特集や商品のご紹介情報。
 ・bestpromotion:画像なしのおすすめ特集や商品のご紹介情報。

サンプルリクエストURL

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


レスポンスフィールド

おすすめ情報モジュールAPIのスキーマの記述は、以下のURLになります。

フィールド 説明
/ResultSet totalResultsReturned: 返された値の個数
/ResultSet/Result/CategoryId リクエストしたカテゴリID
/ResultSet/Result/Position リクエストしたPosition
/ResultSet/Result/ModuleTitle モジュールのタイトル名
/ResultSet/Result/Hit

  • index:おすすめ情報の順番

/ResultSet/Result/Hit/Title おすすめ情報の見出し文言
/ResultSet/Result/Hit/Url 見出し文言からのリンク先URL/アフィリエイトURL
/ResultSet/Result/Hit/EventTerm/Start 販促イベント開始時期(RFC)
/ResultSet/Result/Hit/EventTerm/End 販促イベント終了時期(RFC)
/ResultSet/Result/Hit/Image/Original Yahoo!ショッピングのおすすめ情報モジュールで使用しているオリジナルサイズの画像
トップページ
 ・promotionbox:770×250
 ・querykeyword:なし
カテゴリページ
 ・basicpromotion:106×106
/ResultSet/Result/Hit/Image/Small 76×76サイズの画像URL(オリジナルサイズの画像以外がない場合は空)
/ResultSet/Result/Hit/Image/Medium 146×146サイズの画像URL(オリジナルサイズの画像以外がない場合は空)
/ResultSet/Result/Hit/SubTitles/SubTitle/Title おすすめ情報の補足文言
/ResultSet/Result/Hit/SubTitles/SubTitle/Url 補足文言からのリンク先URL/アフィリエイトURL



サンプルレスポンス

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

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet xsi:schemaLocation="urn:yahoo:jp:getModule https://shopping.yahooapis.jp/ShoppingWebService/V1/getModule.xsd" xmlns="urn:yahoo:jp:getModule" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" totalResultsReturned="9">
    <Result>
        <CategoryId>1</CategoryId>
        <Position>querykeyword</Position>
        <ModuleTitle>検索人気キーワード</ModuleTitle>
        <Hit index="1">
            <Title>抱き枕</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=%E6%8A%B1%E3%81%8D%E6%9E%95&ei=UTF-8&tab_ex=commerce&oq=&uIv=on&pf=&pt=&X=4&di=&ss_first=1&used=0&seller=0&lcnt=26952&cid=27823&g_cid=1</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="2">
            <Title>柿の種</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=%E6%9F%BF%E3%81%AE%E7%A8%AE&ei=UTF-8&tab_ex=commerce&oq=&uIv=on&cid=2498&pf=&pt=&X=4&di=&ss_first=1&used=0&seller=0&elc=1&lcnt=1559&crumb=LQeMSoRfoIq&view=grid</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="3">
            <Title>米代恭</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=%E7%B1%B3%E4%BB%A3%E6%81%AD&tab_ex=commerce&oq=&uIv=on&cid=&pf=&pt=&di=&used=0&seller=0&ei=UTF-8&lcnt=49&X=4</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="4">
            <Title>ユリ・ゲラー「ムード」</Title>
            <Url>https://shopping.yahoo.co.jp/product/j/4582167075146/compare.html</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="5">
            <Title>新しい人体の教科書</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=%22%E6%96%B0%E3%81%97%E3%81%84%E4%BA%BA%E4%BD%93%E3%81%AE%E6%95%99%E7%A7%91%E6%9B%B8%22&ei=UTF-8&tab_ex=commerce&oq=&uIv=on&cid=&pf=&pt=&di=&view=grid&ss_first=1&used=0&seller=0&lcnt=15&X=4</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="6">
            <Title>つかみもみマッサージャー</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=%E3%81%A4%E3%81%8B%E3%81%BF%E3%82%82%E3%81%BF%E3%83%9E%E3%83%83%E3%82%B5%E3%83%BC%E3%82%B8%E3%83%A3%E3%83%BC&ei=UTF-8&tab_ex=commerce&oq=&uIv=on&cid=1919&pf=&pt=&di=&ss_first=1&used=0&seller=0&elc=1&lcnt=208&X=4</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="7">
            <Title>出西生姜</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=%E5%87%BA%E8%A5%BF%E7%94%9F%E5%A7%9C&ei=UTF-8&tab_ex=commerce&oq=&uIv=on&cid=&pf=&pt=&X=4&di=&ss_first=1&used=0&seller=0&lcnt=28&crumb=LQeMSoRfoIq&view=grid</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="8">
            <Title>水平開きノート</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=%E6%B0%B4%E5%B9%B3%E9%96%8B%E3%81%8D%E3%83%8E%E3%83%BC%E3%83%88&ei=UTF-8&tab_ex=commerce&oq=&uIv=on&cid=&pf=&pt=&di=&ss_first=1&used=0&seller=0&lcnt=101&X=4</Url>
            <EventTerm>
                <Start>2017-11-15T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
        <Hit index="9">
            <Title>インクのいらないペン</Title>
            <Url>https://shopping.yahoo.co.jp/search?p=forever+pininfarina+cambiano&ei=UTF-8&tab_ex=commerce&oq=&uIv=on&cid=&pf=&pt=&di=&view=list&used=0&seller=0&lcnt=9&X=4</Url>
            <EventTerm>
                <Start>2017-11-13T00:00:00+09:00</Start>
                <End/>
            </EventTerm>
            <Image>
                <Original/>
                <Small/>
                <Medium/>
            </Image>
            <SubTitles>
                <SubTitle>
                    <Title/>
                    <Url/>
                </SubTitle>
            </SubTitles>
        </Hit>
    </Result>
</ResultSet>



エラー

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




利用制限

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