report for biz 商圏分析レポートAPI ver 1.01 仕様書

Size: px

Start display at page:

Download "report for biz 商圏分析レポートAPI ver 1.01 仕様書"

えみうとだ
7 years ago
Views:

1 report for biz API 仕様書商圏分析レポート API ver1.01 技研商事インターナショナル株式会社作成日 :2011/06/

2 改訂履歴改訂履歴日付バージョン更新内容 2012/06/ 初版 2012/06/ テンプレート ID 追加

3 第 1 章概要本サービスのコンセプト r4b(report 4 biz) とは商圏分析レポート API とはシステム構成... 4 第 2 章商圏分析レポート API リクエスト URL 最小呼出しサンプル API メソッド API パラメータ API 戻り値 API ステータスコード API 定数... 8 第 3 章商圏分析レポート API 呼出しサンプル集複数のメールアドレスに送信 ( 最大 10 アドレスまで ) 複数の商圏を指定 ( 最大 3 つまで ) 出力範囲 ( 地図の上端から下端までの距離 ) を指定分析地名レポート出力形式レポート日付レポートファイル名を指定目次 4 API 戻り値取得データ呼出しサンプル第 5 章ジオコーディング API 概要 API メソッド API パラメータ API 戻り値取得データマッチングレベル呼出しサンプル第 6 章レポート再送 API 概要 API メソッド API パラメータ API 戻り値呼出しサンプル第 4 章レポート履歴参照 API 概要 API メソッド API パラメータ... 11

を高度なノウハウと分析技術により API を介してレポート配信するプラットフォームの総称です 1-2 商圏分析レポート API とは r4b サービスの1つで

4 [ 第 1 章概要 ] 1. 本サービスのコンセプト第 1 章概要 1 本サービスのコンセプト 1-1 r4b(report 4 biz) とは価値のある情報 ( データベース ) を高度なノウハウと分析技術により API を介してレポート配信するプラットフォームの総称です 1-2 商圏分析レポート API とは r4b サービスの1つで利用用途に合わせて地域特性が把握できる様々な商圏分析レポートコンテンツを配信します 2 システム構成 JSON r4b サーバー商圏分析レポート API JSON JSON:JavaScript Object Notation JavaScript のオブジェクトに変換できるテキストベースのデータフォーマット 4 / 19

[ 第 2 章商圏分析レポート API] 1. リクエスト URL 第 2 章商圏分析レポート API 1 リクエスト URL https://report4biz.com/r4b/api/v1/r4bmaps.js 2 最小呼出しサンプル <!

5 [ 第 2 章商圏分析レポート API] 1. リクエスト URL 第 2 章商圏分析レポート API 1 リクエスト URL 2 最小呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src=" charset="utf-8"></script> <script type="text/javascript"> function report() { var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", ["aaa@bbb.co.jp"], mapcenter: new r4b.maps.latlng( , ), 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 には別途ユーザーが取得したものを設定しますまたには宛先となるメールアドレスを設定します 5 / 19

