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)とは... 4 1-2 顧 客 分 析 レポート API とは... 4 2 システム 構 成... 4 第 2 章 顧 客 分 析 レポート API... 5 1 リクエスト URL... 5 2 最 小 呼 出 しサンプル... 5 3 API メソッド... 6 4 API パラメータ... 6 5 API 戻 り 値... 7 目 次 3 API パラメータ... 12 4 API 戻 り 値... 13 5 取 得 データ... 14 6 呼 出 しサンプル... 15 第 5 章 レポート 再 送 API... 16 1 概 要... 16 2 API メソッド... 16 3 API パラメータ... 16 4 API 戻 り 値... 16 5 呼 出 しサンプル... 17 6 API ステータスコード... 8 7 API 定 数... 8 第 3 章 顧 客 分 析 レポート API 呼 出 しサンプル 集... 9 1 顧 客 集 計 データタイトル 単 位 を 指 定... 9 2 統 計 データを 指 定... 9 3 地 図 の 表 示 範 囲 を 指 定... 10 4 分 析 地 名 レポート 出 力 形 式 レポート 日 付 レポートファイル 名 を 指 定... 10 5 分 類 方 法 分 類 数 値 レンジ 設 定 を 指 定... 11 第 4 章 レポート 履 歴 参 照 API... 12 1 概 要... 12 2 API メソッド... 12
[ 第 1 章 概 要 ] 1. 本 サービスのコンセプト 第 1 章 概 要 1 本 サービスのコンセプト 1-1 r4b(report 4 biz)とは 価 値 のある 情 報 (データベース)を 高 度 なノウハウと 分 析 技 術 により API を 介 してレポート 配 信 するプラットフォームの 総 称 です 1-2 顧 客 分 析 レポート API とは r4b サービスの1つで ユーザーの 集 計 データを 使 用 した 分 析 レポートコンテンツを 作 成 します ( 集 計 データの 単 位 には 郵 便 番 号 界 を 使 用 ) 2 システム 構 成 郵 便 番 号 集 計 値 1710021 120 1710022 85 1710031 132 JSON(ステータス) JSON r4b サーバー 顧 客 分 析 レポート API E-mail JSON:JavaScript Object Notation JavaScript のオブジェクトに 変 換 できる テキストベースのデータフォーマット 4 / 17
[ 第 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"], pointdata: [{Key: "1710021", Value: "120"}, {Key: "1710022", Value: "85"}, {Key: "1710031", 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 には 別 途 ユーザーが 取 得 したものを 設 定 します また email には 宛 先 となるメールアド レスを 設 定 します 5 / 17
[ 第 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 email 255 メール 形 式 4 企 業 名 - 1 string corporatename 255 文 字 コード utf-8 以 下 同 様 5 ユーザー 用 付 加 情 報 - 1~3 string userinfo 255 6 レポート 出 力 形 式 - 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
[ 第 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 要 素 ) この 場 合 0-10 10-20 20-30 30-40 の 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
[ 第 2 章 顧 客 分 析 レポート API] 6.API ステータスコード 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 は 存 在 しません 509 集 計 データの 件 数 が 不 正 です 510 地 図 の 表 示 範 囲 の 座 標 が 範 囲 外 です 範 囲 は(left:120 top:46.667 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
[ 第 3 章 顧 客 分 析 レポート API 呼 出 しサンプル 集 ] 1. 顧 客 集 計 データタイトル 単 位 を 第 3 章 顧 客 分 析 レポート API 呼 出 しサンプル 集 1 顧 客 集 計 データタイトル 単 位 を 指 定 var myoptions = { userid: "ユーザーID を 設 定 ", password: "パスワードを 設 定 ", email: ["aaa@bbb.co.jp"], pointdata: [{Key: "1710021", Value: "120"}, {Key: "1710022", Value: "85"}, {Key: "1710031", Value: "132"}], title: "レスポンス", unit: "( 人 )" }; r4b.maps.report.orderpointreport(myoptions, callback); 2 統 計 データを 指 定 顧 客 集 計 データとのクロス 色 塗 りやシェア 率 色 塗 りに 使 用 されます var myoptions = { userid: "ユーザーID を 設 定 ", password: "パスワードを 設 定 ", email: ["aaa@bbb.co.jp"], pointdata: [{Key: "1710021", Value: "120"}, {Key: "1710022", Value: "85"}, {Key: "1710031", Value: "132"}], statdataname: " 人 口 総 数 10(Z14" }; r4b.maps.report.orderpointreport(myoptions, callback); 9 / 17
[ 第 3 章 顧 客 分 析 レポート API 呼 出 しサンプル 集 ] 3. 地 図 の 表 示 範 囲 を 指 定 3 地 図 の 表 示 範 囲 を 指 定 var myoptions = { userid: "ユーザーID を 設 定 ", password: "パスワードを 設 定 ", email: ["aaa@bbb.co.jp"], pointdata: [{Key: "1710021", Value: "120"}, {Key: "1710022", Value: "85"}, {Key: "1710031", Value: "132"}], mapdisplayarea: [ new r4b.maps.latlng(35.73032, 139.69739), new r4b.maps.latlng(35.71750, 139.72017) ] }; r4b.maps.report.orderpointreport(myoptions, callback); 4 分 析 地 名 レポート 出 力 形 式 レポート 日 付 レポートファイル 名 を 指 定 var myoptions = { userid: "ユーザーID を 設 定 ", password: "パスワードを 設 定 ", email: ["aaa@bbb.co.jp","ccc@ddd.co.jp"], pointdata: [{Key: "1710021", Value: "120"}, {Key: "1710022", Value: "85"}, {Key: "1710031", 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.co.jp"], pointdata: [{Key: "1710021", Value: "120"}, {Key: "1710022", Value: "85"}, {Key: "1710031", 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
[ 第 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 reporttype - 顧 客 分 析 レポート API 参 照 9 レポート 日 付 - 1 string reportdate 10 YYYY/MM/DD 形 式 レポート 日 付 (From) - 1 string reportdatefrom 10 レポート 日 付 (To) - 1 string reportdateto 10 10 レポートファイル 名 - 1 string reportfilename 30 11 レポートテンプレート ID - 1 int reporttemplateid - 12 オーダー 日 時 - 1 string orderdatetime 19 YYYY/MM/DD hh:mm:ss 形 式 オーダー 日 時 (From) - 1 string orderdatetimefrom 19 オーダー 日 時 (To) - 1 string orderdatetimeto 19 12 / 17
[ 第 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
[ 第 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 - 17 レポート 名 称 1 string reportname 255 顧 客 分 析 レポート 等 18 API 番 号 1 Int apiserialno - 1: 商 圏 分 析 レポート 9: 顧 客 分 析 レポート 19 顧 客 集 計 データタイトル 1 string title 30 20 顧 客 集 計 データ 単 位 1 string unit 30 21 統 計 データ 1 string statdataname 255 22 地 図 の 表 示 範 囲 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.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> 15 / 17
[ 第 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 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 オーダーごとの 再 送 回 数 16 / 17
[ 第 5 章 レポート 再 送 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 には 宛 先 となるメールアド レスを 設 定 します 17 / 17