Geocoder API 開発者ガイド

ジオコードリソースを反転します

ここでは、すべての Reverse ジオコード要求パラメータのリストを示します。
.../6.2/reversegeocode.{format}?<parameter>=<value>...
表 1. リクエストパラメータ
パラメーター 要素
追加データ

リクエストへの追加の入力を提供するキーと値のペア。 一覧表の詳細については、「追加のデータパラメータ」を参照してください。 キーと値は、を使用して区切り ,ます。 複数のキーと値のペアは、次のものを使用して区切ります ;

additionaldata=<Key1>,<Value1>;<Key2>,<Value2>;...

例 :

additionaldata=PreserveUnitDesignators,true;
IncludeZipAddon,true
addressattributes

応答データに要素が含まれているコンマ区切りのリスト。

一覧表 [country, state, county, city, districtsubdistrictstreethouseNumberpostalCodeaddressLines additionalData]

省略形 : [ctr, sta, cty, cit, dis, sdi, strhnrpstalnadd、]

デフォルトの応答 : を除くすべて addressLines

注 : 値の名前では、大文字と小文字が区別されます。
app_id

xs:string

Geocoder API で使用可能な認証オプションのいずれかで使用される、 20 バイトの Base64 URL セーフエンコード文字列。

アプリ ID/APP コードオプションを使用する場合は、すべてのリクエストに app_idapp_code を含める必要があります。 詳細については、『 Identity & Access Management 開発者ガイド』を参照してください。

app_code

xs:string

クライアント アプリケーションの認証に使用される 20 バイトの Base64 URL セーフエンコード文字列。

アプリ ID/APP コードオプションを使用する場合は、すべてのリクエストに app_idapp_code を含める必要があります。 詳細については、『 Identity & Access Management 開発者ガイド』を参照してください。

apiKey

xs:string

A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://here-tech.skawa.fun/projects. API Keys never expire but you can invalidate your API Keys at any time. You cannot have more than two API Keys for one app at the same time.

apiKey すべてのリクエストにを含める必要があります。 詳細については、『 Identity & Access Management 開発者ガイド』を参照してください。

世代

xs: 整数

このgenパラメータは、 API での下位互換性のない動作を有効または無効にします。 詳細および世代履歴については、同じ API の異なる世代の章を参照してください。 常に最新世代の製品を使用することをお勧めします。 現在、 gen= です9

jsonattributes

xs: 整数

1 に設定すると、各 JSON 応答属性名の最初の文字が小文字に設定されます。 デフォルト値は 0 です。

jsoncallback

xs: 文字列

JSON 応答のラップに使用するユーザー定義関数の名前を指定します。

言語

LanguageCodeType

結果の住所要素の優先言語。 Geocoder は、希望する言語を使用せずに、現地の人々が理解できるように、公式の国の言語または地域の主要言語で結果を返します。 言語コードは、 RFC 4647 標準に準拠して提供する必要があります。 パラメーター(言語)の複数形もサポートされています。 ただし、リスト内の最後に指定した言語のみが使用されます。 この時点では、上記の言語設定はすべて無視されます。

レベル

xs: 文字列

検索結果のターゲットの一致レベル。 [country, state, county, city, district, postalCode, , ] をクリックします 以上との組み合わせでのみ有効 gen=2 です。
locationattributes

応答データに要素が含まれているコンマ区切りのリスト。

一覧表 [address, mapReference, mapView, addressDetails, streetDetailsadditionalDataadminIdslinkInfoadminInfotimeZone, addressNamesBilingual related.nearByAddress]

省略形 : [ar, mr, mv, dt, sd, ad, ailiintznbrn,]

adminIds このスイッチは、順方向ジオ コーディングでのみ使用できます。

タイムゾーン情報を取得するには、次 adminInfo のようにパラメータを追加する必要があります。 locationattributes=adminInfo,timeZone

逆方向のジオ コーディングの結果では、 locationattributes=none をオフにしない限り、 adminIds は常に存在します。 locationattributes=-adminIds は、逆方向のジオ コーディングの結果には影響を与えません。

related.nearByAddress このスイッチは trackPosition 、リバースジオ コーディングモードでのみ使用できます。

リバースジオ コーディング応答のデフォルト : addressmapViewadditionalDatamapReferenceadminIds

