ショッピング
ポイントキャンペーン情報取得
変更履歴(2020年09月24日)
ポイント種別(/Results/Result/Rules/Rule/Ratios/Ratio)の説明を更新しました。
※関連する告知についてはこちらをご確認ください。
リクエストURL
XML
https://shopping.yahooapis.jp/ShoppingWebService/V1/shopCampaignSearch
PHPserialize
https://shopping.yahooapis.jp/ShoppingWebService/V1/php/shopCampaignSearch
JSONP
https://shopping.yahooapis.jp/ShoppingWebService/V1/json/shopCampaignSearch
Yahoo!ショッピング内で公開しているポイントキャンペーン情報を検索するAPIです。ショッピングでお買い物するともらえるお得なポイント情報をリアルタイムで取得できます。
リクエストパラメータ
「RESTリクエストの構築(GET)」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
appid (必須) |
string | アプリケーションID。詳細はこちらをご覧ください。 |
affiliate_type | vc | バリューコマースアフィリエイト(vc)を選択 例:affiliate_type=vc |
affiliate_id | string | バリューコマースアフィリエイトIDを入力 |
callback | string | JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力 |
サンプルリクエストURL
https://shopping.yahooapis.jp/ShoppingWebService/V1/shopCampaignSearch?レスポンスフィールド
ポイントキャンペーン情報取得APIのスキーマの記述は、以下になります。
フィールド | 説明 |
---|---|
/Results/Result/Title | キャンペーンタイトル |
/Results/Result/Id | キャンペーンID |
/Results/Result/EventType |
キャンペーンの種類
|
/Results/Result/CampaignStartTime | キャンペーン開始日時 (YYYY-MM-DD HH:mm:ssの形式) |
/Results/Result/CampaignEndTime | キャンペーン終了日時 (YYYY-MM-DD HH:mm:ssの形式) |
/Results/Result/EntryStartTime | エントリー開始日時(YYYY-MM-DD HH:mm:ssの形式) |
/Results/Result/EntryEndTime | エントリー終了日時(YYYY-MM-DD HH:mm:ssの形式) |
/Results/Result/IsAutoEntry | エントリーが必要なポイントキャンペーンかどうか
|
/Results/Result/Images | キャンペーン画像の情報 |
/Results/Result/Images/Image/Width | キャンペーン画像の幅 |
/Results/Result/Images/Image/Height | キャンペーン画像の高さ |
/Results/Result/Images/Image/Url | キャンペーン画像のURL |
/Results/Result/Contents | キャンペーンの詳細情報 |
/Results/Result/Contents/Content/Description | キャンペーンの説明文 |
/Results/Result/Contents/Content/Url | キャンペーンページのURL |
/Results/Result/Contents/Content/ArchivedUrl | キャンペーンが終了した際の遷移先URL |
/Results/Result/Rules | ポイントキャンペーンの倍率情報 |
/Results/Result/Rules/Rule/Target |
ポイントキャンペーンの対象者
|
/Results/Result/Rules/Rule/Ratios | ポイント倍率の情報 |
/Results/Result/Rules/Rule/Ratios/Ratio |
ポイント種別 targetと同じ値が入る ※Target=Stamp時に、スタンプラリーランク毎の倍率が配列で返却される仕様は削除しました。 |
/Results/Result/Rules/Rule/Ratios/Ratio/Num | ポイント倍率数 |
/Results/Result/MaxRatio | キャンペーンで獲得可能な最大の倍率 |
サンプルレスポンス
以下は、allを指定しリクエストした場合のレスポンスです。
<Results> <Result index="1"> <Title>5のつく日キャンペーン</Title> <Id>1087</Id> <EventType>point</EventType> <IsDisplay>1</IsDisplay> <IsCondition>1</IsCondition> <Sentence>エントリーしてお買い物をすると+3倍。さらにスマートフォン・タブレット端末からのお買い物で+1倍。</Sentence> <CampaignStartTime>2016-03-15 00:00:00</CampaignStartTime> <CampaignEndTime>2016-03-15 23:59:59</CampaignEndTime> <EntryStartTime>2016-03-15 00:00:00</EntryStartTime> <EntryEndTime>2016-03-15 23:59:59</EntryEndTime> <IsAutoEntry>0</IsAutoEntry> <Images> <Image index="1"> <Width>56</Width> <Height>56</Height> <Url>http://i.yimg.jp/images/shp_edit/points/smartphone20131225/56_56.gif</Url> </Image> <Image index="2"> <Width>76</Width> <Height>76</Height> <Url>http://i.yimg.jp/images/shp_edit/points/smartphone20131225/76_76.gif</Url> </Image> <Image index="3"> <Width>300</Width> <Height>300</Height> <Url>http://i.yimg.jp/images/shp_edit/points/modal_bnr/pointx5.gif</Url> </Image> </Images> <Contents> <Content index="1"> <Device>pc</Device> <Description>ポイント最大5倍! エントリーしてお買い物をすると、ストアポイントに加えてボーナスポイントをプレゼント。</Description> <Url>http://topics.shopping.yahoo.co.jp/campaign/points/pointx5/</Url> <ArchivedUrl>http://topics.shopping.yahoo.co.jp/campaign/points/pointx5/</ArchivedUrl> <Carrier/> </Content> </Contents> <Rules> <Rule index="1"> <Target>ALL</Target> <Ratios> <Ratio index="1"> <Type>ALL</Type> <Num>4</Num> </Ratio> </Ratios> </Rule> </Rules> <MaxRatio>4</MaxRatio> </Result> <Result index="2"> <Title>Yahoo!プレミアム会員限定!アプリで買ったらTポイント3倍!</Title> <Id>1105</Id> <EventType>noentry</EventType> <IsDisplay>1</IsDisplay> <IsCondition>1</IsCondition> <Sentence>Yahoo!プレミアム会員の方ならアプリでお買物をするとTポイント3倍!</Sentence> <CampaignStartTime>2016-03-11 00:00:00</CampaignStartTime> <CampaignEndTime>2016-03-20 23:59:59</CampaignEndTime> <EntryStartTime>2016-03-11 00:00:00</EntryStartTime> <EntryEndTime>2016-03-20 23:59:59</EntryEndTime> <IsAutoEntry>1</IsAutoEntry> <Images> <Image index="1"> <Width>56</Width> <Height>56</Height> <Url>http://i.yimg.jp/images/shp_edit/points/apps3/images/bnr/premium_56_56.png</Url> </Image> <Image index="2"> <Width>76</Width> <Height>76</Height> <Url>http://i.yimg.jp/images/shp_edit/points/apps3/images/bnr/premium_76_76.png</Url> </Image> <Image index="3"> <Width>300</Width> <Height>300</Height> <Url>http://i.yimg.jp/images/shp_edit/points/apps3/images/bnr/premium_300_300.png</Url> </Image> </Images> <Contents> <Content index="1"> <Device>pc</Device> <Description>Yahoo!プレミアム会員の方ならアプリでお買物をするとTポイント3倍!</Description> <Url>http://topics.shopping.yahoo.co.jp/general/points/apps3/</Url> <ArchivedUrl>http://topics.shopping.yahoo.co.jp/general/points/apps3/</ArchivedUrl> <Carrier/> </Content> </Contents> <Rules> <Rule index="1"> <Target>AppPremium</Target> <Ratios> <Ratio index="1"> <Type>AppPremium</Type> <Num>2</Num> </Ratio> </Ratios> </Rule> </Rules> <MaxRatio>2</MaxRatio> </Result> <Result index="3"> <Title>Yahoo! JAPANカード新規入会キャンペーン</Title> <Id>895</Id> <EventType>noentry</EventType> <IsDisplay>0</IsDisplay> <IsCondition>0</IsCondition> <Sentence/> <CampaignStartTime>2015-04-06 00:00:00</CampaignStartTime> <CampaignEndTime>2016-03-31 11:59:59</CampaignEndTime> <EntryStartTime>2015-04-06 00:00:00</EntryStartTime> <EntryEndTime>2016-03-31 11:59:59</EntryEndTime> <IsAutoEntry>1</IsAutoEntry> <Images> <Image index="1"> <Width>56</Width> <Height>56</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/20151112/56_56_shp.png</Url> </Image> <Image index="2"> <Width>76</Width> <Height>76</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/20150401/76_76.png</Url> </Image> <Image index="3"> <Width>300</Width> <Height>300</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/20150401/300x300.png</Url> </Image> </Images> <Contents> <Content index="1"> <Device>pc</Device> <Description>開催期間中にYahoo! JAPANカードのお申し込みを行い、カード到着後にYahoo!カードを使って決済をした方に5,000ポイントプレゼント。</Description> <Url>http://rdsig.yahoo.co.jp/yjcard/pc/shp/toolbar/evt=124979/RV=1/RU=aHR0cDovL2NhcmQueWFob28uY28uanAvY2FtcGFpZ24vPy5kb25lPWh0dHAlM0ElMkYlMkZzaG9wcGluZy55YWhvby5jby5qcCUyRiZwcmVtX29wdD1QXzQwMDIuQ19TdG9DMDAwMw--</Url> <ArchivedUrl>http://rdsig.yahoo.co.jp/yjcard/pc/shp/toolbar/evt=124979/RV=1/RU=aHR0cDovL2NhcmQueWFob28uY28uanAvY2FtcGFpZ24vPy5kb25lPWh0dHAlM0ElMkYlMkZzaG9wcGluZy55YWhvby5jby5qcCUyRiZwcmVtX29wdD1QXzQwMDIuQ19TdG9DMDAwMw--</ArchivedUrl> <Carrier/> </Content> </Contents> <Rules> <Rule index="1"> <Target/> <Ratios> <Ratio index="1"> <Type/> <Num>0</Num> </Ratio> </Ratios> </Rule> </Rules> <MaxRatio>0</MaxRatio> </Result> <Result index="4"> <Title>Yahoo! JAPANカードご利用で毎日Tポイント3倍</Title> <Id>1017</Id> <EventType>yjcard</EventType> <IsDisplay>1</IsDisplay> <IsCondition>0</IsCondition> <Sentence/> <CampaignStartTime>2015-12-01 00:00:00</CampaignStartTime> <CampaignEndTime>2016-03-31 23:59:59</CampaignEndTime> <EntryStartTime>2015-12-01 00:00:00</EntryStartTime> <EntryEndTime>2016-03-31 23:59:59</EntryEndTime> <IsAutoEntry>1</IsAutoEntry> <Images> <Image index="1"> <Width>56</Width> <Height>56</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/20150731/56x56.png</Url> </Image> <Image index="2"> <Width>76</Width> <Height>76</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/20150731/76x76.png</Url> </Image> <Image index="3"> <Width>300</Width> <Height>300</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/20150801/store_300_300.png</Url> </Image> </Images> <Contents> <Content index="1"> <Device>pc</Device> <Description>Yahoo!ショッピングとLOHACOでのご利用時、Tポイントが毎日合計3倍たまります。</Description> <Url>http://rdsig.yahoo.co.jp/yjcard/pc/shp/toolbar/evt=124979/RV=1/RU=aHR0cDovL2NhcmQueWFob28uY28uanAvY2FtcGFpZ24vPy5kb25lPWh0dHAlM0ElMkYlMkZzaG9wcGluZy55YWhvby5jby5qcCUyRiZwcmVtX29wdD1QXzQwMDIuQ19TdG9DMDAwMw--</Url> <ArchivedUrl>http://rdsig.yahoo.co.jp/yjcard/pc/shp/toolbar/evt=124979/RV=1/RU=aHR0cDovL2NhcmQueWFob28uY28uanAvY2FtcGFpZ24vPy5kb25lPWh0dHAlM0ElMkYlMkZzaG9wcGluZy55YWhvby5jby5qcCUyRiZwcmVtX29wdD1QXzQwMDIuQ19TdG9DMDAwMw--</ArchivedUrl> <Carrier/> </Content> </Contents> <Rules> <Rule index="1"> <Target>CreditCard</Target> <Ratios> <Ratio index="1"> <Type>CreditCard</Type> <Num>2</Num> </Ratio> </Ratios> </Rule> </Rules> <MaxRatio>2</MaxRatio> </Result> <Result index="5"> <Title>Yahoo!プレミアム会員限定!Tポイント5倍!</Title> <Id>1006</Id> <EventType>noentry</EventType> <IsDisplay>1</IsDisplay> <IsCondition>0</IsCondition> <Sentence/> <CampaignStartTime>2015-10-01 00:00:00</CampaignStartTime> <CampaignEndTime>2016-03-31 23:59:59</CampaignEndTime> <EntryStartTime>2015-10-01 00:00:00</EntryStartTime> <EntryEndTime>2016-03-31 23:59:59</EntryEndTime> <IsAutoEntry>1</IsAutoEntry> <Images> <Image index="1"> <Width>56</Width> <Height>56</Height> <Url>http://i.yimg.jp/images/shp_edit/points/premium/20150701/56_56.gif</Url> </Image> <Image index="2"> <Width>76</Width> <Height>76</Height> <Url>http://i.yimg.jp/images/shp_edit/points/premium/20150701/76_76.gif</Url> </Image> <Image index="3"> <Width>300</Width> <Height>300</Height> <Url>http://i.yimg.jp/images/shp_edit/points/modal_bnr/premium_03.gif</Url> </Image> </Images> <Contents> <Content index="1"> <Device>pc</Device> <Description>Yahoo!プレミアム会員なら、毎日のお買い物がずっとポイント5倍!</Description> <Url>http://topics.shopping.yahoo.co.jp/campaign/points/premium/</Url> <ArchivedUrl>http://topics.shopping.yahoo.co.jp/campaign/points/premium/</ArchivedUrl> <Carrier/> </Content> </Contents> <Rules> <Rule index="1"> <Target>Premium</Target> <Ratios> <Ratio index="1"> <Type>Premium</Type> <Num>4</Num> </Ratio> </Ratios> </Rule> </Rules> <MaxRatio/> </Result> <Result index="6"> <Title>Yahoo! JAPANカード 今ならどこでも2倍たまるキャンペーン</Title> <Id>1098</Id> <EventType>point</EventType> <IsDisplay>1</IsDisplay> <IsCondition>0</IsCondition> <Sentence/> <CampaignStartTime>2016-03-10 00:00:00</CampaignStartTime> <CampaignEndTime>2016-03-31 23:59:59</CampaignEndTime> <EntryStartTime>2016-03-10 00:00:00</EntryStartTime> <EntryEndTime>2016-03-31 23:59:59</EntryEndTime> <IsAutoEntry>0</IsAutoEntry> <Images> <Image index="1"> <Width>56</Width> <Height>56</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/2percent/20160310/56_56.png</Url> </Image> <Image index="2"> <Width>76</Width> <Height>76</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/2percent/20160310/76_76.png</Url> </Image> <Image index="3"> <Width>300</Width> <Height>300</Height> <Url>http://i.yimg.jp/images/yjcard/campaign/bnr/2percent/20160310/300_300.png</Url> </Image> </Images> <Contents> <Content index="1"> <Device>pc</Device> <Description>エントリーしてYahoo! JAPANカードでお買い物をすると、開催期間のお買い物100円につき1ポイントを進呈</Description> <Url>http://rdsig.yahoo.co.jp/yjcrd/sp/shp/app/2spring/RV=1/RU=aHR0cDovL2NhcmQueWFob28uY28uanAvY2FtcGFpZ24vcHJvbW90aW9uLzJwZXJjZW50Lw--</Url> <ArchivedUrl>http://rdsig.yahoo.co.jp/yjcrd/sp/shp/app/2spring/RV=1/RU=aHR0cDovL2NhcmQueWFob28uY28uanAvY2FtcGFpZ24vcHJvbW90aW9uLzJwZXJjZW50Lw--</ArchivedUrl> <Carrier/> </Content> </Contents> <Rules> <Rule index="1"> <Target>Wallet</Target> <Ratios> <Ratio index="1"> <Type>Wallet</Type> <Num>1</Num> </Ratio> </Ratios> </Rule> </Rules> <MaxRatio>1</MaxRatio> </Result> <Result index="7"> <Title>Enjoyパック 今ならYahoo!ショッピングお買い物で最大24倍キャンペーン</Title> <Id>1106</Id> <EventType>point</EventType> <IsDisplay>0</IsDisplay> <IsCondition>0</IsCondition> <Sentence/> <CampaignStartTime>2016-03-14 00:00:00</CampaignStartTime> <CampaignEndTime>2016-03-31 23:59:59</CampaignEndTime> <EntryStartTime>2016-03-14 00:00:00</EntryStartTime> <EntryEndTime>2016-03-31 23:59:59</EntryEndTime> <IsAutoEntry>0</IsAutoEntry> <Images> <Image index="1"> <Width>56</Width> <Height>56</Height> <Url>http://i.yimg.jp/images/enjoy/pc/campaign/point/201603/banner/56x56.png</Url> </Image> <Image index="2"> <Width>76</Width> <Height>76</Height> <Url>http://i.yimg.jp/images/enjoy/pc/campaign/point/201603/banner/76x76.png</Url> </Image> <Image index="3"> <Width>300</Width> <Height>300</Height> <Url>http://i.yimg.jp/images/enjoy/pc/campaign/point/201603/banner/300x300.png</Url> </Image> </Images> <Contents> <Content index="1"> <Device>pc</Device> <Description>Enjoyパック会員の方限定! Yahoo!ショッピングでのお買物でボーナスポイントプレゼント</Description> <Url>http://contents.enjoy.yahoo.co.jp/campaign/point/201603.html</Url> <ArchivedUrl>http://contents.enjoy.yahoo.co.jp/campaign/point/201603.html</ArchivedUrl> <Carrier/> </Content> </Contents> <Rules> <Rule index="1"> <Target/> <Ratios> <Ratio index="1"> <Type/> <Num>0</Num> </Ratio> </Ratios> </Rule> </Rules> <MaxRatio>0</MaxRatio> </Result> </Results>
エラー
ポイントキャンペーン情報取得APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。(無料)
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。
利用約款
このAPIに関する利用約款はこちら。