Package google.maps.geocode.v4alpha

索引

• DestinationService (介面)
• GeocodeService (介面)
• Destination (訊息)
• Destination.ArrivalSummary (訊息)
• Entrance (訊息)
• Entrance.Tag (列舉)
• GeocodeAddressRequest (訊息)
• GeocodeAddressRequest.LocationBias (訊息)
• GeocodeAddressResponse (訊息)
• GeocodeLocationRequest (訊息)
• GeocodeLocationResponse (訊息)
• GeocodePlaceRequest (訊息)
• GeocodeResult (訊息)
• GeocodeResult.AddressComponent (訊息)
• GeocodeResult.Granularity (列舉)
• Landmark (訊息)
• Landmark.Tag (列舉)
• NavigationPoint (訊息)
• NavigationPoint.TravelMode (列舉)
• NavigationPoint.Usage (列舉)
• PlaceView (訊息)
• PlaceView.StructureType (列舉)
• PlusCode (訊息)
• SearchDestinationsRequest (訊息)
• SearchDestinationsRequest.AddressQuery (訊息)
• SearchDestinationsRequest.LocationQuery (訊息)
• SearchDestinationsRequest.LocationQuery.PlaceFilter (訊息)
• SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability (列舉)
• SearchDestinationsResponse (訊息)

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	入口很可能提供返回目的地主要地點的實體通道。一個地點可以有多個偏好入口。如果入口沒有這個標記，表示入口與主要地點位於同一棟建築物，但不一定能通往該地點。 舉例來說，如果主要地點是小型商場內的餐廳，「偏好」入口會是可能直接通往餐廳的入口，而其他傳回的入口則是建築物的其他入口，例如通往小型商場內其他餐廳的入口。 如果主要地點是建築物本身，PREFERRED入口就是通往建築物「主要」部分的入口。舉例來說，購物中心的 PREFERRED 入口會是可通往主要大廳的入口，但如果入口只能通往建築物側邊的商店，就不會是 PREFERRED 入口。 注意：PREFERRED 入口可能無法通往主要地點，而非 PREFERRED 入口則可能可以。

GeocodeAddressRequest

GeocodeService.GeocodeAddress 的要求訊息。

欄位
location_bias	GeocodeAddressRequest.LocationBias (選用步驟) 要搜尋的區域。這個位置會做為偏差值，也就是說，系統可能會傳回指定位置附近的結果。
language_code	string (選用步驟) 傳回結果時使用的語言。
region_code	string (選用步驟) 區域代碼。區碼，指定為 ccTLD (「頂層網域」) 的兩位字元值。這個參數會根據適用法律影響結果。這項參數也會影響服務提供的結果，但不會完全限制。
聯集欄位 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 (「頂層網域」) 的兩位字元值。這個參數會根據適用法律影響結果。
types[]	string (選用步驟) 一組類型標記，用於限制結果。系統會移除不屬於任何指定類型的結果。 如需可能值的完整清單，請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 和表 B。
granularity[]	GeocodeResult.Granularity (選用步驟) 一或多個位置精細度列舉的篩選器。
聯集欄位 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 必填。要進行地理編碼的地點 ID，格式為 places/{place}。
language_code	string (選用步驟) 傳回結果時使用的語言。
region_code	string (選用步驟) 區域代碼。區碼，指定為 ccTLD (「頂層網域」) 的兩位字元值。這個參數會根據適用法律影響結果。

GeocodeResult

地理編碼結果包含地點的地理資訊。

欄位
place	string 這個結果的完整地點 ID。格式為「//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 格式為單行的地址。
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 地址元件的完整文字說明或名稱。舉例來說，澳洲地址元件的長名稱可能為「Australia」。
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 標籤的地標通常離目的地較近。

NavigationPoint

導航點是指道路旁的某個位置，導航可以在此結束。

欄位
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 單行地址。
postal_address	PostalAddress 結構化地址。
structure_type	PlaceView.StructureType 與這個地點相應的結構類型。
location	LatLng 這個地點的位置。如果地點有顯示多邊形，這可能代表在地圖上放置標記的好位置。
display_polygon	Struct 地點的 GeoJSON 格式多邊形輪廓，使用 RFC 7946 格式：https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6。 注意：RFC 7946 格式支援 MultiPolygon，因此一個 display_polygon 物件可以代表多個多邊形。

StructureType

這個地點代表的結構類型。

列舉
STRUCTURE_TYPE_UNSPECIFIED	未使用。
POINT	點位置。
SECTION	建築物的子區域。
BUILDING	建築物。
GROUNDS	通常包含多棟建築物的大型區域，例如大學校園、公寓大樓或購物中心。

PlusCode

Plus Code (http://plus.codes) 是位置參照，有兩種格式：全球代碼 (定義 14 公尺 x 14 公尺或更小的矩形，即 1/8000 度) 和複合代碼 (以前置字元取代參照位置)。

欄位
global_code	string 地點的全球 (完整) 代碼，例如「9FWM33GV+HQ」，代表 1/8000 度 x 1/8000 度的區域 (約 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 (「頂層網域」) 的兩位字元值。這個參數會根據適用法律影響結果。這項參數也會影響服務提供的結果，但不會完全限制。
聯集欄位 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 格式為單行的街道地址。

LocationQuery

位置查詢，用於識別附近的目標主要目的地。

注意：如果位置查詢位於含有子場所的建築物內，傳回的主要地點可能是子場所。在這些情況下，containing_places 欄位會包含建築物。

欄位
place_filter	SearchDestinationsRequest.LocationQuery.PlaceFilter (選用步驟) 要套用至候選目的地的篩選器。
聯集欄位 kind。位置查詢。kind 只能是下列其中一項：
location	LatLng 精確的 LatLng 位置。

PlaceFilter

要套用至候選目的地的篩選器。

欄位
structure_type	PlaceView.StructureType (選用步驟) 如有指定，所有目的地保證都會有主要地點，且結構類型符合指定條件。這可能會導致部分目的地遭到篩除，或是傳回的目的地變得粗略/精細。 舉例來說，如果指定 GROUNDS，所有傳回的目的地都會有 GROUNDS 結構類型的主要地點。這可能會導致系統篩除不屬於場地的目的地，或將傳回的目的地粗略歸類至場地層級。 這個欄位的另一個用途是更輕鬆地擷取建築物顯示多邊形。舉例來說，如果指定 BUILDING，主要地點的顯示多邊形會是指定位置的建築物。
addressability	SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability (選用步驟) 如果指定，則只會傳回符合相應可尋址性條件的目的地。

可定址性

定義可尋址性篩選的選項。日後可能會新增值。

列舉
ADDRESSABILITY_UNSPECIFIED	如未指定，服務會選擇合理的預設值。
ANY	可尋址性並非篩選條件。無論目的地是否可定址，都會傳回。
PRIMARY	傳回的所有目的地都會有主要地點，並提供街道地址或名稱。
WEAK	傳回的所有目的地都會有主要地點或子目的地，並附上街道層級的地址或名稱。

SearchDestinationsResponse

DestinationService.SearchDestinations 的回應訊息。

欄位
destinations[]	Destination 目的地清單。 如果服務可從主要查詢明確識別主要目的地，則會傳回一個結果。否則，服務可能會傳回多個結果以消除歧義，或傳回零個結果。