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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of mutually exclusive fields.
}
フィールド
travelModes[]

enum (NavigationPoint.TravelMode)

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

string

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

string

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

プライマリ宛先をクエリします。場所、完全な住所、LatLng 位置のいずれかを指定できます。情報が最小限の場所や住所は、目的地に変換できない場合があります。

宛先は、指定されたプライマリ クエリに基づいて構築されます。

注: ナビゲーションの目的地として設定できる場所と住所のみがサポートされています。たとえば、家や集合住宅を表す場所はプライマリ クエリとして使用できますが、地域や行政区域を表す場所はプライマリ クエリとして使用できません。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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
  • https://www.googleapis.com/auth/maps-platform.destinations

SearchDestinationsRequest.AddressQuery

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

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of mutually exclusive fields.
}
フィールド
住所クエリ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
address

object (PostalAddress)

郵送先住所形式の番地。
addressQuery

string

1 行でフォーマットされた番地。
相互に排他的なフィールドの終了。

SearchDestinationsRequest.LocationQuery

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

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

JSON 表現 
{
  "placeFilter": {
    object (SearchDestinationsRequest.LocationQuery.PlaceFilter)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (LatLng)
  }
  // End of mutually exclusive fields.
}
フィールド
placeFilter

object (SearchDestinationsRequest.LocationQuery.PlaceFilter)

省略可。宛先候補に適用するフィルタ。
位置情報クエリ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
location

object (LatLng)

正確な LatLng 位置。
相互に排他的なフィールドの終了。

SearchDestinationsRequest.LocationQuery.PlaceFilter

宛先候補に適用するフィルタ。

JSON 表現 
{
  "structureType": enum (PlaceView.StructureType),
  "addressability": enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)
}
フィールド
structureType

enum (PlaceView.StructureType)

省略可。指定した場合、すべての目的地にこの構造タイプの主要な場所が必ず含まれます。これにより、一部の目的地が除外されたり、返される目的地が粗くなったり、細かくなったりすることがあります。

たとえば、GROUNDS が指定されている場合、返されるすべての目的地には、GROUNDS 構造タイプの主要な場所が含まれます。これにより、敷地の一部ではない目的地が除外されたり、返される目的地が敷地レベルに粗くなったりすることがあります。

このフィールドのもう 1 つの用途は、建物の表示ポリゴンをより簡単に抽出することです。たとえば、BUILDING が指定されている場合、メインの場所の表示ポリゴンは、指定された場所にある建物になります。
addressability

enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)

省略可。指定すると、対応するアドレス可能性の条件を満たす宛先のみが返されます。

PlaceView.StructureType

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

列挙型
STRUCTURE_TYPE_UNSPECIFIED 使用されません。
POINT ポイント ロケーション。
SECTION 建物の一部。
BUILDING 建物。
GROUNDS 大学のキャンパス、アパート、ショッピング モールなど、通常は複数の建物を含む広いエリア。

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

アドレス可能性フィルタリングのオプションを定義します。今後、新しい値が追加される可能性があります。

列挙型
ADDRESSABILITY_UNSPECIFIED 指定しない場合は、サービスによって適切なデフォルトが選択されます。
ANY アドレス可能性はフィルタ条件ではありません。宛先は、アドレス指定可能性に関係なく返されます。
PRIMARY 返されるすべての目的地には、番地レベルの住所または名前を持つ主要な場所があります。
WEAK 返されるすべての目的地には、メインの場所またはサブ目的地があり、番地レベルの住所または名前が付けられています。

宛先

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

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

object (PlaceView)

リクエストの primary_query で識別されるメインの場所。
containingPlaces[]

object (PlaceView)

プライマリの場所が含まれる、より大まかな場所。たとえば、この建物を含むアパート・マンションなどです。
subDestinations[]

object (PlaceView)

メインの場所のより詳細なサブ目的地。たとえば、建物に含まれるユニットなどです。

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

object (Landmark)

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

object (Entrance)

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

object (NavigationPoint)

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

object (Destination.ParkingOptions)

この目的地の駐車オプション。
arrivalSummary

object (Destination.ArrivalSummary)

目的地への到着時の状況に関する AI 生成の要約。

PlaceView

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

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

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

string

この Place のリソース名（places/{placeId} 形式）。場所の検索に使用できます。
placeId

string

場所の固有識別子。
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)

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

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

object (PlaceView.AddressComponent)

