ログイン
IDでもっと便利に[ 新規取得 ]

ショッピング

カテゴリランキング

Version 1

リクエストURL

XML

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

PHPserialize

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

JSONP

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

カテゴリランキングは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 integer カテゴリIDを指定して使用。デフォルトは、全カテゴリからのランキング。
gender male/female 男性(male)、女性(female)の選択。指定なしだと全体のランキングを返す。
例:gender=male
generation integer 取得したい年齢の年代を指定。指定無しだと全世代。
例:20代のランキングを表示 generation=20
period weekly/daily 週間とデイリーでランキングの期間を指定、指定なしの場合は週間を返す。
offset integer 指定した順位を20位毎に表示。offset=1だと1位から20位まで、offset=20だと21位から40位までのランキング情報を返す。
type up 売上ランキングの急上昇分、上位5件を返します

サンプルリクエストURL

http://shopping.yahooapis.jp/ShoppingWebService/V1/categoryRanking?appid=<あなたのアプリケーションID>&category_id=2494&gender=female&generation=20

レスポンスフィールド

カテゴリランキングWeb APIのスキーマの記述は、以下のURLをご覧ください。
http://shopping.yahooapis.jp/ShoppingWebService/V1/categoryRanking.xsd

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

  • totalResultsAvailable: 総ランキング数
  • totalResultsReturned: 返された値の個数
  • firstResultsPosition: 最初のデータが何個目にあたるか(最初=1)

StartDate 集計開始日(YYYY-mm-dd)
EndDate 集計終了日(YYYY-mm-dd)
LastModified 更新日(YYYY-mm-dd)
Id リクエスト
category_idに入力した値
Gender リクエスト
genderに入力した値
Generation リクエスト
generationに入力した値
Period リクエスト
periodに入力した値
RankingData 商品のランキング情報

  • rank: 順位(1位から100位まで)
  • vector: 前日差(up:上昇/down:下降/stay:維持/new:新規)
  • type: 商品/製品(item/product)

Name 商品名/製品名
Url 商品URL/製品URL
Id 画像ID
Small 76×76サイズ画像URL
Medium 146×146サイズの画像URL
Id ストアID
Name ストア名
Url ストアURL
Id カテゴリID
ParentId 親カテゴリID
Url URL(※1)
Short カテゴリ名
Medium カテゴリパス名1
Long
カテゴリパス名2
Category 商品カテゴリ

  • depth: トップからのカテゴリの深さ

Id カテゴリID
ParentId 親カテゴリID
Name カテゴリ名
Children 子カテゴリ群
Child 子カテゴリ

  • sortOrder: ソート順

Id 子カテゴリID
Url URL
Short カテゴリ名
Medium カテゴリパス名1
Long カテゴリパス名2

※1 商品URLはYahoo!ショッピングのストア商品ページへのリンク、製品URLはYahoo!ショッピング製品ページへのリンクになります。

サンプルレスポンス

以下は、総合ランキング情報(カテゴリID指定なし)のリクエストに対するレスポンスです。

エラー

カテゴリランキングWeb APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用制限

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


開発者ブログ

Yahoo! JAPANのスタッフや著名なデベロッパーのブログを紹介しています。新しいサービスのアイデアにお役立てください。

開発者コミュニティ

Yahoo!グループに開発者のためのグループを用意しています。ほかのデベロッパーと交流し、質問やアイデアの共有にお役立てください。

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