report for biz API 仕様書
顧客分析レポート API ver1.00
技研商事インターナショナル株式会社
作成日:2015/06/24report for biz 顧客分析レポート API ver 1.00 仕様書
改訂履歴
改訂履歴
日付 バージョン 更新内容
report for biz 顧客分析レポート API ver 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 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 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 呼出しサンプル ... 17report for biz 顧客分析レポート API ver 1.00 仕様書
[第 1 章 概要] 1.本サービスのコンセプト
第1章 概要
1 本サービスのコンセプト
1-1 r4b(report 4 biz)とは
価値のある情報(データベース)を高度なノウハウと分析技術により、API を介してレポート配信するプラットフォームの総称です。
1-2 顧客分析レポート API とは
r4b サービスの1つで、ユーザーの集計データを使用した分析レポートコンテンツを作成します。(集計データの単位には郵便番号界を使用)
2 システム構成
r4b サーバー
・顧客分析レポート API JSON JSON(ステータス) E-mail※JSON:JavaScript Object Notation
JavaScript のオブジェクトに変換できる
テキストベースのデータフォーマット
郵便番号 集計値 1710021 120 1710022 85 1710031 132report for biz 顧客分析レポート API ver 1.00 仕様書
[第 2 章 顧客分析レポート API] 1.リクエスト URL
第2章 顧客分析レポート API
1 リクエスト URL
2 最小呼出しサンプル
https://report4biz.com/r4b/api/v1/r4bmaps.js
<!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: ["[email protected]"],
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 には、宛先となるメールアド レスを設定します。
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 2 章 顧客分析レポート API] 3.API メソッド
3 API メソッド
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
r4b.maps.Report.orderPointReport(option [,callback])
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 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
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 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;
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 3 章 顧客分析レポート API 呼出しサンプル集] 1.顧客集計データタイトル、単位を
第3章 顧客分析レポート API 呼出しサンプル集
1 顧客集計データタイトル、単位を指定
2 統計データを指定
※顧客集計データとのクロス色塗りやシェア率色塗りに使用されます。
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]"],
pointData: [{Key: "1710021", Value: "120"},
{Key: "1710022", Value: "85"},
{Key: "1710031", Value: "132"}],
title: "レスポンス",
unit: "(人)"
};
r4b.maps.Report.orderPointReport(myOptions, callback);
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]"],
pointData: [{Key: "1710021", Value: "120"},
{Key: "1710022", Value: "85"},
{Key: "1710031", Value: "132"}],
statDataName: "人口総数 10(Z14"
};
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 3 章 顧客分析レポート API 呼出しサンプル集] 3.地図の表示範囲を指定
3 地図の表示範囲を指定
4 分析地名、レポート出力形式、レポート日付、レポートファイル名を指定
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]"],
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);
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]","[email protected]"],
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);
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 3 章 顧客分析レポート API 呼出しサンプル集] 5.分類方法、分類数、値レンジ設定
5 分類方法、分類数、値レンジ設定を指定
等しい値レンジ
(r4b.maps.ClassifyTypeID.ByValues)等しいクラスカウント
(r4b.maps.ClassifyTypeID.ByCounts)値レンジ設定
(r4b.maps.ClassifyTypeID.SetValues) 分類数 最小値と最大値の間を分類数で 均等に分類します。 各レンジの件数がほぼ均等に なるように分類します。 各レンジを任意に設定できま す。 設定した分類方法、分類数で 地図が色塗りされます。var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]","[email protected]"],
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);
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 4 章 レポート履歴参照 API] 1.概要
第4章 レポート履歴参照 API
1 概要
顧客分析レポート API で作成したレポートの履歴(いつ、どんなパラメータで作成したか等)を参照する API です。この履歴には、後述するレポート再送
API の分も含まれます。
2 API メソッド
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
r4b.maps.getSimpleReportLog(option [,callback])
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 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
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 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 - ○
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 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: "ユーザー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>
userID と password には、別途 ユーザーが取得したものを設定します。
report for biz 顧客分析レポート API ver 1.00 仕様書
[第 5 章 レポート再送 API] 1.概要
第5章 レポート再送 API
1 概要
顧客分析レポート API で作成済みのレポートを再送します。レポートの内容が変更にならない範囲でパラメータ(メールの送り先等)が指定できます。
2 API メソッド
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 オーダーごとの再送回数