Package google.maps.geocode.v4alpha

インデックス

DestinationService

宛先を取得するためのサービス。

目的地は場所に関する階層的なコンテキストを提供します。これにより、たとえば、大規模なアパート群の中にあるアパートの建物を探したり、その逆の操作を行ったりできます。また、ライドシェアや配達などのユースケースに適したナビゲーション ポイントも提供します。

SearchDestinations

rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse)

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

認可スコープ

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

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

GeocodeService

ジオコーディングを実行するためのサービス。

GeocodeAddress

rpc GeocodeAddress(GeocodeAddressRequest) returns (GeocodeAddressResponse)

このメソッドは、住所を LatLng にマッピングする住所ジオコードを実行します。また、住所に関する構造化された情報も提供します。

認可スコープ

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

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

rpc GeocodeLocation(GeocodeLocationRequest) returns (GeocodeLocationResponse)

このメソッドは、LatLng を住所にマッピングする位置ジオコードを実行します。また、住所に関する構造化された情報も提供します。

認可スコープ

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

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

rpc GeocodePlace(GeocodePlaceRequest) returns (GeocodeResult)

このメソッドは、プレイス ID を使用してジオコード検索を行います。

認可スコープ

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

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

目的地

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

フィールド
primary

PlaceView

リクエストの primary_query で識別されるプライマリ プレイス。
containing_places[]

PlaceView

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

PlaceView

メインの場所のより正確なサブデスティネーション。たとえば、建物内のユニットなどです。

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

Landmark

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

Entrance

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

NavigationPoint

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

Destination.ArrivalSummary

目的地の到着体験に関する AI 生成の概要。

ArrivalSummary

目的地の到着体験に関する AI 生成の概要。

フィールド
text

LocalizedText

目的地での到着体験の概要。
flag_content_url

string

ユーザーが要約に関する問題を報告できるリンク。
disclosure_text

LocalizedText

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

入口

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

フィールド
location

LatLng

入り口の場所。
tags[]

Entrance.Tag

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

string

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

タグ

入り口を説明する特性。

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

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

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

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

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

GeocodeAddressRequest

GeocodeService.GeocodeAddress のリクエスト メッセージ。

フィールド
location_bias

GeocodeAddressRequest.LocationBias

省略可。検索するリージョン。この位置はバイアスとして機能するため、指定された位置周辺の結果が返される可能性があります。
language_code

string

省略可。結果が返される言語。
region_code

string

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

string

ジオコーディングする構造化されていない住所。
address

PostalAddress

郵便住所形式でジオコーディングする構造化された住所。

LocationBias

検索するリージョン。この位置はバイアスとして機能するため、指定された位置周辺の結果が返される可能性があります。

フィールド
共用体フィールド type。位置情報のバイアスの種類。type は次のいずれかになります。
rectangle

Viewport

北東と南西の角で定義された長方形のボックス。rectangle.high() は、長方形のビューポートの北東の点である必要があります。rectangle.low() は、長方形のビューポートの南西の点である必要があります。rectangle.low().latitude() は rectangle.high().latitude() より大きくすることはできません。これにより、緯度の範囲が空になります。長方形のビューポートの幅は 180 度以下にしてください。

GeocodeAddressResponse

GeocodeService.GeocodeAddress に対するレスポンス メッセージです。

フィールド
results[]

GeocodeResult

ジオコーディングの結果。

GeocodeLocationRequest

GeocodeService.GeocodeLocation に対するリクエスト メッセージ。

フィールド
language_code

string

省略可。結果が返される言語。
region_code

string

省略可。地域コード。地域コード。ccTLD（「トップレベル ドメイン」）の 2 文字の値として指定されます。このパラメータは、適用される法律に基づいて結果に影響します。
types[]

string

省略可。結果を制限する型タグのセット。指定されたタイプのいずれにも該当しない結果は削除されます。

使用可能な値の完全なリストについては、https://developers.google.com/maps/documentation/places/web-service/place-types の表 A と表 B をご覧ください。
granularity[]