6 [ 第 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 255 メール形式 4 企業名 - 1 string corporatename 255 文字コード utf-8 以下同様 5 ユーザー用付加情報 - 1~3 string userinfo 分析地座標 ( 緯度経度 ) 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

7 [ 第 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: right:155 bottom:19.333) 504 契約期間外です 505 回数制限オーバーです 506 指定したオーダー ID は存在しません 507 以前に作成したレポートが存在しません 508 指定したテンプレート ID は存在しません 590 使用許可がありません 900 その他のエラーです 7 / 19

8 [ 第 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

9 [ 第 3 章商圏分析レポート API 呼出しサンプル集 ] 1. 複数のメールアドレスに送信 ( 最第 3 章商圏分析レポート API 呼出しサンプル集 1 複数のメールアドレスに送信 ( 最大 10 アドレスまで ) var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng( , ), mapareatype: [gsi.maps.areatypeid.circle], mapareasize: [3] ; r4b.maps.ordersimplereport(myoptions, callback); 2 複数の商圏を指定 ( 最大 3 つまで ) var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng( , ), mapareatype: [r4b.maps.areatypeid.circle, r4b.maps.areatypeid.car], mapareasize: [3,15] ; r4b.maps.ordersimplereport(myoptions, callback); 9 / 19

10 [ 第 3 章商圏分析レポート API 呼出しサンプル集 ] 3. 出力範囲 ( 地図の上端から下端ま 3 出力範囲 ( 地図の上端から下端までの距離 ) を指定 var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng( , ), mapareatype: [r4b.maps.areatypeid.circle], mapareasize: [3], mapheight: 20 ; r4b.maps.ordersimplereport(myoptions, callback); 4 分析地名レポート出力形式レポート日付レポートファイル名を指定 function report() { var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", ["aaa@bbb.co.jp","ccc@ddd.co.jp"], mapcenter: new r4b.maps.latlng( , ), 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

11 [ 第 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 255 メール形式 6 企業名 - 1 string corporatename 255 文字コード utf-8 以下同様 7 ユーザー用付加情報 - 1~3 string userinfo 商圏タイプ - 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 レポート出力形式 - 1 int reporttype 商圏レポート API 参照 11 / 19

12 [ 第 4 章レポート履歴参照 API] 4.API 戻り値 13 レポート日付 - 1 string reportdate 10 YYYY/MM/DD 形式レポート日付 (From) - 1 string reportdatefrom 10 レポート日付 (To) - 1 string reportdateto レポートファイル名 - 1 string reportfilename レポートテンプレート ID - 1 int reporttemplateid 15 オーダー日時 - 1 string orderdatetime 19 YYYY/MM/DD hh:mm:ss 形式オーダー日時 (From) - 1 string orderdatetimefrom 19 オーダー日時 (To) - 1 string orderdatetimeto オーダー結果 - 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

13 [ 第 4 章レポート履歴参照 API] 5. 取得データ 5 取得データ No. 項目数量型パラメータ名最大桁数値詳細モード 1 オーダー ID 1 string orderid 30-2 メールアドレス 1~10 string メール形式 3 企業名 1 string corporatename 文字コード utf-8 以下同様 4 ユーザー用付加情報 1~3 string userinfo オーダー日時 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 レポート出力形式 1 int reporttype 14 レポート日付 1 string reportdate 10 YYYY/MM/DD 形式 15 レポートファイル名 1 string reportfilename レポートテンプレート ID 1 int reporttemplateid 13 / 19

14 [ 第 4 章レポート履歴参照 API] 6. 呼出しサンプル 6 呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src=" 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

15 [ 第 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

16 [ 第 5 章ジオコーディング API] 6. マッチングレベル 6 マッチングレベル No. 項目 1 都道府県レベル 2 市区町村レベル 3 町大字レベル 4 丁目字レベル 5 番地レベル 6 号レベル 16 / 19

17 [ 第 5 章ジオコーディング API] 7. 呼出しサンプル 7 呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src=" 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

18 [ 第 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 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

19 [ 第 6 章レポート再送 API] 5. 呼出しサンプル 5 呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src=" charset="utf-8"></script> <script type="text/javascript"> function resend() { var myoptions = { userid: " ユーザー ID を設定 ", password: " パスワードを設定 ", orderid: document.getelementbyid("orderid").value, ["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 には別途ユーザーが取得したものを設定しますまたには宛先となるメールアドレスを設定します 19 / 19

report for biz 顧客分析レポートAPI ver 1.00 仕様書

report for biz 顧客分析レポートAPI ver 1.00 仕様書 report for biz API 仕様書顧客分析レポート API ver1.00 技研商事インターナショナル株式会社作成日 :2015/06/24 改訂履歴改訂履歴日付バージョン更新内容 2015/06/24 1.00 初版第 1 章概要... 4 1 本サービスのコンセプト... 4 1-1 r4b(report 4 biz)とは...