転送ジオ コーディング応答のデフォルト : addressmapViewadditionalData

mapReference リンク PVID 、番地、管理エリアの PVID が応答データに含まれています。 で adminIdsは、管理エリアの PVID のみが存在します。

注 : 値の名前では、大文字と小文字が区別されます。
MaxResults

xs: 整数

応答構造内の最大アイテム数を定義し、各応答ページに含まれる結果の数を制限します。 定義されている最大数を超える結果が得られると、別々の追加ページに返されます。 各応答構造 ( ページ ) には、次のページへのハンドルが含まれています。 たとえば、 maxresults=5 は、 1 つの応答ページにつき最大 5 つの結果を生成します。 合計で 8 つの結果がある場合、最初のページには 5 つの結果が含まれ、さらに結果が表示された 2 ページ目があることを示します。

"metaInfo: {
  timestamp: 2012-05-10T15:10:06.227+0000
  nextPageInformation: 2
}"
検索結果はわずかです

xs: 整数

minResults 結果が見つかるまで、サービスが指定した半径を無視することを示します。 デフォルトは 0 です。 Reverse ジオコード mode=retrieveAreas およびでサポート mode=retrieveAddressesされています。

モード
5 つの値のいずれか :
  • retrieveAddresses - 最も近い番地を検索します
  • retrieveAreas - リクエストで指定された位置の管理エリア情報を取得します
  • retrieveLandmarks - リクエストに応じて、公園や湖などのランドマークを検索できます
  • retrieveAll - 通り、行政エリア、ランドマークを検索します。 このモードでは、 3 つの異なるモードの結果が 1 つのコールに集約されます
  • trackPosition - 位置と方位に基づいて、番地と番地の情報を取得します
ページ情報

xs: 文字列

応答が複数のページに分割されたときに返されるページを識別するキー。 maxresults 元のリクエストでが指定されており、リクエストの応答に次のページがあることが示されている場合にのみ関連します。例 :

"metaInfo: {
  timestamp: 2012-05-10T15:10:06.227+0000
  nextPageInformation: 2
}"
政治家の見方

xS: 文字列 (3 バイト、 ISO 3166-1-alpha-3)

政治的見解を指定します。 利用可能な地域は、この国の観点から見ることができます。 このパラメータが指定されていない場合は、中立的な国際ビューが利用可能になります。このビューでは、地域に未解決のクレームがある可能性があります。

サポートされているすべてのビューの一覧については、付録の「 Political View 」を参照してください。

Geocoder をサポートしていないすべての政治的ビューについて、はデフォルトのビューに戻ります。 たとえば、 politicalview=USA または politicalview=FRA は、どのような方法でも応答に影響を与えません。

位置

pos=lat,lon,bearing

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

Prox です

GeoProximityType 。 GeoProximityType も参照してください

prox=lat,lon,radius

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

responseattributes

応答データに要素が含まれているコンマ区切りのリスト。

列挙 [performedSearch, matchQuality, matchType, matchCode parsedRequest]

省略形 : [ps, mq, mt, mc, pr]

デフォルトの応答 : matchQuality, matchType

メモ : 値の名前では、大文字と小文字が区別されます。
sortby

xs: 文字列

距離 ( デフォルト ) 、母集団の数、またはサイズ ( 近似領域サイズ ) で結果を並べ替えます。 [distance, population size] のいずれかです。

現在、 Reverse ジオコードでのみサポート mode=retrieveAreasされています。 エンティティに人口のカウントが使用できない場合、サービスはエリアサイズで並べ替えられるようにフォールバックします。

strictlanguagemode

xs: boolean

  • True - language パラメータで指定された最初の言語で値が使用できる場合、属性値は AddressPlaceLocation 、および Category の各要素で直接設定されます。 代替言語の値が AlternativeValues 要素に返されます。
  • False - language パラメーターで指定された言語の優先度に基づいて、 AddressPlaceLocation および Category の各要素で直接使用できる最適な属性値が返されます。 代替案は返されません。
トークン

xs: 文字列

一般的に 24 バイトの URL エンコードされた Base64 文字列 ( 保証されていません ) 。 は token 、ユーザーに基づいて生成 app_id され、アプリケーションの登録プロセス後に受信されます。

パラメータ token は廃止されました app_code 。代わりにを使用してください