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

Size: px

Start display at page:

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

ようじろうたけはな
7 years ago
Views:

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

2 改訂履歴改訂履歴日付バージョン更新内容 2015/06/ 初版

3 第 1 章概要本サービスのコンセプト r4b(report 4 biz)とは顧客分析レポート API とはシステム構成... 4 第 2 章顧客分析レポート API リクエスト URL 最小呼出しサンプル API メソッド API パラメータ API 戻り値... 7 目次 3 API パラメータ API 戻り値取得データ呼出しサンプル第 5 章レポート再送 API 概要 API メソッド API パラメータ API 戻り値呼出しサンプル API ステータスコード API 定数... 8 第 3 章顧客分析レポート API 呼出しサンプル集顧客集計データタイトル単位を指定統計データを指定地図の表示範囲を指定分析地名レポート出力形式レポート日付レポートファイル名を指定分類方法分類数値レンジ設定を指定第 4 章レポート履歴参照 API 概要 API メソッド... 12

してレポート配信するプラットフォームの総称です 1-2 顧客分析レポート API とは r4b サービスの1つでユーザーの集計データを使用した分析レポートコンテンツを作成します ( 集計

4 [ 第 1 章概要 ] 1. 本サービスのコンセプト第 1 章概要 1 本サービスのコンセプト 1-1 r4b(report 4 biz)とは価値のある情報 (データベース)を高度なノウハウと分析技術により API を介してレポート配信するプラットフォームの総称です 1-2 顧客分析レポート API とは r4b サービスの1つでユーザーの集計データを使用した分析レポートコンテンツを作成します ( 集計データの単位には郵便番号界を使用 ) 2 システム構成郵便番号集計値 JSON(ステータス) JSON r4b サーバー顧客分析レポート API JSON:JavaScript Object Notation JavaScript のオブジェクトに変換できるテキストベースのデータフォーマット 4 / 17

[ 第 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"], pointdata: [{Key: " ", Value: "120"}, {Key: " ", Value: "85"}, {Key: " ", Value: "132"}] }; r4b.maps.report.orderpointreport(myoptions, callback); } function callback(data) { alert(data.statuscode + ":" + data.statusdescription); } </script> </head> <body><input type="button" value="レポート作成 " onclick="report()" /></body> </html> userid と password には別途ユーザーが取得したものを設定しますまたには宛先となるメールアドレスを設定します 5 / 17

6 [ 第 2 章顧客分析レポート API] 3.API メソッド 3 API メソッド r4b.maps.report.orderpointreport(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 int reporttype - PDF: ( 規定値 ) r4b.maps.reporttypeid.pdf EXCEL : r4b.maps.reporttypeid.excel 7 レポート日付 - 1 string reportdate 10 YYYY/MM/DD 形式省略した場合サーバーシステム日付 8 レポートファイル名 - 1 string reportfilename 30 省略した場合サーバーで自動付与 9 レポートテンプレート ID - 1 int reporttemplateid - 省略した場合デフォルト値使用 10 顧客集計データ 1 object[] pointdata - 最大件数は 2000 件 11 顧客集計データタイトル - 1 string title 30 省略した場合は" 顧客集計データ" 12 顧客集計データ単位 - 1 string unit 30 ( 人 )や( 件 )などを指定 13 統計データ - 1 string statdataname 255 下記の 13 項目より指定人口総数 10(Z14 男性人口 10(Z14 女性人口 10(Z14 世帯数 10(Z14 人口 (15 歳未満 )10(Z14 人口 (15-64 歳 )10(Z14 人口 (65 歳以上 )10(Z14 男性人口 (15 歳未満 )10(Z14 男性人口 (15-64 歳 )10(Z14 男性人口 (65 歳以上 )10(Z14 女性人口 (15 歳未満 )10(Z14 女性人口 (15-64 歳 )10(Z14 女性人口 (65 歳以上 )10(Z14 6 / 17

7 [ 第 2 章顧客分析レポート API] 5.API 戻り値 14 地図の表示範囲 - 1 LatLng[] mapdisplayarea - LatLng[0]: 北西 LatLng[1]: 南東北西と南東の 2 点の座標 ( 世界測地系 )を指定 15 集計データの分類方法 - 1 int methodsimple - 等しい値レンジ: ( 規定値 ) r4b.maps.classifytypeid.byvalues 等しいクラスカウント: r4b.maps.classifytypeid.bycounts 値レンジ設定 : r4b.maps.classifytypeid.setvalues 16 集計データの分類数 - 1 int numclassessimple - 有効値 :1~10 値レンジ設定の場合レンジ数を優先 17 集計データの値レンジ - 1 double[] rangesimple - 10 レンジまで有効 ( 要素数は 11) 例えば分類数 4 の場合の値レンジは以下の様に設定する 0, 10, 20, 30, 40 (5 要素 ) この場合の 4 レンジとなる 18 クロス色塗りの分類方法 1-1 int methodcross1 - 集計データの分類方法と同じ 19 クロス色塗りの値レンジ 1-1 double[] rangecross1-3 レンジのみ有効 ( 要素数は 4) 20 クロス色塗りの分類方法 2-1 int methodcross2 - 集計データの分類方法と同じ 21 クロス色塗りの値レンジ 2-1 double[] rangecross2-3 レンジのみ有効 ( 要素数は 4) 22 シェア率色塗りの分類方法 - 1 int methodshare - 集計データの分類方法と同じ 23 シェア率色塗りの分類数 - 1 int numclassesshare - 有効値 :1~10 24 シェア率色塗りの値レンジ - 1 double[] rangeshare - 10 レンジまで有効 ( 要素数は 11) 5 API 戻り値 No. 項目必最大数量型パラメータ名須桁数値備考 1 ステータスコード 1 string statuscode API ステータスコード表 ( 次項 ) 参照 2 ステータスの内容 1 string statusdescription 3 オーダーID 1 string orderid 7 / 17

8 [ 第 2 章顧客分析レポート API] 6.API ステータスコード 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 は存在しません 509 集計データの件数が不正です 510 地図の表示範囲の座標が範囲外です範囲は(left:120 top: right:155 bottom:19.333) 511 値レンジ設定が正しくありません 590 使用許可がありません 600 指定された統計項目が存在しません 900 その他のエラーです 7 API 定数 //レポート出力形式定数 r4b.maps.reporttypeid.pdf = 1; r4b.maps.reporttypeid.excel = 2; // 分類方法定数 r4b.maps.classifytypeid.byvalues = 1; r4b.maps.classifytypeid.bycounts = 2; r4b.maps.classifytypeid.setvalues = 4; 8 / 17

9 [ 第 3 章顧客分析レポート API 呼出しサンプル集 ] 1. 顧客集計データタイトル単位を第 3 章顧客分析レポート API 呼出しサンプル集 1 顧客集計データタイトル単位を指定 var myoptions = { userid: "ユーザーID を設定 ", password: "パスワードを設定 ", ["aaa@bbb.co.jp"], pointdata: [{Key: " ", Value: "120"}, {Key: " ", Value: "85"}, {Key: " ", Value: "132"}], title: "レスポンス", unit: "( 人 )" }; r4b.maps.report.orderpointreport(myoptions, callback); 2 統計データを指定顧客集計データとのクロス色塗りやシェア率色塗りに使用されます var myoptions = { userid: "ユーザーID を設定 ", password: "パスワードを設定 ", ["aaa@bbb.co.jp"], pointdata: [{Key: " ", Value: "120"}, {Key: " ", Value: "85"}, {Key: " ", Value: "132"}], statdataname: " 人口総数 10(Z14" }; r4b.maps.report.orderpointreport(myoptions, callback); 9 / 17

10 [ 第 3 章顧客分析レポート API 呼出しサンプル集 ] 3. 地図の表示範囲を指定 3 地図の表示範囲を指定 var myoptions = { userid: "ユーザーID を設定 ", password: "パスワードを設定 ", ["aaa@bbb.co.jp"], pointdata: [{Key: " ", Value: "120"}, {Key: " ", Value: "85"}, {Key: " ", Value: "132"}], mapdisplayarea: [ new r4b.maps.latlng( , ), new r4b.maps.latlng( , ) ] }; r4b.maps.report.orderpointreport(myoptions, callback); 4 分析地名レポート出力形式レポート日付レポートファイル名を指定 var myoptions = { userid: "ユーザーID を設定 ", password: "パスワードを設定 ", ["aaa@bbb.co.jp","ccc@ddd.co.jp"], pointdata: [{Key: " ", Value: "120"}, {Key: " ", Value: "85"}, {Key: " ", Value: "132"}], reporttype: r4b.maps.reporttypeid.excel, reportdate: "2015/06/22", reportfilename: " 池袋店顧客分析レポート" }; r4b.maps.report.orderpointreport(myoptions, callback); 10 / 17

[ 第 3 章顧客分析レポート API 呼出しサンプル集 ] 5. 分類方法分類数値レンジ設定 5 分類方法分類数値レンジ設定を指定 var myoptions = { userid: "ユーザーID を設定 ", password: "パスワードを設定 ", email: ["aaa@bbb.co.jp","ccc@ddd.

classifytypeid.byvalues, methodcross2: r4b.maps.classifytypeid.bycounts, methodshare: r4b.maps.classifytypeid.setvalues, rangeshare: [0, 10, 20, 30] }; r4b.maps.ordersimplereport(myoptions, callback); 等しい値レンジ (r4b.

11 [ 第 3 章顧客分析レポート API 呼出しサンプル集 ] 5. 分類方法分類数値レンジ設定 5 分類方法分類数値レンジ設定を指定 var myoptions = { userid: "ユーザーID を設定 ", password: "パスワードを設定 ", ["aaa@bbb.co.jp","ccc@ddd.co.jp"], pointdata: [{Key: " ", Value: "120"}, {Key: " ", Value: "85"}, {Key: " ", Value: "132"}], statdataname: " 人口総数 10(Z14", numclassessimple: 3, methodcross1: r4b.maps.classifytypeid.byvalues, methodcross2: r4b.maps.classifytypeid.bycounts, methodshare: r4b.maps.classifytypeid.setvalues, rangeshare: [0, 10, 20, 30] }; r4b.maps.ordersimplereport(myoptions, callback); 等しい値レンジ (r4b.maps.classifytypeid.byvalues) 等しいクラスカウント (r4b.maps.classifytypeid.bycounts) 値レンジ設定 (r4b.maps.classifytypeid.setvalues) 分類数最小値と最大値の間を分類数で各レンジの件数がほぼ均等に各レンジを任意に設定できま設定した分類方法分類数で均等に分類しますなるように分類しますす地図が色塗りされます 11 / 17

12 [ 第 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 reporttype - 顧客分析レポート API 参照 9 レポート日付 - 1 string reportdate 10 YYYY/MM/DD 形式レポート日付 (From) - 1 string reportdatefrom 10 レポート日付 (To) - 1 string reportdateto レポートファイル名 - 1 string reportfilename レポートテンプレート ID - 1 int reporttemplateid - 12 オーダー日時 - 1 string orderdatetime 19 YYYY/MM/DD hh:mm:ss 形式オーダー日時 (From) - 1 string orderdatetimefrom 19 オーダー日時 (To) - 1 string orderdatetimeto / 17

13 [ 第 4 章レポート履歴参照 API] 4.API 戻り値 13 オーダー結果 - 1 string orderresult - "OK","NG","MAKING" 検索ワードの検索対象外 14 再送フラグ - 1 bool resendingflag - false( 規定 ) true 15 詳細モード - 1 int detailmode - 0: 標準 ( 規定 ) 1: 詳細取得データ表参照 16 取得件数 - 1 int recordnum - 指定なしで全件 (システム上限 500 件 ) 17 ページ番号 - 1 int page - 取得件数を指定した場合の最初の取得データをページ 1 としたページ番号 18 先頭オーダーID - 1 string firstorderid 30 取得するデータの先頭レコードを固定ページ遷移時等に使用 19 開始レコード番号 - 1 int startrecord - 取得したデータの最初の 1 データをレコード 1 としたレコード番号 20 API 番号 - 1 int apiserialno - 4 API 戻り値 No. 項目数量型パラメータ名最大桁数値備考 1 ステータスコード 1 string statuscode 顧客分析レポート API と同じ 2 ステータスの内容 1 string statusdescription 3 取得データ 1~ logdata 4 取得件数 1 Int recordnum 5 総件数 1 int recordtotal 13 / 17

14 [ 第 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 30 商圏分析レポートで使用 13 レポート出力形式 1 int reporttype - 14 レポート日付 1 string reportdate 10 YYYY/MM/DD 形式 15 レポートファイル名 1 string reportfilename レポートテンプレート ID 1 Int reporttemplateid - 17 レポート名称 1 string reportname 255 顧客分析レポート等 18 API 番号 1 Int apiserialno - 1: 商圏分析レポート 9: 顧客分析レポート 19 顧客集計データタイトル 1 string title 顧客集計データ単位 1 string unit 統計データ 1 string statdataname 地図の表示範囲 1 LatLng[] mapdisplayarea - 23 集計データの分類方法 1 int methodsimple - 24 集計データの分類数 1 int numclassessimple - 25 集計データの値レンジ 1 double[] rangesimple - 26 クロス色塗りの分類方法 1 1 int methodcross1-27 クロス色塗りの値レンジ 1 1 double[] rangecross1-28 クロス色塗りの分類方法 2 1 int methodcross2-29 クロス色塗りの値レンジ 2 1 double[] rangecross2-30 シェア率色塗りの分類方法 1 int methodshare - 31 シェア率色塗りの分類数 1 int numclassesshare - 32 シェア率色塗りの値レンジ 1 double[] rangeshare - 14 / 17

[ 第 4 章レポート履歴参照 API] 6. 呼出しサンプル 6 呼出しサンプル <!DOCTYPE html> <html> <head> <script type="text/javascript" src="https://report4biz.com/r4b/api/v1/r4bmaps.

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

16 [ 第 5 章レポート再送 API] 1. 概要第 5 章レポート再送 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 オーダーごとの再送回数 16 / 17

17 [ 第 5 章レポート再送 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 には別途ユーザーが取得したものを設定しますまたには宛先となるメールアドレスを設定します 17 / 17

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

report for biz 商圏分析レポートAPI ver 1.01 仕様書 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)