Batch Geocoder API 開発者ガイド

入力データ

バッチ ジオコーディング要求の入力データは、ジオコード化する住所で構成されます。リバース バッチ ジオコーディングの入力データは、WGS-84準拠の緯度および経度の地理座標で定義された一連の場所と、各位置を中心とした半径で定義される場所です。

データサイズの上限

すべての入力データは、次の規則に従う必要があります。

  • ジオ コーディングまたは リバース ジオ コーディング用に送信された行数は、 1,000,000 行に制限されています ( ヘッダーは除く )
  • 最大リクエストサイズは、非圧縮の 2GB に制限されています

これらの制限を超える要求はエラーを発生させ、アドレスまたは場所は処理されません。

入力データは区切り記号付きファイル形式で入力する必要があります。 フィールドの区切り文字は、次のいずれかの文字にすることができます。
  • | ( パイプ、 URL エンコード : %7C)
  • ; ( セミコロン、 URL エンコード : %3B)
  • : ( コロン、 URL エンコード : %3A)
  • , ( コンマ、 URL エンコード : %2C)
  • \t (TAB 、 URL エンコード : %5ct)

バッチ ジオ コーディング入力データ

Geocoder API と同様に、アドレスデータも構造化(修飾)または非構造化( freeform )にできます。 区切り文字として "|" を使用する国コード修飾子を持つ自由形式のアドレスを持つ入力ファイルの例を次に示します。 1 行目は、入力ファイルの列の名前を一覧表示するヘッダーです。

recId|searchText|country 
1|425 W Randolph St, Chicago Illinois 60606|USA 
2|31 St James Ave Boston MA 02116|USA 
3|10115 Berlin Invalidenstrasse 117|DEU
次に、完全修飾形式の同じアドレスの例を示します。
recId|street|city|postalCode|country 
1|425 Randolph St|Chicago||USA 
2|31 St James Ave|Boston|02116|USA 
3|Invalidenstrasse 117|Berlin|10115|DEU
recId は任意です。 指定されている場合は、出力内で参照のために繰り返されます。 データに区切り文字が含まれている場合は、データを二重引用符で囲む必要があります。 次の例は、区切り文字がコンマで、入力にコンマが含まれている場合を示しています。
recId,searchText,country 
1,"Sturmstraße 8, 80687 München", DEU 
2,"Milano", ITA 
3,"Rom", ITA 
4,"Tecklenburger Straße, Westerkappeln 49492", DEU 
5,"425 W Randolph St Chicago, Illinois, 60606", USA

