report for biz API 仕様書 商圏分析レポート API ver1.01 技研商事インターナショナル株式会社 作成日 :2011/06/
改訂履歴 改訂履歴 日付 バージョン 更新内容 2012/06/01 1.00 初版 2012/06/28 1.01 テンプレート ID 追加
第 1 章概要... 4 1 本サービスのコンセプト... 4 1-1 r4b(report 4 biz) とは... 4 1-2 商圏分析レポート API とは... 4 2 システム構成... 4 第 2 章商圏分析レポート API... 5 1 リクエスト URL... 5 2 最小呼出しサンプル... 5 3 API メソッド... 6 4 API パラメータ... 6 5 API 戻り値... 7 6 API ステータスコード... 7 7 API 定数... 8 第 3 章商圏分析レポート API 呼出しサンプル集... 9 1 複数のメールアドレスに送信 ( 最大 10 アドレスまで )... 9 2 複数の商圏を指定 ( 最大 3 つまで )... 9 3 出力範囲 ( 地図の上端から下端までの距離 ) を指定... 10 4 分析地名 レポート出力形式 レポート日付 レポートファイル名を指定... 10 目次 4 API 戻り値... 12 5 取得データ... 13 6 呼出しサンプル... 14 第 5 章ジオコーディング API... 15 1 概要... 15 2 API メソッド... 15 3 API パラメータ... 15 4 API 戻り値... 15 5 取得データ... 15 6 マッチングレベル... 16 7 呼出しサンプル... 17 第 6 章レポート再送 API... 18 1 概要... 18 2 API メソッド... 18 3 API パラメータ... 18 4 API 戻り値... 18 5 呼出しサンプル... 19 第 4 章レポート履歴参照 API... 11 1 概要... 11 2 API メソッド... 11 3 API パラメータ... 11
[ 第 1 章概要 ] 1. 本サービスのコンセプト 第 1 章 概要 1 本サービスのコンセプト 1-1 r4b(report 4 biz) とは 価値のある情報 ( データベース ) を高度なノウハウと分析技術により API を介してレポート配信するプラットフォームの総称です 1-2 商圏分析レポート API とは r4b サービスの1つで 利用用途に合わせて地域特性が把握できる 様々な商圏分析レポートコンテンツを配信します 2 システム構成 JSON r4b サーバー 商圏分析レポート API JSON E-mail JSON:JavaScript Object Notation JavaScript のオブジェクトに変換できる テキストベースのデータフォーマット 4 / 19
[ 第 2 章商圏分析レポート API] 1. リクエスト URL 第 2 章 商圏分析レポート API 1 リクエスト URL https://report4biz.com/r4b/api/v1/r4bmaps.js 2 最小呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src="https://report4biz.com/r4b/api/v1/r4bmaps.js" charset="utf-8"></script> <script type="text/javascript"> function report() { var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", email: ["aaa@bbb.co.jp"], mapcenter: new r4b.maps.latlng(35.67146684898802, 139.7453052721023), mapareatype: [r4b.maps.areatypeid.circle], mapareasize: [3] ; r4b.maps.ordersimplereport(myoptions, callback); function callback(data) { alert(data.statuscode + ":" + data.statusdescription); </script> </head> <body><input type="button" value=" レポート作成 " onclick="report()" /></body> </html> userid と password には 別途ユーザーが取得したものを設定します また email には 宛先となるメールアドレスを設定します 5 / 19
[ 第 2 章商圏分析レポート API] 3.API メソッド 3 API メソッド r4b.maps.ordersimplereport(option [,callback]) 4 API パラメータ No. 項目 必最大数量型パラメータ名須桁数 値 1 ユーザー ID 1 string userid 30 半角英数 2 パスワード 1 string password 100 半角英数 3 メールアドレス 1~10 string email 255 メール形式 4 企業名 - 1 string corporatename 255 文字コード utf-8 以下同様 5 ユーザー用付加情報 - 1~3 string userinfo 255 6 分析地座標 ( 緯度 経度 ) 1 対 LatLng mapcenter r4b.maps.latlng(double Lat, double Lan) 7 商圏タイプ 1~3 int mapareatype 円 : r4b.maps.areatypeid.circle トラベルタイム ( 自動車 ): r4b.maps.areatypeid.car トラベルタイム ( 自転車 ): r4b.maps.areatypeid.bicycle トラベルタイム ( 徒歩 ): r4b.maps.areatypeid.walk 8 商圏サイズ 1~3 double mapareasize 商圏タイプが. 円の時 0.1 ~ 50 (km) 商圏タイプがトラベルタイムの時 1~60 ( 分 ) 円半径の有効桁数は小数点以下 2 桁までトラベルタイムは整数 商圏タイプと数を合わせること 9 出力範囲 - 1 double mapheight 0.5~200 (km) 地図の上端から下端までの距離 指定なし または 0 指定時は自動設定 10 分析地名 - 1 string maptargetname 30 省略した場合 ""( 空文字 ) 11 レポート出力形式 - 1 int reporttype PDF: ( 規定値 ) r4b.maps.reporttypeid.pdf EXCEL : r4b.maps.reporttypeid.excel 12 レポート日付 - 1 string reportdate 10 YYYY/MM/DD 形式 省略した場合 サーバーシステム日付 13 レポートファイル名 - 1 string reportfilename 30 省略した場合 サーバーで自動付与 14 レポートテンプレート ID - 1 int reporttemplateid 省略した場合 デフォルト値使用 6 / 19
[ 第 2 章商圏分析レポート API] 5.API 戻り値 5 API 戻り値 No. 項目 必最大数量型パラメータ名須桁数 値 1 ステータスコード 1 string statuscode API ステータスコード表参照 2 ステータスの内容 1 string statusdescription 3 オーダー ID 1 string orderid 6 API ステータスコード ステータスコード エラー内容 100 成功 200 エラー ( ) です ( ) 内には ブラウザのエラー内容がそのまま表示されます ( 英語 ) 201 接続できません 300 メソッドは許可されていません 301 無効な要求です 400 メンテナンス中のため使用できません 500 必須パラメータがありません 501 パラメータが不正です 502 ユーザー ID またはパスワードが違います 503 分析地の座標は範囲外です 範囲は (left:120 top:46.667 right:155 bottom:19.333) 504 契約期間外です 505 回数制限オーバーです 506 指定したオーダー ID は存在しません 507 以前に作成したレポートが存在しません 508 指定したテンプレート ID は存在しません 590 使用許可がありません 900 その他のエラーです 7 / 19
[ 第 2 章商圏分析レポート API] 7.API 定数 7 API 定数 //AreaType 定数 r4b.maps.areatypeid.circle = 101; r4b.maps.areatypeid.car= 201; r4b.maps.areatypeid.bicycle = 202; r4b.maps.areatypeid.walk = 203; //ReportType 定数 r4b.maps.reporttypeid.pdf = 1; r4b.maps.reporttypeid.excel = 2; 8 / 19
[ 第 3 章商圏分析レポート API 呼出しサンプル集 ] 1. 複数のメールアドレスに送信 ( 最 第 3 章 商圏分析レポート API 呼出しサンプル集 1 複数のメールアドレスに送信 ( 最大 10 アドレスまで ) var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", email: ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng(35.67146684898802, 139.7453052721023), mapareatype: [gsi.maps.areatypeid.circle], mapareasize: [3] ; r4b.maps.ordersimplereport(myoptions, callback); 2 複数の商圏を指定 ( 最大 3 つまで ) var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", email: ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng(35.67146684898802, 139.7453052721023), mapareatype: [r4b.maps.areatypeid.circle, r4b.maps.areatypeid.car], mapareasize: [3,15] ; r4b.maps.ordersimplereport(myoptions, callback); 9 / 19
[ 第 3 章商圏分析レポート API 呼出しサンプル集 ] 3. 出力範囲 ( 地図の上端から下端ま 3 出力範囲 ( 地図の上端から下端までの距離 ) を指定 var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", email: ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng(35.67146684898802, 139.7453052721023), mapareatype: [r4b.maps.areatypeid.circle], mapareasize: [3], mapheight: 20 ; r4b.maps.ordersimplereport(myoptions, callback); 4 分析地名 レポート出力形式 レポート日付 レポートファイル名を指定 function report() { var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", email: ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng(35.67146684898802, 139.7453052721023), mapareatype: [r4b.maps.areatypeid.circle], mapareasize: [3], maptargetname: " 霞が関店 ", reporttype: r4b.maps.reporttypeid.excel, reportdate: "2012/03/06", reportfilename: " 霞が関店商圏分析レポート " ; r4b.maps.ordersimplereport(myoptions, callback); 10 / 19
[ 第 4 章レポート履歴参照 API] 1. 概要 第 4 章 レポート履歴参照 API 1 概要 商圏分析レポート API で作成したレポートの履歴 ( いつ どんなパラメータで作成したか等 ) を参照する API です この履歴には 後述するレポート再送 API の分も含まれます 2 API メソッド r4b.maps.getsimplereportlog(option [,callback]) 3 API パラメータ No. 項目 必最大数量型パラメータ名須桁数 値 1 ユーザー ID 1 string userid 30 半角英数 2 パスワード 1 string password 100 半角英数 3 検索ワード - 1 string searchword 255 全文検索用 (AND 検索なし オーダー結果除く文字列型のみ対象 ) 4 オーダー ID - 1 string orderid 30 5 メールアドレス - 1~10 string email 255 メール形式 6 企業名 - 1 string corporatename 255 文字コード utf-8 以下同様 7 ユーザー用付加情報 - 1~3 string userinfo 255 8 商圏タイプ - 1 int mapareatype 商圏レポート API 参照 9 商圏サイズ - 1 double mapareasize 商圏レポート API 参照 商圏サイズ (From) - 1 double mapareasizefrom 商圏サイズ (To) - 1 double mapareasizeto 10 出力範囲 - 1 double mapheight 商圏レポート API 参照 出力範囲 (From) - 1 double mapheightfrom 出力範囲 (To) - 1 double mapheightto 11 分析地名 - 1 string maptargetname 30 12 レポート出力形式 - 1 int reporttype 商圏レポート API 参照 11 / 19
[ 第 4 章レポート履歴参照 API] 4.API 戻り値 13 レポート日付 - 1 string reportdate 10 YYYY/MM/DD 形式 レポート日付 (From) - 1 string reportdatefrom 10 レポート日付 (To) - 1 string reportdateto 10 14 レポートファイル名 - 1 string reportfilename 30 15 レポートテンプレート ID - 1 int reporttemplateid 15 オーダー日時 - 1 string orderdatetime 19 YYYY/MM/DD hh:mm:ss 形式 オーダー日時 (From) - 1 string orderdatetimefrom 19 オーダー日時 (To) - 1 string orderdatetimeto 19 16 オーダー結果 - 1 string orderresult "OK","NG","MAKING" 検索ワードの検索対象外 17 再送フラグ - 1 bool resendingflag false( 規定 ) true 18 詳細モード - 1 int detailmode 0: 標準 ( 規定 ) 1: 詳細 取得データ表参照 19 取得件数 - 1 int recordnum 指定なしで全件 ( システム上限 500 件 ) 20 ページ番号 - 1 int page 取得件数を指定した場合の 最初の取得データをページ 1 としたページ番号 21 先頭オーダー ID - 1 string firstorderid 30 取得するデータの先頭レコードを固定 ページ遷移時等に使用 22 開始レコード番号 - 1 int startrecord 取得したデータの 最初の 1 データをレコード 1 としたレコード番号 4 API 戻り値 No. 項目 数量 型 パラメータ名 最大桁数 値 1 ステータスコード 1 string statuscode 商圏分析レポート API と同じ 2 ステータスの内容 1 string statusdescription 3 取得データ 1~ logdata 4 取得件数 1 Int recordnum 5 総件数 1 int recordtotal 12 / 19
[ 第 4 章レポート履歴参照 API] 5. 取得データ 5 取得データ No. 項目 数量 型 パラメータ名 最大桁数 値 詳細モード 1 オーダー ID 1 string orderid 30-2 メールアドレス 1~10 string email 255 - メール形式 3 企業名 1 string corporatename 255 - 文字コード utf-8 以下同様 4 ユーザー用付加情報 1~3 string userinfo 255-5 オーダー日時 1 string orderdatetime 19 YYYY/MM/DD hh:mm:ss 形式 - 6 オーダー結果 1 string orderresult "OK","NG","MAKING" - 7 再送フラグ 1 bool resendingflag false true - 8 分析地座標 ( 緯度 経度 ) 1 LatLng mapcenter 9 商圏タイプ 3 int mapareatype 10 商圏サイズ 3 double mapareasize 11 出力範囲 1 double mapheight 12 分析地名 1 string maptargetname 30 13 レポート出力形式 1 int reporttype 14 レポート日付 1 string reportdate 10 YYYY/MM/DD 形式 15 レポートファイル名 1 string reportfilename 30 16 レポートテンプレート ID 1 int reporttemplateid 13 / 19
[ 第 4 章レポート履歴参照 API] 6. 呼出しサンプル 6 呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src="https://report4biz.com/r4b/api/v1/r4bmaps.js" charset="utf-8"></script> <script type="text/javascript"> function reportlog() { var myoptions = { userid と password には 別途 userid: " ユーザー ID を設定 ", ユーザーが取得したものを設定します password: " パスワードを設定 " ; r4b.maps.getsimplereportlog(myoptions, callback); function callback(data) { if (data.statuscode == "100") { var log = ""; for (i=0; i<data.recordnum; i++) { log += "<tr><td>" + data.logdata[i].orderid + "</td><td>" + data.logdata[i].orderdatetime + "</td></tr>"; document.getelementbyid("result").innerhtml = "<table>" + log + "</table>"; alert(data.statuscode + ":" + data.statusdescription); </script> </head> <body><input type="button" value=" レポート履歴参照 " onclick="reportlog()" /><div id="result"></div></body> </html> 14 / 19
[ 第 5 章ジオコーディング API] 1. 概要 第 5 章 ジオコーディング API 1 概要 住所を座標に変換 ( ジオコーディング ) します この座標を商圏分析レポート API のパラメータとして使用します 2 API メソッド r4b.maps.geocoding(option [,callback]) 3 API パラメータ No. 項目 必最大数量型パラメータ名須桁数 値 1 ユーザー ID 1 string userid 30 半角英数 2 パスワード 1 string password 100 半角英数 3 住所 1 string address 50 4 API 戻り値 No. 項目数量型パラメータ名 1 ステータスコード 1 string statuscode 商圏分析レポート API と同じ 2 ステータスの内容 1 string statusdescription 3 取得データ 1~ resultdata 4 残り件数 1 Int remainingcount 使用できる API の残り件数 5 取得データ No. 項目 数量 型 パラメータ名 最大桁数 値 1 座標 1 LatLng coordinates 2 マッチングレベル 1 int matchinglevel マッチングレベル表参照 最大桁数 値 15 / 19
[ 第 5 章ジオコーディング API] 6. マッチングレベル 6 マッチングレベル No. 項目 1 都道府県レベル 2 市区町村レベル 3 町 大字レベル 4 丁目 字レベル 5 番地レベル 6 号レベル 16 / 19
[ 第 5 章ジオコーディング API] 7. 呼出しサンプル 7 呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src="https://report4biz.com/r4b/api/v1/r4bmaps.js" charset="utf-8"></script> <script type="text/javascript"> function geocoding() { var myoptions = { userid と password には 別途 userid: " ユーザー ID を設定 ", ユーザーが取得したものを設定します password: " パスワードを設定 ", address: " 東京都千代田区霞が関 " ; r4b.maps.geocoding(myoptions, callback); function callback(data) { if (data.statuscode == "100") { var log = " 緯度 :" + data.resultdata.coordinates.y + " 経度 :" + data.resultdata.coordinates.x; log += " マッチングレベル :" + data.resultdata.matchinglevel; document.getelementbyid("result").innerhtml = log; alert(data.statuscode + ":" + data.statusdescription); </script> </head> <body><input type="button" value=" ジオコーディング " onclick="geocoding()" /><div id="result"></div></body> </html> 17 / 19
[ 第 6 章レポート再送 API] 1. 概要 第 6 章 レポート再送 API 1 概要 商圏分析レポート API で作成済みのレポートを再送します レポートの内容が変更にならない範囲でパラメータ ( メールの送り先等 ) が指定できます 2 API メソッド r4b.maps.resendreport(option [,callback]) 3 API パラメータ No. 項目 必最大数量型パラメータ名須桁数 値 1 ユーザー ID 1 string userid 30 半角英数 2 パスワード 1 string password 100 半角英数 3 オーダー ID 1 string orderid 30 商圏分析レポート API で返ってきたオーダー ID 4 メールアドレス 1~10 string email 255 メール形式 5 ユーザー用付加情報 - 1~3 string userinfo 255 省略した場合 全て空 6 レポート出力形式 (Excel / PDF) - 1 int reporttype 省略した場合 PDF 形式 7 レポートファイル名 - 1 string address 30 省略した場合 サーバーで自動付与 4 API 戻り値 No. 項目数量型パラメータ名 1 ステータスコード 1 string statuscode 商圏分析レポート API と同じ 2 ステータスの内容 1 string statusdescription 3 再送回数 1~ int resendingcount オーダーごとの再送回数 最大桁数 値 18 / 19
[ 第 6 章レポート再送 API] 5. 呼出しサンプル 5 呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src="https://report4biz.com/r4b/api/v1/r4bmaps.js" charset="utf-8"></script> <script type="text/javascript"> function resend() { var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", orderid: document.getelementbyid("orderid").value, email: ["aaa@bbb.co.jp"] ; r4b.maps.resendreport(myoptions, callback); function callback(data) { alert(data.statuscode + ":" + data.statusdescription); </script> </head> <body> オーダー ID<input type="text" id="orderid"> <input type="button" value=" レポート再送 " onclick="resend()" /> </body> </html> userid と password には 別途 ユーザーが取得したものを設定します また email には 宛先となるメールアド レスを設定します 19 / 19