Method: geocode.destinations.searchDestinations

このメソッドは、宛先ルックアップを実行し、宛先のリストを返します。

HTTP リクエスト

POST https://geocode.googleapis.com/v4alpha/geocode/destinations

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

リクエストの本文

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

JSON 表現 
{
  "travelModes": [
    enum (NavigationPoint.TravelMode)
  ],
  "languageCode": string,
  "regionCode": string,

  // Union field primary_query can be only one of the following:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of list of possible types for union field primary_query.
}
フィールド
travelModes[]

enum (NavigationPoint.TravelMode)

省略可。ナビゲーション ポイントをフィルタする交通手段。これは、レスポンスで返される navigationPoints フィールドに影響します。空の場合、すべての交通手段のナビゲーション ポイントを返すことができます。
languageCode

string

省略可。結果を返す言語。
regionCode

string

省略可。地域コード。ccTLD（「トップレベル ドメイン」）の 2 文字の値として指定される地域コード。このパラメータは、適用される法律に基づいて結果に影響します。このパラメータは、サービスから返される結果に影響を与えますが、完全に制限するわけではありません。

共用体フィールド primary_query。プライマリ デスティネーションのクエリ。場所、完全修飾の住所、LatLng のいずれかを指定できます。情報が少ない場所や住所は、目的地に設定できない場合があります。

宛先は、指定されたプライマリ クエリを中心に構築されます。

注: ナビゲーションの目的地に設定できる場所と住所のみがサポートされます。たとえば、家やアパートを表す場所はプライマリ クエリとして使用できますが、地域や行政区域を表す場所はプライマリ クエリとして使用できません。primary_query は次のいずれかになります。
place

string

場所のリソース名（places/{placeId} 形式）。
addressQuery

object (SearchDestinationsRequest.AddressQuery)

番地です。
locationQuery

object (SearchDestinationsRequest.LocationQuery)

正確な位置情報。

レスポンスの本文

DestinationService.SearchDestinations に対するレスポンス メッセージ。

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

JSON 表現 
{
  "destinations": [
    {
      object (Destination)
    }
  ]
}
フィールド
destinations[]

object (Destination)

宛先のリスト。

プライマリ クエリからプライマリ デスティネーションを一意に特定できる場合、サービスは 1 つの結果を返します。そうしないと、サービスは曖昧さを解消するために複数の結果を返すか、結果を返さない可能性があります。

認可スコープ

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

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

SearchDestinationsRequest.AddressQuery

検索する番地。対象国の郵便業務で使用されている形式で住所を指定します。