入力行ごとに 1 つの二重引用符 (") が通常の文字と見なされます。 次の例は、正しい入力行を示しています。

recId,searchText,country 
1,O"Farell St San Francisco,USA

これに対して、以下に示す例は無効です。 エンド見積もりがないため、サービスが必要とする入力行ごとに 3 つのフィールドの代わりに 4 つのフィールドが作成されます。

recId,searchText,country 
1,"Sturmstraße 8, 80687 München,DEU

基本的な入力フィールド

入力フィールド名では、大文字と小文字は区別されません。 レコード ID ( フィールド名 recId) が指定されていない場合、バッチ Geocoder は 1 から始まるシーケンスとしてレコード ID を生成します。 recIds には、数値または英数字を含めることができます。 recIdバッチジョブのすべてのが数値の場合、 Batch Geocoder は結果を数値順に並べ替えます。 それ以外の場合は、 Batch Geocoder によって結果がアルファベット順に並べ替えられます。 結果のレコードの入力順を保持する場合 recIdは、フィールド名を含む列を入力しないでください。

表 1. 全般
recId レコード ID
表 2. 住所、 freeform
searchText 単一行のクエリ文字列は、二重引用符で囲むことができます
表 3. 住所、認定済み
street 番地。スイート、アパート、および階数の情報を含めることができます。
houseNumber 番地または自宅名。
district 街の下位階に位置しています。 国の管理階層によっては、このレベルが適用されない場合があります ( 例 : USA:n/a, ドイツ:Ortsteil )。
city 指定した国に適した市区町村名 ( 例 : USA: City, ドイツ : Gemeinde )を参照してください。
postalCode 国の政府によって定義された郵便番号。
county 国の下の 2 番目の下位区分。 国の管理者階層によっては、このレベルが適用されない場合があります ( 例 : USA: County, ドイツ: Kreis )。
state 国の下の最初の下位区分レベル。 state は、完全表記または省略表記を使用して指定できます。 指定した国に適したカテゴリを使用します ( 例 : USA: State, ドイツ: Bundesland)。
country 国コード( 3 バイト、 ISO 3166-1-alpha-3 )または国名を使用する国。 あいまいさを避けるため、異なる言語の国名のスペルミスや問題を避けるために、 3 文字の ISO コードを使用することをお勧めします。また、名前のスペルを記述することはお勧めしません。
表 4. 地理座標、逆ジオ コーディング
mode 3 つの値のいずれか :
  • retrieveAddresses - 最も近い番地を検索します
  • retrieveAreas - リクエストで指定された位置の管理エリア情報を取得します
  • trackPosition - 位置と方位に基づいて道路情報を取得します
pos

pos=lat,lon,bearing

で使用します mode=trackPosition

緯度、経度、および方位を表す。 方位は、真北を起点にコンパスの時計回りにアセットが向かっている方向を度単位で表します。北は 0 度、東は 90 度、南は 180 度、西は 270 度です。

prox

prox=lat,lon,radius

mode=retrieveAddresses とを使用します retrieveAreas

SpatialFilter のタイプ。 空間フィルタは、リクエストの他の属性の検索を制限します。 近傍( Proximity )では、緯度、経度、および半径を使用して検索する円をメートル単位で指定します。

表 5. 雑則
locationattributes クエリ パラメーターは、mapReferenceIDmapReferenceMapVersionなどの特殊な出力フィールドを要求するために必要で、locationattributesの値mrを使用してアクティブ化されます
addressattributes 特殊なアドレス属性を要求するクエリ パラメーター
responseattributes 特殊な応答属性を要求するクエリ パラメーター
mapview ジオ コーディングで使用するマップ ビュー
countryfocus ジオ コーディングで使用される国の重点項目
bbox ジオ コーディングに使用するバウンディング ボックスフィルタ
prox ジオ コーディングに使用されるプロキシミティフィルタ
locationid 要求されたオブジェクトのロケーション ID
additionaldata ジオ コーディングで使用される追加のクエリーパラメータ
gen ジオ コーディングに使用される生成パラメーター

For the detailed description of these parameters, see the https://here-tech.skawa.fun/documentation/geocoder/dev_guide/topics/includes.html.

バッチジオ コーディング入力データを反転します

逆バッチジオ コーディングの入力データも区切り記号付きファイルで提供する必要があります。 1 行目は、入力ファイルの列の名前を一覧表示するヘッダーです。 HERE は、リバースバッチジオ コーディング入力ファイルの例です。

recId|prox
0001|52.505308,13.327739,250
0002|49.917257,8.486488,250
0003|51.119593,7.399356,250
...      

基本的な入力フィールド

レコード ID ( フィールド名 recId) が指定されていない場合、バッチ Geocoder は 1 から始まるシーケンスとしてレコード ID を生成します。 recIds には、数値または英数字を含めることができます。 recIdバッチジョブのすべてのが数値の場合、 Batch Geocoder は結果を数値順に並べ替えます。 それ以外の場合は、 Batch Geocoder によって結果がアルファベット順に並べ替えられます。 結果のレコードの入力順を保持する場合 recIdは、フィールド名の付いた列を入力しないでください。

表 6. 全般
recId レコード ID
表 7. 位置情報
prox ジオ コーディングで使用される近接フィルタ。緯度、経度、および半径の 3 つのデータ項目がメートル単位で含まれます

空の入力データセットです

入力ファイルに処理するデータが含まれていない場合でも、サービスはリクエストを受け入れます。 たとえば、入力ファイルにヘッダー行のみが含まれていて、ジオコードへのアドレスやジオコードを反転する位置座標が含まれていない場合です。

このような場合 、サービスはジョブを受け入れ、「ジョブが送信され、受け入れられました」に示されているように応答を生成します。 ジョブが完了すると、出力ファイルにはヘッダ行が含まれますが、結果は含まれません。