GeocodeResult.Granularity

省略可。1 つ以上の位置情報の粒度列挙型のフィルタ。
共用体フィールド location_input。ジオコーディングする場所。location_input は次のいずれかになります。
location_query

string

「lat,lng」文字列形式の位置。例: 「64.7611872,-18.4705364」。
location

LatLng

構造化された形式の場所。

GeocodeLocationResponse

GeocodeService.GeocodeLocation に対するレスポンス メッセージです。

フィールド
results[]

GeocodeResult

ジオコーディングの結果。
plus_code

PlusCode

リクエスト内の場所の Plus Code。

GeocodePlaceRequest

GeocodeService.GeocodePlace のリクエスト メッセージ。

フィールド
place

string

必須。ジオコーディングするプレイス識別子。places/{place} の形式で指定します。
language_code

string

省略可。結果が返される言語。
region_code

string

省略可。地域コード。地域コード。ccTLD（「トップレベル ドメイン」）の 2 文字の値として指定されます。このパラメータは、適用される法律に基づいて結果に影響します。

GeocodeResult

ジオコード結果には、場所に関する地理情報が含まれています。

フィールド
place

string

この結果の完全修飾された場所識別子。「//places.googleapis.com/places/{placeID}」の形式で指定します。詳しくは、https://developers.google.com/maps/documentation/places/web-service/place-id をご覧ください。
place_id

string

この結果のプレイス ID。
location

LatLng

この住所の緯度経度。
granularity

GeocodeResult.Granularity

位置情報の粒度。
viewport

Viewport

ジオコーディング結果の表示に適したビューポート。
bounds

Viewport

住所の境界ボックス。
formatted_address

string

1 行でフォーマットされた住所。
postal_address

PostalAddress

郵便住所形式の住所。
address_components[]

GeocodeResult.AddressComponent

地域レベルごとに繰り返されるコンポーネント。
postal_code_localities[]

LocalizedText

郵便番号に含まれる地域の完全なリスト。

結果のタイプが「postal_code」の場合にのみ入力されます。
types[]

string

この結果の型タグのセット。たとえば、「political」や「administrative_area」などです。

使用可能な値の完全なリストについては、https://developers.google.com/maps/documentation/places/web-service/place-types の表 A と表 B をご覧ください。
plus_code

PlusCode

このジオコード内の場所の Plus Code。

AddressComponent

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

フィールド
long_text

string

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

string

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

string

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

詳しくは、https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types をご覧ください。
language_code

string

このコンポーネントのフォーマットに使用される言語（CLDR 表記）。

粒度

位置情報の粒度。

列挙型
GRANULARITY_UNSPECIFIED 使用しないでください。
ROOFTOP 一致した住所に対応する実際の土地の非補間位置。
RANGE_INTERPOLATED 番地の範囲から補間されます。たとえば、Amphitheatre Pkwy のある区間に 1600 ～ 1699 の番地が含まれていることがわかっている場合、1650 はその区間の両端の中間地点に配置される可能性があります。
GEOMETRIC_CENTER ポリゴン データがあるフィーチャーの幾何学的中心。
APPROXIMATE その他すべて。

ランドマーク

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

フィールド
relational_description

LocalizedText

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

Landmark.Tag

ランドマークをデスティネーションのコンテキストで使用する方法を説明するタグ。
straight_line_distance_meters

double

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

double

出力専用。このランドマークから目的地までの道路網の距離（メートル単位）。
共用体フィールド landmark。ランドマーク。landmark は次のいずれかになります。
place

PlaceView

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

タグ

ランドマークが目的地に関連してどのように使用されるかを説明する、考えられるすべてのタグのリスト。

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

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

ナビゲーション ポイントは、ナビゲーションを終了できる道路の近くの場所です。

フィールド
navigation_point_token

string

出力専用。このナビゲーション ポイントの識別に使用できるトークン。
display_name

LocalizedText

