Method: resolveNames

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

HTTP リクエスト

POST https://mapstools.googleapis.com/v1: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 よりも優先されます。

レスポンスの本文

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

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

JSON 表現 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
フィールド
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" }
saveToMapsUrl

string

出力専用。解決されたすべてのエンティティを Google マップに保存するためのリンク。

認可スコープ

次の OAuth スコープが必要です。

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

LocationQuery

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

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

string

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

LocationBias

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

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "viewport": {
    object (Viewport)
  }
  // End of mutually exclusive fields.
}
フィールド
位置情報のバイアスのタイプ。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
viewport

object (Viewport)

境界ボックスで定義されたビューポート。
相互に排他的なフィールドの終わり。

結果

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

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

object (Entity)

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

enum (Confidence)

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

信頼度

解決策の信頼度。

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