高評価トレンドランキング

Yahoo!ショッピングの商品のランキング情報を取得することが可能なAPIです。
注文した人の数や、ユーザーからのレビュー評価などの複数の指数を組み合わせてランキングを提供します。

リクエストURL

URL
https://shopping.yahooapis.jp/ShoppingWebService/V1/highRatingTrendRanking

リクエストパラメータ

「Web APIの使い方#GETとは」をご参照ください。

パラメータ 型 説明
appid
（必須）		 String Client ID（アプリケーションID）。詳細はこちらをご覧ください。
affiliate_type String バリューコマースアフィリエイト(vc)を選択。
例：affiliate_type=vc
affiliate_id String バリューコマースアフィリエイトID
query String 検索クエリ
※ 文字コードはUTF-8を想定しています。
genre_category_id Integer[] ジャンルカテゴリID
カンマ区切りで複数指定できます。
複数指定の場合はOR検索です。
※ 複数指定の場合、上限は50カテゴリです。
brand_id Long[] ブランドコード
カンマ区切りで複数指定できます。
複数指定の場合はOR検索です。
※ 複数指定の場合、上限は50ブランドです。
exclude_genre_category_id Integer[] 除外するジャンルカテゴリID
除外するジャンルカテゴリIDを指定することで当該カテゴリを含む商品をランキングから排他します。
複数のカテゴリを指定するとそれらを含む商品を全て排他します。
※ (NOT カテゴリA) AND (NOT カテゴリB)のようにANDで否定条件が結合されます。
※ 複数指定の場合、上限は50カテゴリです。
exclude_brand_id Long[] 除外するブランドコード
除外するブランドコードを指定することで当該ブランドを含む商品をランキングから排他します。
複数のブランドを指定するとそれらを含む商品を全て排他します。
※ (NOT ブランドA) AND (NOT ブランドB)のようにANDで否定条件が結合されます。
※ 複数指定の場合、上限は50ブランドです。
price_from Integer 商品価格（下限）
※ 下限を含みます。
※ セール期間の場合はセール価格を、セール期間外の場合は通常価格を検索します。
※ ストアが日中に設定変更した場合などずれが生じる場合があります。
price_to Integer 商品価格（上限）
※ 上限を含みます。
※ セール期間の場合はセール価格を、セール期間外の場合は通常価格を検索します。
※ ストアが日中に設定変更した場合などずれが生じる場合があります。
seller_id String[] ストアアカウント（ストアID）
カンマ区切りで複数指定できます。
複数指定の場合はOR検索です。
※ 複数指定の場合、上限は50ストアです。
delivery Boolean 送料無料設定
（true：送料無料の商品のみ、falseまたは未指定：全商品）
app_ban Integer アプリ最適化設定
ランキングに含まれる商品をエンドユーザのデバイスに応じて制御します。
0：全商品掲出
1：iOS用に掲出商品を最適化
2：android用に掲出商品を最適化
※ デフォルト値は0です。
offset Integer 指定した順位からランキングを取得します。
例）offset=1の場合1位からのランキングを取得、offset=11の場合11位からのランキングを取得します。
※ デフォルト値は1です。
limit Integer ランキングの取得件数
※ 上限は100です。
※ デフォルト値は20です。

サンプルリクエストURL

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

レスポンスフィールド