JSON 表現 
{

  // Union field kind can be only one of the following:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド kind。アドレス クエリ。kind は次のいずれかになります。
address

object (PostalAddress)

郵便住所形式の番地。
addressQuery

string

1 行で表された番地。

SearchDestinationsRequest.LocationQuery

付近の主な目的地を特定するための位置情報クエリ。

注: 位置情報のクエリが、サブプレミスを含む建物内にある場合、返されるプライマリ プレイスがサブプレミスである可能性があります。このような場合、containingPlaces フィールドには建物が含まれます。

JSON 表現 
{

  // Union field kind can be only one of the following:
  "location": {
    object (LatLng)
  }
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド kind。位置情報クエリ。kind は次のいずれかになります。
location

object (LatLng)

正確な LatLng の位置。

目的地

目的地。これには、メインの場所、関連する場所、入り口、ナビゲーション ポイントが含まれます。

JSON 表現 
{
  "primary": {
    object (PlaceView)
  },
  "containingPlaces": [
    {
      object (PlaceView)
    }
  ],
  "subDestinations": [
    {
      object (PlaceView)
    }
  ],
  "landmarks": [
    {
      object (Landmark)
    }
  ],
  "entrances": [
    {
      object (Entrance)
    }
  ],
  "navigationPoints": [
    {
      object (NavigationPoint)
    }
  ]
}
フィールド
primary

object (PlaceView)

リクエストの primary_query で特定されたプライマリ プレイス。
containingPlaces[]

object (PlaceView)

主な場所が包含される、精度が低い場所。たとえば、この建物を含むアパートの複合施設などです。
subDestinations[]

object (PlaceView)

メインの場所のより正確なサブ目的地。たとえば、建物内のユニットなどです。

注: このサブ目的地リストは、Places API から返される SubDestination よりも包括的で、各サブ目的地にはより多くの情報が含まれています。
landmarks[]

object (Landmark)

目的地を伝えるため、または到着をサポートするために使用できるランドマーク。
entrances[]

object (Entrance)

この目的地の入り口。
navigationPoints[]

object (NavigationPoint)

この目的地のナビゲーション ポイント。

PlaceView

Places API の Place のビューを表します。また、構造タイプや表示ポリゴンなど、目的地に固有の追加情報も提供します。

場合によっては、同じプレイス ID の PlaceView が、Places API から types フィールドと displayName フィールドに対して返されるものと異なることがあります。

JSON 表現 
{
  "place": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  }
}
フィールド
place

string

このプレイスのリソース名（places/{placeId} 形式）。
displayName

object (LocalizedText)

人が読める形式の場所の説明。例: 「B ゲート」、「マクドナルド」
primaryType

string

このスポットのプライマリ スポットタイプ。使用可能な値の一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types をご覧ください。

注: このフィールドには常に値が入力されるわけではありません。このような状況では、types フィールドを使用する準備をしてください。
types[]

string

このスポットに関連付けられているすべてのスポットタイプ。使用可能な値の一覧については、https://developers.google.com/maps/documentation/places/web-service/place-types をご覧ください。
formattedAddress

string

1 行の住所。
postalAddress

object (PostalAddress)

構造化された住所。
structureType

enum (PlaceView.StructureType)

このスポットに対応する構造のタイプ。
location

object (LatLng)

この場所の所在地。ポリゴンが表示される場所の場合、これは地図上にマーカーを配置するのに適した場所を表す可能性があります。
displayPolygon

object (Struct format)

RFC 7946 形式（https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6）を使用した、GeoJSON 形式の場所のポリゴン アウトライン。

注: RFC 7946 形式は MultiPolygon をサポートしているため、1 つの displayPolygon オブジェクトで複数のポリゴンを表すことができます。

PlaceView.StructureType

この場所が表す構造物のタイプ。

列挙型
STRUCTURE_TYPE_UNSPECIFIED 使用されません。
POINT ポイントの場所。
SECTION 建物のサブセクション。
BUILDING 建物。
GROUNDS 通常、大学のキャンパス、アパートの複合施設、ショッピング モールなど、複数の建物を含む広いエリア。

ランドマーク

ランドマークは、目的地がどこにあるかを伝えたり、目的地に到着するのを手助けしたりするために使用されます。

JSON 表現 
{
  "tags": [
    enum (Landmark.Tag)
  ],

  // Union field landmark can be only one of the following:
  "place": {
    object (PlaceView)
  }
  // End of list of possible types for union field landmark.
}
フィールド
tags[]

enum (Landmark.Tag)

ランドマークをデスティネーションのコンテキストで使用する方法を説明するタグ。
共用体フィールド landmark。ランドマーク。landmark は次のいずれかになります。
place

object (PlaceView)

このランドマークを表す場所。

Landmark.Tag

目的地というコンテキストでランドマークをどのように使用できるかを説明する、考えられるすべてのタグのリスト。

住所に ADDRESS タグと ARRIVAL タグの両方がある場合、ランドマークはローカルで目立っていて、目的地に近いことを意味します。

列挙型
TAG_UNSPECIFIED 使用されません。
ADDRESS 目的地の概略位置を特定するために使用できる、地域でよく知られている場所。通常は目的地から数百メートル以内です。これらは、Geocoding API の住所記述子機能によって返されるランドマークに似ています。https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors をご覧ください。
ARRIVAL 目的地に到着するのに役立つ場所。目的地に近づいたときにナビゲーションに役立ちます。たとえば、このランドマークは目的地から道路を挟んだ場所にある可能性があります。このタグが付いたランドマークは、通常、ADDRESS タグが付いたランドマークよりも目的地に近い場所にあります。

入口

エントランスは、場所の出入り口の位置を定義する単一の緯度/経度座標ペアです。

JSON 表現 
{
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string
}
フィールド
location

object (LatLng)

入り口の場所。
tags[]

enum (Entrance.Tag)

入り口を説明するタグのリスト。
place

string

この入口が物理的に配置されている構造物（places/{placeId} 形式）。

Entrance.Tag

入り口を表す特性。

列挙型
TAG_UNSPECIFIED 使用されません。
PREFERRED

このエントランスは、返された目的地内の主要な場所への物理的なアクセスを提供している可能性があります。1 つのスポットに複数の推奨入り口を設定できます。このタグがない場合、入り口はメインの場所と同じ建物にありますが、必ずしもその場所へのアクセスを提供しているとは限りません。

たとえば、プライマリ プレイスが商店街のレストランの場合、「優先」エントランスはレストラン自体につながる可能性の高いエントランスになり、返される他のエントランスは、商店街の他のレストランのエントランスなど、建物の他のエントランスになります。

主要な場所が建物自体である場合、PREFERRED の入り口は建物の「メイン」部分につながる入り口になります。たとえば、ショッピング センターでは、メインのホワイエ エリアにアクセスできる入り口が PREFERRED の入り口になります。ただし、建物の側面にある店舗にのみアクセスできる入り口は、PREFERRED の入り口にはなりません。

注: PREFERRED の入り口からメインの場所に入れない場合もあれば、PREFERRED 以外の入り口からメインの場所に入れる場合もあります。