トップ  > ツール > SDK一覧 > Ruby SDK

Ruby SDK

ソースコード: https://github.com/rakuten-ws/rws-ruby-sdk

RakutenWebService

Build Status Gem Version Coverage Status

rakuten_web_serviceは、 Rubyから楽天が提供しているAPIに簡単にアクセスできるSDK(Software Development Kit)です。

English version is here.

インストール方法

bundlerを利用したアプリケーションの場合、Gemfileに以下の1行を追加します。

  gem 'rakuten_web_service'

そしてbundleコマンドでインストール。

$ bundle

もしくは、gemコマンドにより

$ gem install rakuten_web_service

とすることでインストールできます。

現在rakuten_web_serviceは下記のAPIをサポートしています。

楽天市場API

楽天ブックス系API

楽天Kobo系API

楽天レシピ系API

楽天GORA系API

使用方法

事前準備: アプリケーションIDの取得

楽天ウェブサービスAPIを利用の際に、アプリケーションIDが必要です。 まだ取得していない場合は、楽天ウェブサービスAPIのアプリケーション登録を行い、アプリケーションIDを取得してください。

設定

RakutenWebService.configure メソッドを使い、Application IDとAffiliate ID(オプション)を指定することができます。

  RakutenWebService.configure do |c|
    c.application_id = 'YOUR_APPLICATION_ID'
    c.affiliate_id = 'YOUR_AFFILIATE_ID'
  end

'YOUR_APPLICATION_ID''YOUR_AFFILIATE_ID' は、実際のアプリケーションIDとアフィリエイトIDに置き換えてください。

市場商品の検索

  items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enumerable object
  items.first(10).each do |item|
    puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash.
  end

ジャンル

Genreクラスは、childrenparentといったジャンル階層を辿るインターフェースを持っています。

  root = RakutenWebService::Ichiba::Genre.root # root genre
  # children returns sub genres
  root.children.each do |child|
    puts "[#{child.id}] #{child.name}"
  end

  # Use genre id to fetch genre object
  RakutenWebService::Ichiba::Genre[100316].name # => "水・ソフトドリンク"

市場商品ランキング

  ranking_by_age = RakutenWebService::Ichiba::Item.ranking(:age => 30, :sex => 1) # 30代男性 のランキングTOP 30
  ranking_by_age.each do |ranking|
    # 'itemName'以外の属性については右記を参照 http://webservice.rakuten.co.jp/api/ichibaitemsearch/#outputParameter
    puts ranking['itemName']
  end

  ranking_by_genre = RakutenWebService::Ichiba::Genre[200162].ranking # "水・ソフトドリンク" ジャンルのTOP 30
  ranking_by_genre.each do |ranking|
    puts ranking['itemName']
  end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request