各地域レベルの繰り返しコンポーネント。

PlaceView.AddressComponent

フォーマットされた住所を構成する構造化コンポーネント（この情報が利用可能な場合）。

JSON 表現 
{
  "longText": string,
  "shortText": string,
  "types": [
    string
  ],
  "languageCode": string
}
フィールド
longText

string

住所コンポーネントの説明または名前。たとえば、オーストラリアの住所コンポーネントの場合、正式名称は「Australia」になります。
shortText

string

住所コンポーネントの略称（略称がある場合）。たとえば、オーストラリアの住所コンポーネントの場合、略称は「AU」になります。
types[]

string

住所コンポーネントのタイプを示す配列。

これらの値は、Places API で使用される住所のタイプと住所コンポーネントのタイプの表から取得されます。https://developers.google.com/maps/documentation/places/web-service/place-types#address-types
languageCode

string

このコンポーネントの形式設定に使用される言語（CLDR 表記）。

ランドマーク

ランドマークは、目的地の場所を伝えたり、目的地への到着をサポートしたりするために使用されます。

JSON 表現 
{
  "relationalDescription": {
    object (LocalizedText)
  },
  "tags": [
    enum (Landmark.Tag)
  ],
  "straightLineDistanceMeters": number,
  "travelDistanceMeters": number,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "place": {
    object (PlaceView)
  }
  // End of mutually exclusive fields.
}
フィールド
relationalDescription

object (LocalizedText)

目的地とランドマークの関係を説明する、人が読める形式の説明。（例: 「エンパイア ステート ビルの近く」、「ホワイト ハウスの向かい」）。
tags[]

enum (Landmark.Tag)

目的地との関連でランドマークをどのように使用できるかを説明するタグ。
straightLineDistanceMeters

number

出力専用。このランドマークから目的地までの直線距離（メートル単位）。
travelDistanceMeters

number

出力専用。このランドマークから目的地までの歩行距離（メートル単位）。
ランドマーク。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 表現 
{
  "displayName": {
    object (LocalizedText)
  },
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string,
  "streetViewThumbnail": {
    object (StreetViewThumbnail)
  },
  "streetViewAnnotation": {
    object (ImageAnnotation)
  }
}
フィールド
displayName

object (LocalizedText)

人が読める形式の名前（例: 「ゲート B」、「南口」、「5 番街入口」）。
location

object (LatLng)

入口の場所。
tags[]

enum (Entrance.Tag)

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

string

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

object (StreetViewThumbnail)

入口を示すストリートビューのサムネイル画像。画像はストリートビュー Static API からリクエストできます。https://developers.google.com/maps/documentation/streetview/request-streetview をご覧ください。
streetViewAnnotation

object (ImageAnnotation)

上記で返された streetViewThumbnail の入り口のアノテーション。

Entrance.Tag

入り口を説明する特性。

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

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

たとえば、メインの場所がストリップ モール内のレストランの場合、「PREFERRED」エントランスはレストラン自体に通じるエントランスになります。返される他のエントランスは、ストリップ モール内の他のレストランへのエントランスなど、建物の他のエントランスになります。

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

注: PREFERRED のエントランスがメインの場所へのアクセスを提供していない場合や、PREFERRED 以外のエントランスがメインの場所へのアクセスを提供している場合があります。

StreetViewThumbnail

Google ストリートビューのサムネイルを表すパラメータ。これらのパラメータを使用して、Street View Static API からストリートビュー画像をリクエストできます。https://developers.google.com/maps/documentation/streetview/request-streetview をご覧ください。

JSON 表現 
{
  "pano": string,
  "widthPx": integer,
  "heightPx": integer,
  "headingDegree": number,
  "pitchDegree": number,
  "fovDegree": number
}
フィールド
pano

string

特定のパノラマ ID。
widthPx

integer

出力サムネイル画像の幅（ピクセル単位）。注: サムネイルとともにアノテーションをリクエストする場合は、アノテーションの座標が画像と正しく一致するように、ストリートビュー API リクエストでこれらの高さと幅の値を使用する必要があります。
heightPx

integer

出力サムネイル画像の高さ（ピクセル単位）。注: サムネイルとともにアノテーションをリクエストする場合は、アノテーションの座標が画像と正しく一致するように、ストリートビュー API リクエストでこれらの高さと幅の値を使用する必要があります。
headingDegree

number

