Top > API一覧 > 楽天ダイナミックアドAPI トラベル

楽天ダイナミックアドAPI トラベルは、ウェブページにマッチする楽天トラベルの施設が取得可能なAPIです。
(アフィリエイト用HTMLソースをご利用の方は楽天ダイナミックアドをご利用ください。)

リクエストURL(REST/JSON形式の場合)


http://api.rakuten.co.jp/rws/3.0/rest?[parameter]=[value]…
http://api.rakuten.co.jp/rws/3.0/json?[parameter]=[value]…

※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。

フィールド名urlに対応する[value]はUTF-8でURLエンコードされている必要があります。(リクエストURL全体をエンコードするのではなく、 [value]部分を個別にエンコードしてください。)※出力される楽天トラベルの施設は5件(固定)となります。

たとえば、「岩手の夏の風物詩」というページにマッチする楽天トラベルの施設一覧を取得する場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)

http://dynamic.rakuten.co.jp/rcm/1.0/t/rest?
developerId=[YOUR_developerID]
&affiliateId=[YOUR_affiliateID]
&url=http%3A%2F%2Fplaza.rakuten.co.jp%2Ftravelblog02%2Fdiary%2F200706140000%2F

※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。

入力パラメーター


楽天ダイナミックアドAPI トラベル 入力パラメータ

ID 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
区分:共通パラメーター
1 デベロッパーID developerId String Affiliate対応あり - デベロッパーID(こちらで確認できるアプリケーションIDのことです)
2 アフィリエイトID affiliateId String Affiliate対応あり - アフィリエイトID(β版)
3 URL url String Affiliate対応あり - 楽天トラベルの施設を掲載するページのURL
4 キャリア carrier int - 0 楽天トラベルの施設を掲載するページの種類
0:PCサイト
1:携帯サイト(注1)
5 コールバック関数名 callBack String - - JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上

出力パラメーター


楽天ダイナミックアドAPI トラベル 出力パラメータ

ID 分類 項目名 パラメーター 備考
区分:共通パラメーター
1 Arg - User-Agent Valueにはユーザのユーザエージェントが表示される
2 developerId Valueにはユーザの指定したデベロッパーが表示される
3 affiliateId Valueにはユーザの指定したアフィリエイトIDが表示される
4 version Valueにはユーザの指定した操作のバージョンが表示される
5 Status - Status Success / NotFound / ServerError / ClientError / Maintenance のいずれか
6 StatusMsg - StatusMsg Statusに特化したメッセージを出力
区分:サービス固有パラメーター
1 施設情報 施設名称 hotelName  
2 施設番号 hotelNo  
3 商品価格 itemPrice  
4 アフィリエイトURL affiliateHotelInformationUrl  
5 要約情報(地区) areaSum  
6 施設画像(小) smallImageUrl (画像サイズ70px*70px以内)
7 施設画像(中) mediumImageUrl (画像サイズ230px*210px以内)

モバイルページでご利用時の注意


キャリア(carieer)で「1:携帯サイト」を入力した場合、下記の点にご注意ください。
 ・弊社のクローラーのIPアドレス(203.190.60.3)からのアクセスを許可してください。
 ・弊社のクローラーは携帯サイトの情報を取得する際には、User-Agent:DoCoMo/2.0 N902iS(c100;TB;W24H12)(compatible; Rakutenbot/1.0; +http://dynamic.rakuten.co.jp/bot.html)でアクセスしますので、このUser-Agentでのアクセスを許可してください。

エラー


エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。

Statusでの表示 内容
NotFound 検索結果が存在しない。
ServerError 楽天ウェブサービス側のエラー。
ClientError デベロッパーの入力に起因するエラー。
Maintenance メンテナンス。