path 型 説明
/high_rating_trend_ranking/ Object ルート要素
検索条件
/high_rating_trend_ranking/conditions/ Object 検索条件要素
/high_rating_trend_ranking/conditions/query String 検索クエリ
/high_rating_trend_ranking/conditions/genre_category_id Integer[] ジャンルカテゴリID
/high_rating_trend_ranking/conditions/brand_id Long[] ブランドコード
/high_rating_trend_ranking/conditions/exclude_genre_category_id Integer[] 除外ジャンルカテゴリID
/high_rating_trend_ranking/conditions/exclude_brand_id Long[] 除外ブランドコード
/high_rating_trend_ranking/conditions/price_from Integer 商品価格 （下限）
/high_rating_trend_ranking/conditions/price_to Integer 商品価格 （上限）
/high_rating_trend_ranking/conditions/seller_id String[] ストアアカウント（ストアID）
/high_rating_trend_ranking/conditions/delivery String 送料無料設定
/high_rating_trend_ranking/conditions/app_ban Integer アプリ最適化設定
/high_rating_trend_ranking/conditions/offset Integer 順位指定
/high_rating_trend_ranking/conditions/limit Integer 取得件数
メタ情報
/category_ranking/meta/ Object メタ要素
/high_rating_trend_ranking/meta/last_modified String ランキング更新日 (YYYY-MM-DD)
/high_rating_trend_ranking/meta/total_results_returned Integer 取得件数
/high_rating_trend_ranking/meta/total_results_available Integer ランキング総件数
検索条件にあてはまる商品件数です。
※ 上限は1,000です。
検索結果
/high_rating_trend_ranking/ranking_data/ Object ランキング要素
/high_rating_trend_ranking/ranking_data/rank Integer 順位
商品情報 - item_information項目
/high_rating_trend_ranking/ranking_data/item_information/ Object 商品情報要素
/high_rating_trend_ranking/ranking_data/item_information/name String 商品名
/high_rating_trend_ranking/ranking_data/item_information/code String 商品コード (srid)
/high_rating_trend_ranking/ranking_data/item_information/brand_id String ブランドコード
/high_rating_trend_ranking/ranking_data/item_information/url String 商品URL
※ affiliate_typeとaffiliate_idを指定した場合アフィリエイトプログラム用の商品URLです。
/high_rating_trend_ranking/ranking_data/item_information/regular_price Integer 通常価格（税込）
/high_rating_trend_ranking/ranking_data/item_information/list_price Integer 定価（メーカー希望小売価格）（税込）
/high_rating_trend_ranking/ranking_data/item_information/bargain_price Integer セール価格（税込)
/high_rating_trend_ranking/ranking_data/item_information/premium_price Integer プレミアム会員価格（税込）
/high_rating_trend_ranking/ranking_data/item_information/tax_excluded_regular_price Integer 通常価格（税抜)
/high_rating_trend_ranking/ranking_data/item_information/tax_excluded_list_price Integer 定価（メーカー希望小売価格）（税抜）
/high_rating_trend_ranking/ranking_data/item_information/tax_excluded_bargain_price Integer セール価格（税抜）
/high_rating_trend_ranking/ranking_data/item_information/tax_excluded_premium_price Integer プレミアム会員価格（税抜）
検索結果 - image項目
/high_rating_trend_ranking/ranking_data/image/ Object 画像要素
/high_rating_trend_ranking/ranking_data/image/id String 画像ID
/high_rating_trend_ranking/ranking_data/image/small String 76×76サイズの画像URL
/high_rating_trend_ranking/ranking_data/image/medium String 146×146サイズの画像URL
検索結果 - review項目
/high_rating_trend_ranking/ranking_data/review/ Object レビュー要素
/high_rating_trend_ranking/ranking_data/review/rate Float レビュー評価
/high_rating_trend_ranking/ranking_data/review/count Integer レビュー件数
/high_rating_trend_ranking/ranking_data/review/url String レビューURL
※ affiliate_idとaffiliate_typeを指定した場合アフィリエイトプログラム用のレビューURLです。
検索結果 - seller項目
/high_rating_trend_ranking/ranking_data/seller/ Object ストア要素
/high_rating_trend_ranking/ranking_data/seller/id String ストアアカウント（ストアID）
/high_rating_trend_ranking/ranking_data/seller/name String ストア名
/high_rating_trend_ranking/ranking_data/seller/url String ストアURL
ブランド情報 - brands項目
/high_rating_trend_ranking/brands/ Object ブランド要素
※ ブランドが1種類だけ指定された場合に限りデータが返却されます。
ブランド情報 - current項目
/high_rating_trend_ranking/brands/current/ Object 指定ブランド情報
/high_rating_trend_ranking/brands/current/id String ブランドコード
/high_rating_trend_ranking/brands/current/name String ブランド名
ブランド項目 - children項目
/high_rating_trend_ranking/brands/children/ Object 子ブランド要素
/high_rating_trend_ranking/brands/children/id String ブランドコード
/high_rating_trend_ranking/brands/children/name String ブランド名
カテゴリ情報 - categories項目
/high_rating_trend_ranking/categories/ Object カテゴリ要素
※ カテゴリが1種類だけ指定された場合に限りデータが返却されます。
カテゴリ情報 - current項目
/high_rating_trend_ranking/categories/current/ Object 指定カテゴリ情報
/high_rating_trend_ranking/categories/current/id Integer ジャンルカテゴリID
/high_rating_trend_ranking/categories/current/parent_id Integer 親カテゴリID
/high_rating_trend_ranking/categories/current/url String カテゴリURL
カテゴリ情報 - currentのtitle項目
/high_rating_trend_ranking/categories/current/title/ Object タイトル情報
/high_rating_trend_ranking/categories/current/title/short String カテゴリ名
/high_rating_trend_ranking/categories/current/title/medium String カテゴリパス名1
/high_rating_trend_ranking/categories/current/title/long String カテゴリパス名2
カテゴリ情報 - currentのpath項目
/high_rating_trend_ranking/categories/current/path/ Object パス要素
/high_rating_trend_ranking/categories/current/path/depth Integer トップからのカテゴリの深さ
/high_rating_trend_ranking/categories/current/path/id Integer ジャンルカテゴリID（カテゴリパス用）
/high_rating_trend_ranking/categories/current/path/parent_id Integer 親カテゴリID（カテゴリパス用）
カテゴリ情報 - currentのpathのタイトル情報
/high_rating_trend_ranking/categories/current/path/title/ Object パスのタイトル要素
/high_rating_trend_ranking/categories/current/path/title/name String カテゴリ名（カテゴリパス用）
カテゴリ情報 - children項目
/high_rating_trend_ranking/categories/children/ Object 子カテゴリ要素
/high_rating_trend_ranking/categories/children/sort_order Integer ソート順
/high_rating_trend_ranking/categories/children/id Integer ジャンルカテゴリID
/high_rating_trend_ranking/categories/children/url String カテゴリURL
カテゴリ情報 - childのtitle項目
/high_rating_trend_ranking/categories/children/title/ Object 子カテゴリのタイトル情報
/high_rating_trend_ranking/categories/children/title/short String カテゴリ名（子カテゴリパス用）
/high_rating_trend_ranking/categories/children/title/medium String カテゴリパス名1（子カテゴリパス用）
/high_rating_trend_ranking/categories/children/title/long String カテゴリパス名2（子カテゴリパス用）