カメラの水平方向の向き（度単位）。範囲は [0, 360) です。0 は北、90 は東を示します。
pitchDegree

number

カメラの垂直方向の向き（度単位）。範囲は [-90, 90] です。0 は水平、+90 は真上、-90 は真下です。
fovDegree

number

水平画角（度単位）。範囲（0、180）。ズームレベルを制御します。FOV が小さいほど、ズームが大きくなります。

ImageAnnotation

画像サムネイルのアノテーション（入り口を囲む多角形など）。

JSON 表現 
{
  "coordinates": [
    {
      object (ImageAnnotation.Coordinate)
    }
  ]
}
フィールド
coordinates[]

object (ImageAnnotation.Coordinate)

画像上にポリゴンを形成する座標のリスト。座標は反時計回りに並べられます。

ImageAnnotation.Coordinate

画像上のポイントのピクセル座標。原点（0,0）は、画像の左上のピクセルの左上隅です。x 軸は右方向、y 軸は下方向を指します。

JSON 表現 
{
  "xPx": number,
  "yPx": number
}
フィールド
xPx

number

X 座標。
yPx

number

Y 座標。

Destination.ParkingOptions

目的地付近の駐車方法に関する情報。

JSON 表現 
{
  "availability": enum (Destination.ParkingOptions.Availability),
  "parkingFacilities": [
    {
      object (Destination.ParkingOptions.ParkingFacility)
    }
  ],
  "onsiteParking": boolean,
  "freeParkingLot": boolean,
  "paidParkingLot": boolean,
  "freeStreetParking": boolean,
  "paidStreetParking": boolean,
  "valetParking": boolean,
  "freeGarageParking": boolean,
  "paidGarageParking": boolean
}
フィールド
availability

enum (Destination.ParkingOptions.Availability)

この目的地での駐車場の利用可能性。
parkingFacilities[]

object (Destination.ParkingOptions.ParkingFacility)

この目的地の駐車場。
onsiteParking

boolean

目的地に敷地内駐車場がある。
freeParkingLot

boolean

無料駐車場あり。
paidParkingLot

boolean

有料駐車場を提供している。
freeStreetParking

boolean

無料の路上駐車スペースあり。
paidStreetParking

boolean

有料の路上駐車スペースがあります。
valetParking

boolean

バレー パーキングを提供している。
freeGarageParking

boolean

無料の屋内駐車スペースあり。
paidGarageParking

boolean

有料の屋内駐車スペースを提供しています。

Destination.ParkingOptions.Availability

この場所を訪れる際に駐車スペースを見つけるのがどの程度難しいかを示す集計指標。

今後、新しい値が追加される可能性があります。

列挙型
AVAILABILITY_UNSPECIFIED 駐車場の空き状況は利用できません。
PLENTY 駐車場は十分にあります。
SOMEWHAT_DIFFICULT 駐車場がやや見つけにくい。
DIFFICULT 駐車場が非常に見つけにくい。

Destination.ParkingOptions.ParkingFacility

目的地に関連付けられた、個別の駐車オプション（特定の屋内駐車場や駐車場など）。これは、特定の駐車施設に関する詳細情報を提供します。一方、親の ParkingOptions メッセージは、利用可能なすべての駐車場の集計概要を提供します。

JSON 表現 
{
  "place": {
    object (PlaceView)
  },
  "onsite": boolean,
  "popular": boolean,
  "straightLineDistanceMeters": number
}
フィールド
place

object (PlaceView)

この特定の駐車施設の場所表現。
onsite

boolean

この駐車場が主な目的地の敷地内にあるかどうか。このフィールドが設定されていない場合、オンサイト ステータスは不明です。
popular

boolean

この駐車場が、主な目的地に移動する訪問者に人気があるかどうか。このフィールドが設定されていない場合、人気度は不明です。
straightLineDistanceMeters

number

主な目的地からこの駐車場までの直線距離（メートル単位）。

Destination.ArrivalSummary

目的地への到着時の状況に関する AI 生成の要約。

JSON 表現 
{
  "text": {
    object (LocalizedText)
  },
  "flagContentUrl": string,
  "disclosureText": {
    object (LocalizedText)
  }
}
フィールド
text

object (LocalizedText)

目的地への到着時のエクスペリエンスの概要。
flagContentUrl

string

要約の問題を報告できるリンク。
disclosureText

object (LocalizedText)

出力専用。到着概要の開示テキストが含まれます。