report for biz API 仕様書
商圏分析レポート API ver1.01
技研商事インターナショナル株式会社
report for biz 商圏分析レポート API ver 1.01 仕様書
改訂履歴改訂履歴
日付 バージョン 更新内容
2012/06/01 1.00 初版
report for biz 商圏分析レポート API ver 1.01 仕様書
目次 第 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 ... 11 1 概要 ... 11 2 API メソッド ... 11 3 API パラメータ ... 11 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
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 1 章 概要] 1.本サービスのコンセプト第1章 概要
1 本サービスのコンセプト
1-1 r4b（report 4 biz）とは
価値のある情報（データベース）を高度なノウハウと分析技術により、API を介してレポート配信するプラットフォームの総称です。1-2 商圏分析レポート API とは
r4b サービスの１つで、利用用途に合わせて地域特性が把握できる、様々な商圏分析レポートコンテンツを配信します。2 システム構成
r4b サーバー
・商圏分析レポート API JSON JSONE-mail ※JSON：JavaScript Object Notation
JavaScript のオブジェクトに変換できる テキストベースのデータフォーマット
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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]"],
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 には、宛先となるメールアド レスを設定します。
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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 対 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 省略した場合、デフォルト値使用
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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 その他のエラーです。
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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;
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 3 章 商圏分析レポート API 呼出しサンプル集] 1.複数のメールアドレスに送信（最第3章 商圏分析レポート API 呼出しサンプル集
1 複数のメールアドレスに送信（最大 10 アドレスまで）
2 複数の商圏を指定（最大 3 つまで）
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]","[email protected]"],
mapCenter: new r4b.maps.LatLng(35.67146684898802, 139.7453052721023),
mapAreaType: [gsi.maps.AreaTypeID.CIRCLE],
mapAreaSize: [3]
};
r4b.maps.orderSimpleReport(myOptions, callback);
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]","[email protected]"],
mapCenter: new r4b.maps.LatLng(35.67146684898802, 139.7453052721023),
mapAreaType: [r4b.maps.AreaTypeID.CIRCLE, r4b.maps.AreaTypeID.CAR],
mapAreaSize: [3,15]
};
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 3 章 商圏分析レポート API 呼出しサンプル集] 3.出力範囲（地図の上端から下端ま3
出力範囲（地図の上端から下端までの距離）を指定
4 分析地名、レポート出力形式、レポート日付、レポートファイル名を指定
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]","[email protected]"],
mapCenter: new r4b.maps.LatLng(35.67146684898802, 139.7453052721023),
mapAreaType: [r4b.maps.AreaTypeID.CIRCLE],
mapAreaSize: [3],
mapHeight: 20
};
r4b.maps.orderSimpleReport(myOptions, callback);
function report() {
var myOptions = {
userID: "ユーザーID を設定",
password: "パスワードを設定",
email: ["[email protected]","[email protected]"],
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);
}
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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 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 参照
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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 ○
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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.01 仕様書
[第 5 章 ジオコーディング API] 1.概要第5章 ジオコーディング API
1 概要
住所を座標に変換（ジオコーディング）します。この座標を商圏分析レポート API のパラメータとして使用します。2 API メソッド
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
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 5 章 ジオコーディング API] 6.マッチングレベル6 マッチングレベル
No. 項目 1 都道府県レベル 2 市区町村レベル 3 町、大字レベル 4 丁目、字レベル 5 番地レベル 6 号レベル
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 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: "ユーザー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>
userID と password には、別途 ユーザーが取得したものを設定します。
report for biz 商圏分析レポート API ver 1.01 仕様書
[第 6 章 レポート再送 API] 1.概要第6章 レポート再送 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 resendingCounｔ オーダーごとの再送回数
