Method: resolveNames

場所の名前（または住所）のリストを Google マップ上の特定の地理空間エンティティ（場所など）に解決します。

HTTP リクエスト

POST https://mapstools.googleapis.com/v1alpha:resolveNames

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
フィールド
queries[]

object (LocationQuery)

必須。解決する位置情報クエリのリスト。最大 20 個のクエリを指定できます。
locationBias

object (LocationBias)

省略可。解決結果をバイアスするオプションのリージョン。指定すると、このリージョンに近いエンティティに解決結果が偏ります。locationBias または regionCode を含めると、検索スペースが絞り込まれるため、より良い結果が得られることがよくあります。

locationBias と regionCode の両方が指定されている場合、locationBias が regionCode よりも優先されます。
regionCode

string

省略可。解決結果をバイアスする地域コード（省略可）。指定すると、指定されたリージョン内またはその近くにあるエンティティに解決結果が偏ります。これは CLDR 地域コードである必要があります。例: 「US」、「CA」locationBias または regionCode を含めると、検索スペースが絞り込まれるため、より良い結果が得られることがよくあります。

locationBias と regionCode の両方が指定されている場合、locationBias が regionCode よりも優先されます。

レスポンスの本文

v1alpha.resolveNames のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  }
}
フィールド
results[]

object (Result)

出力専用。位置情報クエリから解決されたエンティティのリスト。リクエストの queries インデックスと 1 対 1 でマッピングされることが保証されます。インデックス i の空の文字列は、そのクエリの解決が失敗したことを示します。解決に失敗した場合は、failedRequests フィールドでエラー ステータスを確認してください。
failedRequests

map (key: integer, value: object (Status))

出力専用。部分的な失敗を伝えるマップ。キーは、queries フィールド内の失敗したリクエストのインデックスです。値は、解決が失敗した理由の詳細を示すエラー ステータスです。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/maps-platform.mapstools
  • https://www.googleapis.com/auth/cloud-platform.read-only

LocationQuery

位置情報クエリは、Google マップで解決できる特定の位置情報エンティティを表します。現在、位置情報のクエリとしてサポートされているのは、地名と住所のみです。

JSON 表現 
{
  "text": string
}
フィールド
text

string

必須。Google マップ上の特定の地理空間エンティティ（場所や住所など）に解決するテキスト クエリ。クエリが具体的であるほど、解決策の精度が高くなります。たとえば、「サンフランシスコ」、「Googleplex, Mountain View, CA」、「1600 Amphitheatre Parkway, Mountain View, CA」、「エッフェル塔、パリ」などです。クエリは、特定の住所または場所の名前である必要があります。チェーン名（スターバックスなど）や「レストラン」などの検索クエリなどの一般的な場所は対象外です。

LocationBias

解決結果のバイアスを適用するリージョン。

JSON 表現 
{

  // Union field type can be only one of the following:
  "viewport": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
フィールド
共用体フィールド type。位置情報のバイアスのタイプ。type は次のいずれかになります。
viewport

object (Viewport)

境界ボックスで定義されたビューポート。

ビューポート

緯度と経度のビューポート。対角線上の 2 つの low ポイントと high ポイントで表されます。ビューポートは閉じた領域と見なされます。つまり、境界が含まれます。緯度の境界は -90 ～ 90 度（両端を含む）、経度の境界は -180 ～ 180 度（両端を含む）の範囲で指定する必要があります。さまざまなケースには、次のようなものがあります。

  • low = high の場合、ビューポートはその単一点で構成されます。

  • low.longitude > high.longitude の場合、経度範囲は反転します（ビューポートが経度 180 度の線を横切ります）。

  • low.longitude = -180 度、high.longitude = 180 度の場合は、ビューポートにすべての経度が含まれます。

  • low.longitude = 180 度、high.longitude = -180 度の場合は、経度の範囲は空になります。

  • low.latitude > high.latitude の場合、緯度範囲は空になります。

low と high の両方に値を入力する必要があります。また、上記の定義で指定されているように、表されるボックスを空にすることはできません。ビューポートが空の場合、エラーが発生します。

たとえば、次のビューポートはニューヨーク市を完全に囲みます。

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON 表現 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
フィールド
low

object (LatLng)

必須。ビューポートの最下点。
high

object (LatLng)

必須。ビューポートの最上部。

LatLng

緯度と経度のペアを表すオブジェクト。これは緯度を表す倍精度値と経度を表す倍精度値のペアで表現されます。特に明記されていない場合、このオブジェクトは WGS84 規格に準拠する必要があります。値は正規化範囲内で指定する必要があります。

JSON 表現 
{
  "latitude": number,
  "longitude": number
}
フィールド
latitude

number

緯度（度単位）。範囲 [-90.0, +90.0] 内になければなりません。
longitude

number

経度（度単位）。範囲 [-180.0, +180.0] 内になければなりません。

結果

指定された位置情報クエリから解決された単一のエンティティと、解決の信頼レベル。

JSON 表現 
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
フィールド
entity

object (Entity)

出力専用。位置情報クエリから解決されたエンティティ。
confidence

enum (Confidence)

出力専用。解決策の信頼度。

信頼度

解決策の信頼度。

列挙型
CONFIDENCE_UNSPECIFIED デフォルト値。この値は使用されません。
MEDIUM 中程度の信頼度は、解決策が正しい可能性が高いが、他の候補が存在する可能性があることを示します。
HIGH 信頼度が高い場合は、解決策が正しく、特定の地理空間エンティティ（特定の場所など）を表していることを示します。