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

目的地

目的地。包括主要地點、相關地點、入口和導航點。

欄位
primary

PlaceView

要求中 primary_query 識別的主要地點。

containing_places[]

PlaceView

主要地點所屬的較不精確地點。例如包含這棟建築物的公寓大樓。

sub_destinations[]

PlaceView

主要地點的更精確子目的地。例如建築物內的單元。

注意:與 Places API 傳回的 SubDestination 相比,這份子目的地清單更完整,且每個子目的地都包含更多資訊。

landmarks[]

Landmark

可用於說明目的地位置或協助抵達目的地的地標。

entrances[]

Entrance

這個目的地的入口。

navigation_points[]

NavigationPoint

這個目的地的導航點。

入口位置

入口是單一的經緯度座標對,用於定義地點的入口和出口位置。

欄位
location

LatLng

入口位置。

tags[]

Entrance.Tag

描述入口的標籤清單。

place

string

入口所在的建築物,格式為 places/{place_id}

標記

描述入口的特徵。

列舉
TAG_UNSPECIFIED 未使用。
PREFERRED

入口很可能提供返回目的地主要地點的實體通道。一個地點可以有多個偏好入口。如果入口沒有這個標記,表示入口與主要地點位於同一棟建築物,但不一定能通往該地點。

舉例來說,如果主要地點是小型商場內的餐廳,「偏好」入口會是可能直接通往餐廳的入口,而其他傳回的入口則是建築物的其他入口,例如通往小型商場內其他餐廳的入口。

如果主要地點是建築物本身,PREFERRED 入口就是通往建築物「主要」部分的入口。舉例來說,購物中心的 PREFERRED 入口會是可通往主要大廳的入口,但如果入口只能通往建築物側邊的商店,就不會是 PREFERRED 入口。

注意:PREFERRED 入口可能無法通往主要地點,而非 PREFERRED 入口則可能可以。

地標

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

欄位
tags[]

Landmark.Tag

標記,說明地標在目的地情境中的用途。

聯集欄位 landmark。地標。landmark 只能是下列其中一項:
place

PlaceView

代表這個地標的地點。

標記

所有可能的標記清單,說明如何在目的地情境中使用地標。

如果地址同時有 ADDRESSARRIVAL 標記,表示地標在當地相當知名,且靠近目的地。

列舉
TAG_UNSPECIFIED 未使用。
ADDRESS 可用於識別目的地大概位置的當地顯眼地點。通常在目的地幾百公尺內。這類地標與 Geocoding API 地址描述元功能傳回的地標類似:https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors
ARRIVAL 可協助抵達目的地的地點。接近目的地時,這項功能有助於導航。舉例來說,這個地標可能位於目的地對街。與標有 ADDRESS 標籤的地標相比,標有這個標籤的地標通常更靠近目的地。

導航點是道路旁的某個位置,導航可以在這裡結束。

欄位
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 為 typesdisplay_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 通常包含多棟建築物的大型區域,例如大學校園、公寓大樓或購物中心。

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 欄位會包含建築物。

欄位
聯集欄位 kind。位置查詢。kind 只能是下列其中一項:
location

LatLng

精確的 LatLng 位置。

SearchDestinationsResponse

DestinationService.SearchDestinations 的回應訊息。

欄位
destinations[]

Destination

目的地清單。

如果服務可從主要查詢明確識別主要目的地,則會傳回一個結果。否則,服務可能會傳回多個結果以消除歧義,或傳回零個結果。