Package google.maps.geocode.v4alpha

索引

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

DestinationService

用於擷取目的地的服務。

目的地會提供地點的階層式背景資訊，例如找出大型公寓大樓群中的公寓大樓，反之亦然。此外，這項服務也提供適合共乘或外送等用途的導航點。

SearchDestinations
rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse) 這個方法會執行目的地查詢，並傳回目的地清單。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/maps-platform.geocode https://www.googleapis.com/auth/maps-platform.destinations

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 這個目的地的導航點。
parking_options	Destination.ParkingOptions 這個目的地的停車選項。
arrival_summary	Destination.ArrivalSummary AI 生成的目的地抵達體驗摘要。

ArrivalSummary

AI 生成的目的地抵達體驗摘要。

欄位
text	LocalizedText 抵達目的地時的體驗摘要。
flag_content_url	string 使用者可透過這個連結，回報摘要問題。
disclosure_text	LocalizedText 僅供輸出。包含抵達摘要的揭露文字。

ParkingOptions

目的地停車選項的相關資訊。

欄位
availability	Destination.ParkingOptions.Availability 這個目的地的停車位供應情形。
parking_facilities[]	Destination.ParkingOptions.ParkingFacility 這個目的地的停車設施。
onsite_parking	bool 目的地附設停車場。
free_parking_lot	bool 提供免費停車場。
paid_parking_lot	bool 提供付費停車場。
free_street_parking	bool 提供免費路邊車位。
paid_street_parking	bool 提供付費路邊車位。
valet_parking	bool 提供代客泊車服務。
free_garage_parking	bool 提供免費室內停車場。
paid_garage_parking	bool 提供付費室內停車場。

可用性

造訪這個地點時，尋找停車位的難易度匯總指標。

日後可能會新增其他值。

列舉
AVAILABILITY_UNSPECIFIED	無法提供停車位資訊。
PLENTY	提供充足的停車位。
SOMEWHAT_DIFFICULT	停車位有點難找。
DIFFICULT	停車位非常難找。

ParkingFacility

與目的地相關聯的個別獨立停車選項 (例如特定室內停車場或停車場)。這項資訊會提供特定停車設施的詳細資料，而父項 ParkingOptions 訊息則會提供所有可用停車設施的匯總摘要。

欄位
place	PlaceView 這個特定停車設施的地點表示法。
onsite	bool 這個停車場是否位於主要目的地。如果未設定這個欄位，現場狀態會是不明。
popular	bool 這個停車場是否為前往主要目的地的旅客熱門選擇。如果未設定這個欄位，則熱門程度狀態不明。
straight_line_distance_meters	double 從主要目的地到這座停車場的直線距離 (以公尺為單位)。

入口位置

入口是一組經緯度座標，定義地點的出入口位置。

欄位
display_name	LocalizedText 人類可讀的名稱，例如「B 閘門」、「南側入口」、「第 5 大道入口」。
location	LatLng 入口位置。
tags[]	Entrance.Tag 描述入口的標記清單。
place	string 這個入口實際所在的建築物，格式為 places/{place_id}。
street_view_thumbnail	StreetViewThumbnail 顯示入口的街景服務縮圖。您可以向 Street View Static API 要求圖片。請參閱 https://developers.google.com/maps/documentation/streetview/request-streetview。
street_view_annotation	ImageAnnotation 上方傳回的 street_view_thumbnail 入口註解。

標記

描述入口的特徵。

列舉
TAG_UNSPECIFIED	未使用。
PREFERRED	入口可能提供實體通道，可通往傳回目的地中的主要地點。一個地點可以有多個偏好入口。如果入口沒有這個標記，表示入口與主要地點位於同一棟建築物，但不一定能通往該地點。 舉例來說，如果主要地點是購物中心內的餐廳，「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 這個地點的資源名稱，格式為 places/{placeId}。可用於查詢地點。
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 指出地址元件類型的陣列。 這些值取自 Places API 使用的地址類型和地址元件類型表格：https://developers.google.com/maps/documentation/places/web-service/place-types#address-types
language_code	string 用於設定這個元件格式的語言 (以 CLDR 標記法表示)。

精細程度

位置的精細程度。

列舉
GRANULARITY_UNSPECIFIED	請勿使用。
ROOFTOP	與比對地址對應的實際土地非內插位置。
RANGE_INTERPOLATED	從門牌號碼範圍內插補。舉例來說，如果我們知道 Amphitheatre Pkwy 的某個路段包含 1600 到 1699 號，則 1650 號可能會放在該路段的中間位置。
GEOMETRIC_CENTER	我們有多邊形資料的地圖項目幾何中心。
APPROXIMATE	其他。