サンプルレスポンス

以下は、下記の条件を指定したリクエスト（query=%E6%B0%B4&genre_category_id=17583&brand_id=14829&seller_id=teststore&limit=5）に対するレスポンスです。

  • 検索クエリ：水
  • ジャンルカテゴリID：17583
  • ブランドコード：14829
  • ストアアカウント：teststore
  • 取得件数：5
{
  "high_rating_trend_ranking": {
    "conditions": {
      "query": "水",
      "genre_category_id": [
        17583
      ],
      "brand_id": [
        14829
      ],
      "exclude_genre_category_id": [],
      "exclude_brand_id": [],
      "price_from": null,
      "price_to": null,
      "seller_id": [
        "teststore"
      ],
      "delivery": null,
      "app_ban": 0,
      "offset": 1,
      "limit": 5
    },
    "meta": {
      "last_modified": "2022-12-07",
      "total_results_returned": 5,
      "total_results_available": 6
    },
    "ranking_data": [
      {
        "rank": 1,
        "item_information": {
          "name": "【水・ミネラルウォーター】teststore Water（ロハコウォーター）2L ラベルレス 1箱（5本入） オリジナル",
          "code": "u254244",
          "brand_id": "21891",
          "url": "https://store.shopping.yahoo.co.jp/teststore/u254244.html",
          "regular_price": 398,
          "list_price": null,
          "bargain_price": null,
          "premium_price": null,
          "tax_excluded_regular_price": 369,
          "tax_excluded_list_price": null,
          "tax_excluded_bargain_price": null,
          "tax_excluded_premium_price": null
        },
        "image": {
          "id": "teststore_u254244_i_20221001180434",
          "small": "https://item-shopping.c.yimg.jp/i/c/teststore_u254244",
          "medium": "https://item-shopping.c.yimg.jp/i/g/teststore_u254244"
        },
        "review": {
          "rate": 4.71,
          "count": 15975,
          "url": "https://shopping.yahoo.co.jp/review/item/list?store_id=teststore&page_key=u254244"
        },
        "seller": {
          "id": "teststore",
          "name": "teststore Yahoo!店",
          "url": "https://store.shopping.yahoo.co.jp/teststore/"
        }
      },
      {
        "rank": 2,
        "item_information": {
          "name": "【水・ミネラルウォーター】teststore Water 410ml 1箱（20本入）ラベルレス オリジナル",
          "code": "j697437",
          "brand_id": "21891",
          "url": "https://store.shopping.yahoo.co.jp/teststore/j697437.html",
          "regular_price": 1370,
          "list_price": null,
          "bargain_price": null,
          "premium_price": null,
          "tax_excluded_regular_price": 1269,
          "tax_excluded_list_price": null,
          "tax_excluded_bargain_price": null,
          "tax_excluded_premium_price": null
        },
        "image": {
          "id": "teststore_j697437_i_20221001180432",
          "small": "https://item-shopping.c.yimg.jp/i/c/teststore_j697437",
          "medium": "https://item-shopping.c.yimg.jp/i/g/teststore_j697437"
        },
        "review": {
          "rate": 4.78,
          "count": 5780,
          "url": "https://shopping.yahoo.co.jp/review/item/list?store_id=teststore&page_key=j697437"
        },
        "seller": {
          "id": "teststore",
          "name": "teststore Yahoo!店",
          "url": "https://store.shopping.yahoo.co.jp/teststore/"
        }
      },
      {
        "rank": 3,
        "item_information": {
          "name": "【強炭酸水】 teststore Water スパークリング 500ml 1箱（15本入）ラベルレス オリジナル",
          "code": "u360884",
          "brand_id": "21891",
          "url": "https://store.shopping.yahoo.co.jp/teststore/u360884.html",
          "regular_price": 1020,
          "list_price": null,
          "bargain_price": null,
          "premium_price": null,
          "tax_excluded_regular_price": 945,
          "tax_excluded_list_price": null,
          "tax_excluded_bargain_price": null,
          "tax_excluded_premium_price": null
        },
        "image": {
          "id": "teststore_u360884_i_20221001180436",
          "small": "https://item-shopping.c.yimg.jp/i/c/teststore_u360884",
          "medium": "https://item-shopping.c.yimg.jp/i/g/teststore_u360884"
        },
        "review": {
          "rate": 4.72,
          "count": 1192,
          "url": "https://shopping.yahoo.co.jp/review/item/list?store_id=teststore&page_key=u360884"
        },
        "seller": {
          "id": "teststore",
          "name": "teststore Yahoo!店",
          "url": "https://store.shopping.yahoo.co.jp/teststore/"
        }
      },
      {
        "rank": 4,
        "item_information": {
          "name": "【強炭酸水】 teststore Water スパークリング 500ml 1セット（30本）ラベルレス オリジナル",
          "code": "u360887",
          "brand_id": "21891",
          "url": "https://store.shopping.yahoo.co.jp/teststore/u360887.html",
          "regular_price": 2040,
          "list_price": null,
          "bargain_price": null,
          "premium_price": null,
          "tax_excluded_regular_price": 1889,
          "tax_excluded_list_price": null,
          "tax_excluded_bargain_price": null,
          "tax_excluded_premium_price": null
        },
        "image": {
          "id": "teststore_u360887_i_20221001180422",
          "small": "https://item-shopping.c.yimg.jp/i/c/teststore_u360887",
          "medium": "https://item-shopping.c.yimg.jp/i/g/teststore_u360887"
        },
        "review": {
          "rate": 4.74,
          "count": 693,
          "url": "https://shopping.yahoo.co.jp/review/item/list?store_id=teststore&page_key=u360887"
        },
        "seller": {
          "id": "teststore",
          "name": "teststore Yahoo!店",
          "url": "https://store.shopping.yahoo.co.jp/teststore/"
        }
      },
      {
        "rank": 5,
        "item_information": {
          "name": "【水・ミネラルウォーター】【紙パック】teststore Water 1L 1セット（12本：6本入×2箱）オリジナル",
          "code": "pu73976",
          "brand_id": "14829",
          "url": "https://store.shopping.yahoo.co.jp/teststore/pu73976.html",
          "regular_price": 1280,
          "list_price": null,
          "bargain_price": null,
          "premium_price": null,
          "tax_excluded_regular_price": 1186,
          "tax_excluded_list_price": null,
          "tax_excluded_bargain_price": null,
          "tax_excluded_premium_price": null
        },
        "image": {
          "id": "teststore_pu73976_i_20221001180421",
          "small": "https://item-shopping.c.yimg.jp/i/c/teststore_pu73976",
          "medium": "https://item-shopping.c.yimg.jp/i/g/teststore_pu73976"
        },
        "review": {
          "rate": 4.67,
          "count": 18,
          "url": "https://shopping.yahoo.co.jp/review/item/list?store_id=teststore&page_key=pu73976"
        },
        "seller": {
          "id": "teststore",
          "name": "テストストア Yahoo!店",
          "url": "https://store.shopping.yahoo.co.jp/teststore/"
        }
      }
    ],
    "brands": {
      "current": {
        "id": "14829",
        "name": "ASKUL"
      },
      "children": [
        {
          "id": "21652",
          "name": "アスクルカフェ"
        },
        {
          "id": "21811",
          "name": "ECOPET"
        },
        {
          "id": "21812",
          "name": "スーパーエコノミーシリーズ"
        },
        {
          "id": "21813",
          "name": "マグネットR"
        },
        {
          "id": "21814",
          "name": "脚がじゃまにならない両面ホワイトボード"
        },
        {
          "id": "21815",
          "name": "色ナビ"
        },
        {
          "id": "21816",
          "name": "貼ってはがせるオフィスのノート"
        },
        {
          "id": "21817",
          "name": "貼ってはがせるオフィスのふせん"
        },
        {
          "id": "21869",
          "name": "ろはこ米"
        },
        {
          "id": "21871",
          "name": "ヤシノミ洗剤"
        },
        {
          "id": "21872",
          "name": "プレミアムパワー"
        },
        {
          "id": "21873",
          "name": "ヤシノミ洗たく用洗剤"
        },
        {
          "id": "21874",
          "name": "泡ハンドソープ"
        },
        {
          "id": "21876",
          "name": "TOKIO"
        },
        {
          "id": "21877",
          "name": "イージーバック"
        },
        {
          "id": "21878",
          "name": "くっきりブラック"
        },
        {
          "id": "21879",
          "name": "スマートコンパクト"
        },
        {
          "id": "21880",
          "name": "ビジネスフィット"
        },
        {
          "id": "21881",
          "name": "プラチナシルバー"
        },
        {
          "id": "21882",
          "name": "現場のチカラ"
        },
        {
          "id": "21883",
          "name": "エムテック A"
        },
        {
          "id": "21884",
          "name": "クリップホルダー"
        },
        {
          "id": "21885",
          "name": "サインホルダー"
        },
        {
          "id": "21886",
          "name": "ノンパッケージ"
        },
        {
          "id": "21887",
          "name": "フロアスタンド"
        },
        {
          "id": "21888",
          "name": "ポップスタンド"
        },
        {
          "id": "21889",
          "name": "リングスタンド"
        },
        {
          "id": "21890",
          "name": "Lateco"
        },
        {
          "id": "21891",
          "name": "teststore Water"
        },
        {
          "id": "21892",
          "name": "NEXIS"
        },
        {
          "id": "71322",
          "name": "teststore"
        }
      ]
    },
    "categories": {
      "current": {
        "id": 17583,
        "parent_id": 2499,
        "url": "http://shopping.yahoo.co.jp/category/17583/recommend",
        "title": {
          "short": "水、炭酸水",
          "medium": "水、炭酸水",
          "long": "食品 >ドリンク、水、お酒 > 水、炭酸水"
        },
        "path": [
          {
            "depth": 1,
            "id": 1,
            "parent_id": 0,
            "title": {
              "name": "Shopping"
            }
          },
          {
            "depth": 1,
            "id": 2498,
            "parent_id": 1,
            "title": {
              "name": "食品"
            }
          },
          {
            "depth": 1,
            "id": 2499,
            "parent_id": 2498,
            "title": {
              "name": "ドリンク、水、お酒"
            }
          },
          {
            "depth": 1,
            "id": 17583,
            "parent_id": 2499,
            "title": {
              "name": "水、炭酸水"
            }
          }
        ]
      },
      "children": [
        {
          "sort_order": 10,
          "id": 17587,
          "url": "http://shopping.yahoo.co.jp/category/17587/recommend",
          "title": {
            "short": "ミネラルウォーター、水",
            "medium": "ミネラルウォーター、水",
            "long": "食品 > ドリンク、水、お酒 > 水、ミネラルウォーター > ミネラルウォーター、水"
          }
        },
        {
          "sort_order": 20,
          "id": 17606,
          "url": "http://shopping.yahoo.co.jp/category/17606/recommend",
          "title": {
            "short": "発泡水、炭酸水",
            "medium": "発泡水、炭酸水",
            "long": "食品 > ドリンク、水、お酒 > 水、ミネラルウォーター > 発泡水、炭酸水"
          }
        },
        {
          "sort_order": 30,
          "id": 17597,
          "url": "http://shopping.yahoo.co.jp/category/17597/recommend",
          "title": {
            "short": "保存水",
            "medium": "保存水",
            "long": "食品 > ドリンク、水、お酒 > 水、ミネラルウォーター > 保存水"
          }
        },
        {
          "sort_order": 40,
          "id": 17601,
          "url": "http://shopping.yahoo.co.jp/category/17601/recommend",
          "title": {
            "short": "ウォーターサーバー",
            "medium": "ウォーターサーバー",
            "long": "食品 > ドリンク、水、お酒 > 水、ミネラルウォーター > ウォーターサーバー"
          }
        }
      ]
    }
  }
}

エラー

高評価トレンドランキングは、Yahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用約款

このAPIに関する利用約款はこちら。

アプリケーションの管理

目次

利用のルール

開発のヒント