このナビゲーション ポイントの表示名。（「5th Ave」や「Gate B」など）。
location

LatLng

ナビゲーションの終点として適切な道路セグメントの横のポイント。このポイントは、道路の中心線から意図的に少しずらして、場所がある道路の側を明確に示しています。
travel_modes[]

NavigationPoint.TravelMode

このナビゲーション ポイントに適した移動手段。
usages[]

NavigationPoint.Usage

このナビゲーション ポイントでサポートされている使用方法。

TravelMode

このナビゲーション ポイントに適した移動手段。

列挙型
TRAVEL_MODE_UNSPECIFIED 使用されません。
DRIVE 運転に適しています。
WALK ウォーキングに適しています。

用途

このナビゲーション ポイントでサポートされている使用方法。

列挙型
USAGE_UNSPECIFIED 使用されません。
UNKNOWN 不明な使用タイプ。ほとんどのナビゲーション ポイントは UNKNOWN になりますが、必ずしも使用が制限されるわけではありません。このナビゲーションは、乗車場所や降車場所に適している可能性があります。
DROPOFF 乗客の降車に適しています。たとえば、ライドシェアの降車場所などです。
PICKUP 乗客の乗車に適しています。たとえば、ライドシェアの乗車場所などです。

PlaceView

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

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

フィールド
place

string

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

LocalizedText

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

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 をご覧ください。
formatted_address

string

1 行の住所。
postal_address

PostalAddress

構造化された住所。
structure_type

PlaceView.StructureType

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

LatLng

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

Struct

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

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

StructureType

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

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

PlusCode

Plus Code（http://plus.codes）は、14 メートル x 14 メートル（8000 分の 1 度）以下の長方形を定義するグローバル コードと、プレフィックスを参照位置に置き換える複合コードの 2 つの形式を持つ位置参照です。

フィールド
global_code

string

場所のグローバル（完全な）コード（「9FWM33GV+HQ」など）。8000 分の 1 度 x 8000 分の 1 度の領域（約 14 メートル x 14 メートル）を表します。
compound_code

string

「33GV+HQ, Ramberg, Norway」などの場所の複合コード。グローバル コードの接尾辞を含み、接頭辞が参照エンティティの書式設定された名前に置き換えられています。

SearchDestinationsRequest

DestinationService.SearchDestinations に対するリクエスト メッセージ。

フィールド
travel_modes[]

NavigationPoint.TravelMode

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

string

省略可。結果が返される言語。
region_code

string

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

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

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

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

string

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

SearchDestinationsRequest.AddressQuery

番地です。
location_query

SearchDestinationsRequest.LocationQuery

正確な位置情報。

AddressQuery

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

フィールド
共用体フィールド kind。アドレス クエリ。kind は次のいずれかになります。
address

PostalAddress

郵便番号形式の番地。
address_query

string

1 行で表された番地。

LocationQuery

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

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

フィールド
place_filter

SearchDestinationsRequest.LocationQuery.PlaceFilter

省略可。宛先候補に適用するフィルタ。
共用体フィールド kind。位置情報クエリ。kind は次のいずれかになります。
location

LatLng

正確な LatLng の位置。

PlaceFilter

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

フィールド
structure_type

PlaceView.StructureType

省略可。指定すると、すべてのデスティネーションにこの構造タイプのプライマリ プレイスが必ず存在します。これにより、一部の目的地が除外されたり、返される目的地が粗くなったり、絞り込まれたりすることがあります。

たとえば、GROUNDS が指定されている場合、返されるすべての目的地には GROUNDS 構造タイプのプライマリ プレイスがあります。これにより、根拠の一部ではない目的地が除外されたり、返される目的地が根拠レベルに粗くされたりする可能性があります。

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

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

省略可。指定した場合、対応するアドレス指定の条件を満たすデスティネーションのみが返されます。

アドレス指定

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

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

SearchDestinationsResponse

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

フィールド
destinations[]

Destination

宛先のリスト。

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