ImageAnnotation

圖片縮圖上的註解，例如勾勒出入口的多邊形。

欄位
coordinates[]	ImageAnnotation.Coordinate 在圖片上形成多邊形的座標清單。座標會依逆時針順序排列。

協調中心

圖片上某個點的像素座標。原點 (0,0) 是圖片左上角像素的左上角，x 軸指向右側，y 軸指向下方。

欄位
x_px	float X 座標。
y_px	float Y 座標。

地標

地標可用來指出目的地位置，或協助使用者抵達目的地。

欄位
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 列出這個導覽點支援的usages。如果空白，不一定代表其使用方式受到任何限制。所有導航點都可用於一般導航。
street_view_thumbnail	StreetViewThumbnail 顯示導航點的街景服務縮圖 (如有)。您可以向 Street View Static API 要求圖片。請參閱 https://developers.google.com/maps/documentation/streetview/request-streetview。
entrance_annotation	ImageAnnotation 如果上方傳回的 street_view_thumbnail 有與這個導航點相關聯的入口，則會顯示該入口的註解。
altitude_meters	float 導航點的高度 (以公尺為單位，相對於 WGS-84 橢球體)。

TravelMode

適合這個導航點的交通方式。

列舉
TRAVEL_MODE_UNSPECIFIED	未使用。
DRIVE	適合開車。
WALK	適合步行。

用量

這個導航點支援的用途。日後可能會新增其他值。

列舉
USAGE_UNSPECIFIED	未使用。
UNKNOWN	表示用途類型不明。
DROPOFF	適合讓乘客下車。例如共乘下車地點。
PICKUP	適合接乘客。例如共乘上車地點。
PARKING	適合停車。例如在停車場內。

PlaceView

代表 Places API 中地點的檢視畫面。此外，這項服務也會提供目的地專屬的其他資訊，例如結構類型和顯示多邊形。

在某些情況下，具有相同地點 ID 的 PlaceView，可能與 Places API 針對 types 和 display_name 欄位傳回的內容不同。

欄位
place	string 這個地點的資源名稱，格式為 places/{placeId}。可用於查詢地點。
place_id	string 地點的專屬 ID。
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 物件可以代表多個多邊形。
address_components[]	PlaceView.AddressComponent 每個地區層級的重複元件。

AddressComponent

構成格式化地址的結構化元件 (如有這項資訊)。

欄位
long_text	string 地址元件的完整文字說明或名稱。舉例來說，澳洲這個國家/地區的地址元件，全名可能是「Australia」。
short_text	string 地址元件的縮寫文字名稱 (如有)。舉例來說，澳洲的地址元件簡稱可能是「AU」。
types[]	string 指出地址元件類型的陣列。 這些值取自 Places API 使用的地址類型和地址元件類型表格：https://developers.google.com/maps/documentation/places/web-service/place-types#address-types
language_code	string 用於設定這個元件格式的語言 (以 CLDR 標記法表示)。

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。查詢主要目的地。可以是地點、完整地址或經緯度位置。如果地點和地址的資訊過少，就無法設為目的地。 目的地是根據指定的主要查詢建立。 注意：僅支援可設為導航目的地的地點和地址。舉例來說，代表房屋或公寓大樓的地點可以做為主要查詢，但代表地區或行政區的地點則不行。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 目的地清單。 如果能從主要查詢中明確識別出主要目的地，服務就會傳回一項結果。否則，服務可能會傳回多個結果供您釐清，或不傳回任何結果。

StreetViewThumbnail

代表 Google 街景服務縮圖的參數。這些參數可用於向 Street View Static API 要求街景服務圖片。請參閱 https://developers.google.com/maps/documentation/streetview/request-streetview。

欄位
pano	string 特定全景 ID。
width_px	int32 輸出縮圖的寬度 (以像素為單位)。注意：如果要求註解和縮圖，請務必在街景服務 API 要求中使用這些高度和寬度值，確保註解座標與圖片正確對齊。
height_px	int32 輸出縮圖的高度 (以像素為單位)。注意：如果要求註解和縮圖，請務必在街景服務 API 要求中使用這些高度和寬度值，確保註解座標與圖片正確對齊。
heading_degree	float 相機的水平方向 (以度為單位)。範圍 [0, 360)。0 代表北方，90 代表東方。
pitch_degree	float 相機的垂直方向 (以度為單位)。範圍 [-90, 90]。0 代表水平，+90 代表垂直向上，-90 代表垂直向下。
fov_degree	float 水平視野 (以度為單位)。範圍 (0, 180]。控制縮放等級。視野越小，表示放大倍率越高。