Package google.maps.places.v1

索引

地點

Places API 的服務定義。注意:每項要求 (Autocomplete 和 GetPhotoMedia 要求除外) 都需要設定要求 proto 外部的欄位遮罩 (all/*,不會假設)。您可以透過 HTTP 標頭 X-Goog-FieldMask 設定欄位遮罩。請參閱:https://developers.google.com/maps/documentation/places/web-service/choose-fields

AutocompletePlaces

rpc AutocompletePlaces(AutocompletePlacesRequest) returns (AutocompletePlacesResponse)

傳回指定輸入內容的預測結果。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/maps-platform.places.autocomplete
  • https://www.googleapis.com/auth/maps-platform.places
  • https://www.googleapis.com/auth/cloud-platform
GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

使用相片參考字串取得相片媒體。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/maps-platform.places.getphotomedia
  • https://www.googleapis.com/auth/maps-platform.places
  • https://www.googleapis.com/auth/cloud-platform
GetPlace

rpc GetPlace(GetPlaceRequest) returns (Place)

根據地點的資源名稱 (places/{place_id} 格式的字串) 取得詳細資料。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/maps-platform.places.details
  • https://www.googleapis.com/auth/maps-platform.places
  • https://www.googleapis.com/auth/cloud-platform
SearchNearby

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

搜尋地點附近的場所。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/maps-platform.places.nearbysearch
  • https://www.googleapis.com/auth/maps-platform.places
  • https://www.googleapis.com/auth/cloud-platform
SearchText

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

根據文字查詢搜尋地點。

授權範圍

需要下列其中一種 OAuth 範圍:

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

AddressDescriptor

地點的關係說明。包括附近地標的排名組合,以及精確的包含區域和與目標位置的關係。

欄位
landmarks[]

Landmark

附近地標的排序清單。系統會優先顯示最容易辨識且距離最近的地標。

areas[]

Area

包含或相鄰區域的排名清單。系統會優先顯示最容易辨識且最精確的區域。

區域資訊,以及區域與目標位置的關係。

區域包括精確的子區域、鄰近地區和大型建築群,可用於描述地點。

欄位
name

string

區域的資源名稱。

place_id

string

該區域的地點 ID。

display_name

LocalizedText

區域的顯示名稱。

containment

Containment

定義目標位置與區域之間的空間關係。

防堵

定義目標位置與區域之間的空間關係。

列舉
CONTAINMENT_UNSPECIFIED 未指定容器。
WITHIN 目標位置位於區域內,靠近中心。
OUTSKIRTS 目標位置位於區域內,靠近邊緣。
NEAR 目標位置不在區域範圍內,但距離不遠。

地標

地標基本資訊,以及地標與目標位置的關係。

地標是可用來描述地點的顯眼位置。

欄位
name

string

地標的資源名稱。

place_id

string

地標的地點 ID。

display_name

LocalizedText

地標的顯示名稱。

types[]

string

這個地標的一組類型標記。如要查看可能值的完整清單,請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types

spatial_relationship

SpatialRelationship

定義目標位置與地標之間的空間關係。

straight_line_distance_meters

float

目標聚焦點與地標聚焦點之間的直線距離 (以公尺為單位)。在某些情況下,這個值可能會大於 travel_distance_meters

travel_distance_meters

float

從目標到地標的道路網路距離 (以公尺為單位,如已知)。這個值不會考量交通方式,例如步行、開車或騎自行車。

SpatialRelationship

定義目標位置與地標之間的空間關係。

列舉
NEAR 如果以下沒有更具體的關係,這就是預設關係。
WITHIN 地標具有空間幾何圖形,且目標位於地標範圍內。
BESIDE 目標直接位於地標旁。
ACROSS_THE_ROAD 目標位於道路另一側,與地標直接相對。
DOWN_THE_ROAD 與地標位於同一條路線上,但不在地標旁邊或對面。
AROUND_THE_CORNER 不在地標的同一條路徑上,但只要轉個彎就能抵達。
BEHIND 靠近地標建築,但距離街道入口較遠。

AuthorAttribution

UGC 資料作者的相關資訊。在 PhotoReview 中使用。

欄位
display_name

string

PhotoReview 的作者姓名。

uri

string

PhotoReview 的作者 URI。

photo_uri

string

PhotoReview 作者的個人資料相片 URI。

AutocompletePlacesRequest

AutocompletePlaces 的要求原型。

欄位
input

string

必填。要搜尋的文字字串。

location_bias

LocationBias

(選用步驟) 針對指定地點調整結果。

最多只能設定 location_biaslocation_restriction 其中一個。如果兩者皆未設定,系統會根據 IP 位址調整結果,也就是將 IP 位址對應至不精確的位置,並做為調整信號。

location_restriction

LocationRestriction

(選用步驟) 將結果限制在指定地點。

最多只能設定 location_biaslocation_restriction 其中一個。如果兩者皆未設定,系統會根據 IP 位址調整結果,也就是將 IP 位址對應至不精確的位置,並做為調整信號。

included_primary_types[]

string

(選用步驟) 地點類型 (https://developers.google.com/maps/documentation/places/web-service/place-types) 中包含的主要地點類型 (例如「restaurant」或「gas_station」),或僅包含 (regions),或僅包含 (cities)。只有當地點的主要類型包含在這份清單中時,系統才會傳回該地點。最多可指定 5 個值。如果未指定類型,系統會傳回所有地點類型。

included_region_codes[]

string

(選用步驟) 只納入指定區域的結果,最多可指定 15 個 CLDR 雙字元區域代碼。空集合不會限制結果。如果同時設定 location_restrictionincluded_region_codes,結果會位於交集區域。

language_code

string

(選用步驟) 傳回結果時使用的語言。預設為「en-US」。如果 input 中使用的語言與 language_code 不同,或傳回的地點沒有從當地語言到 language_code 的翻譯,結果可能會以混合語言顯示。

region_code

string

(選用步驟) 區碼,指定為 CLDR 雙字元區碼。這會影響地址格式、結果排名,以及可能影響傳回的結果。這不會將結果限制在指定區域。如要將結果限制在特定區域,請使用 region_code_restriction

origin

LatLng

(選用步驟) 計算到目的地 (以 distance_meters 形式傳回) 的測地距離時,使用的原點。如果省略這個值,系統就不會傳回測地距離。

input_offset

int32

(選用步驟) 以零為基準的 Unicode 字元位移值 input,表示 input 中的游標位置。游標位置可能會影響系統傳回的預測結果。

如果為空白,則預設為 input 的長度。

include_query_predictions

bool

(選用步驟) 如果設為 true,回應會同時包含地點和查詢預測。否則回應只會傳回地點預測結果。

session_token

string

(選用步驟) 用於計費的 Autocomplete 工作階段 ID 字串。必須是網址和檔案名稱安全 Base64 字串,長度最多為 36 個 ASCII 字元。否則會傳回 INVALID_ARGUMENT 錯誤。

工作階段是從使用者輸入查詢時開始,到使用者選取地點並呼叫 Place Details 或地址驗證時結束。在每個工作階段中,使用者可以輸入多筆查詢,最終提出一項 Place Details 或地址驗證要求。工作階段中每項要求使用的憑證,都必須屬於同一個 Google Cloud 控制台專案。工作階段結束後,符記就會失效。您的應用程式必須為每個工作階段產生新的符記。如果省略 session_token 參數或重複使用工作階段符記,系統會視為未提供工作階段符記,並針對工作階段收費 (每個要求分別收費)。

建議遵循下列準則:

  • 在所有 Place Autocomplete 呼叫中使用工作階段符記。
  • 為每個工作階段產生新的符記。建議使用第 4 版 UUID。
  • 請確保工作階段中所有 Place Autocomplete、Place Details 和地址驗證要求使用的憑證,都屬於同一個 Cloud 控制台專案。
  • 請務必針對每個新的工作階段傳遞不重複的工作階段符記。如果多個工作階段使用同一個符記,則每個要求會分別計費。
include_pure_service_area_businesses

bool

(選用步驟) 如果欄位設為 true,則納入完全無店面區域商家。無店面區域商家會直接配送或到場服務,但不在商家地址為顧客提供服務。例如清潔或水電服務。這些商家在 Google 地圖上沒有實體地址或位置。對於這類商家,Places 不會傳回 locationplus_code 和其他地點相關欄位。

include_future_opening_businesses

bool

(選用步驟) 如果設為 true,則包含尚未開幕但未來會開幕的商家。

LocationBias

要搜尋的區域。結果可能會偏向指定區域。

欄位

聯集欄位 type

type 只能是下列其中一項:

rectangle

Viewport

由東北角和西南角定義的檢視區塊。

circle

Circle

以中心點和半徑定義的圓形。

LocationRestriction

要搜尋的區域。結果會限制在指定區域內。

欄位

聯集欄位 type

type 只能是下列其中一項:

rectangle

Viewport

由東北角和西南角定義的檢視區塊。

circle

Circle

以中心點和半徑定義的圓形。

AutocompletePlacesResponse

AutocompletePlaces 的回應 Proto。

欄位
suggestions[]

Suggestion

內含建議清單,並依關聯性遞減排序。

建議

自動完成建議結果。

欄位

聯集欄位 kind

kind 只能是下列其中一項:

place_prediction

PlacePrediction

地點的預測結果。

query_prediction

QueryPrediction

查詢的預測結果。

FormattableText

代表地點或查詢預測的文字。你可以直接使用或設定格式。

欄位
text

string

可直接使用或以 matches 格式化的文字。

matches[]

StringRange

字串範圍清單,用於識別輸入要求在 text 中相符的位置。這些範圍可用於格式化 text 的特定部分。如果系統是根據字串比對以外的條件 (例如拼寫校正或音譯) 判斷是否相符,子字串可能不會與 input 完全相符。

這些值是 text 的 Unicode 字元偏移。系統保證範圍會依遞增的位移值排序。

PlacePrediction

Place Autocomplete 自動預測的預測結果。

欄位
place

string

建議地點的資源名稱。這個名稱可用於接受地點名稱的其他 API。

place_id

string

建議地點的專屬 ID。這個 ID 可用於接受地點 ID 的其他 API。

text

FormattableText

包含傳回結果的使用者可解讀名稱。如果是機構結果,通常會顯示商家名稱和地址。

建議想顯示單一 UI 元素的開發人員使用 text。如果開發人員想顯示兩個獨立但相關的 UI 元素,可以改用 structured_format。這兩種方式代表的地點預測結果不同。使用者不應嘗試剖析 structured_formattext,反之亦然。

這段文字可能與 GetPlace 傳回的 display_name 不同。

如果要求 inputlanguage_code 使用不同語言,或地點沒有從當地語言到 language_code 的翻譯,則可能以混合語言顯示。

structured_format

StructuredFormat

地點預測會細分為主要文字 (包含地點名稱) 和次要文字 (包含其他消歧特徵,例如城市或區域)。

如果開發人員想顯示兩個獨立但相關的 UI 元素,建議使用 structured_format。如要顯示單一 UI 元素,開發人員可以改用 text。這兩種方式代表的地點預測結果不同。使用者不應嘗試剖析 structured_formattext,反之亦然。

types[]

string

適用於這個地點的類型清單,請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types 中的表 A 或表 B。

類型是地點的分類。類型相同的地點會具有相似特徵。

distance_meters

int32

如果指定 origin,則為從 origin 開始的測地線長度 (以公尺為單位)。部分預測 (例如路線) 可能不會填入這個欄位。

QueryPrediction

查詢自動預測的預測結果。

欄位
text

FormattableText

預測文字。這段文字並非代表地點,而是可用於搜尋端點 (例如 Text Search) 的文字查詢。

建議想顯示單一 UI 元素的開發人員使用 text。如果開發人員想顯示兩個獨立但相關的 UI 元素,可以改用 structured_format。這兩種方式都能代表查詢預測。使用者不應嘗試剖析 structured_formattext,反之亦然。

如果要求 inputlanguage_code 使用不同語言,或查詢的部分內容沒有從當地語言到 language_code 的翻譯,則可能使用混合語言。

structured_format

StructuredFormat

查詢預測的細目,包括含有查詢內容的主要文字,以及含有其他消歧特徵 (例如城市或區域) 的次要文字。

如果開發人員想顯示兩個獨立但相關的 UI 元素,建議使用 structured_format。如要顯示單一 UI 元素,開發人員可以改用 text。這兩種方式都能代表查詢預測。使用者不應嘗試剖析 structured_formattext,反之亦然。

StringRange

識別指定文字中的子字串。

欄位
start_offset

int32

字串第一個 Unicode 字元的位移值 (從零算起,含該字元)。

end_offset

int32

最後一個 Unicode 字元的零起點偏移 (不含該值)。

StructuredFormat

包含地點或查詢預測結果的細目,分為主要文字和次要文字。

如果是地點預測,主要文字會包含地點的具體名稱。如果是查詢預測,主要文字會包含查詢內容。

次要文字包含其他消歧特徵 (例如城市或區域),可進一步識別地點或修正查詢。

欄位
main_text

FormattableText

代表地點或查詢的名稱。

secondary_text

FormattableText

代表其他消歧特徵 (例如城市或區域),可進一步識別地點或修正查詢。

圓形

以 LatLng 為中心和半徑的圓形。

欄位
center

LatLng

必填。中心經緯度。

緯度範圍必須介於 [-90.0, 90.0] 之間。經度範圍必須介於 [-180.0, 180.0] 之間。

radius

double

必填。半徑 (以公尺為單位)。半徑必須介於 [0.0, 50000.0] 之間。

ContentBlock

可單獨放送的內容區塊。

欄位
content

LocalizedText

與主題相關的內容。

referenced_places[]

string

所參照地點的資源名稱清單。這個名稱可用於接受地點資源名稱的其他 API。

ContextualContent

與地點查詢相關的內容。

欄位
reviews[]

Review

這個地點的評論清單,與地點查詢相關。

photos[]

Photo

這個地點的相片相關資訊 (包括參照),與地點查詢相關。

justifications[]

Justification

地點的說明。

原因

地點的說明。理由會回答地點為何可能吸引使用者的問題。

欄位

聯集欄位 justification

justification 只能是下列其中一項:

review_justification

ReviewJustification

business_availability_attributes_justification

BusinessAvailabilityAttributesJustification

BusinessAvailabilityAttributesJustification

BusinessAvailabilityAttributes 的理由。這會顯示商家的一些屬性,可能會吸引使用者。

欄位
takeout

bool

商家是否提供外帶服務。

delivery

bool

商家是否提供外送服務。

dine_in

bool

如果地點提供內用服務。

ReviewJustification

使用者評論的理由。這會醒目顯示使用者評論中,使用者感興趣的部分。舉例來說,如果搜尋查詢是「柴燒披薩」,評論理由就會醒目顯示與搜尋查詢相關的文字。

欄位
highlighted_text

HighlightedText

review

Review

生成反白顯示文字的評論。

HighlightedText

正當理由醒目顯示的文字。這是審查作業的一部分。要醒目顯示的確切字詞會以 HighlightedTextRange 標記。醒目顯示的文字可能包含多個字詞。

欄位
text

string

highlighted_text_ranges[]

HighlightedTextRange

醒目顯示文字的範圍清單。

HighlightedTextRange

醒目顯示文字的範圍。

欄位
start_index

int32

end_index

int32

EVChargeOptions

地點中電動車充電站的相關資訊。術語遵循 https://afdc.energy.gov/fuels/electricity_infrastructure.html。一個充電埠一次只能為一輛車充電。一個連接埠有一或多個連接器。一個充電站有一或多個充電座。

欄位
connector_count

int32

這個充電站的連接器數量。不過,由於部分充電埠可能有多個接頭,但一次只能為一輛車充電 (例如),因此接頭數量可能會大於可同時充電的車輛總數。

connector_aggregation[]

ConnectorAggregation

電動車充電接頭匯總清單,包含相同類型和相同充電速率的接頭。

ConnectorAggregation

電動車充電資訊,依 [type, max_charge_rate_kw] 分組。顯示相同類型且最大充電率 (以千瓦為單位) 相同的充電器匯總充電量。

欄位
type

EVConnectorType

這個匯總的連接器類型。

max_charge_rate_kw

double

匯總中每個連接器的靜態最大充電速率 (以千瓦為單位)。

count

int32

這個匯總中的連接器數量。

availability_last_update_time

Timestamp

上次更新這個彙整資料中連接器可用性資訊的時間戳記。

available_count

int32

這個彙整中目前可用的連接器數量。

out_of_service_count

int32

這個匯總中目前無法使用的連接器數量。

EVConnectorType

如要進一步瞭解電動車充電接頭類型,請參閱 http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=6872107

列舉
EV_CONNECTOR_TYPE_UNSPECIFIED 未指定連接器。
EV_CONNECTOR_TYPE_OTHER 其他連接器類型。
EV_CONNECTOR_TYPE_J1772 J1772 第 1 型連接器。
EV_CONNECTOR_TYPE_TYPE_2 IEC 62196 Type 2 連接器。通常稱為 MENNEKES。
EV_CONNECTOR_TYPE_CHADEMO CHAdeMO 型連接器。
EV_CONNECTOR_TYPE_CCS_COMBO_1 複合式充電系統 (AC 和 DC)。以 SAE 為準。Type-1 J-1772 連接器
EV_CONNECTOR_TYPE_CCS_COMBO_2 複合式充電系統 (AC 和 DC)。以 Type-2 Mennekes 連接器為基礎
EV_CONNECTOR_TYPE_TESLA 一般 TESLA 連接器。北美地區採用 NACS,但世界其他地區可能採用非 NACS 標準 (例如 CCS Combo 2 (CCS2) 或 GB/T)。這個值較不能代表實際的連接器類型,而是代表在 Tesla 自有充電站為 Tesla 品牌車輛充電的能力。
EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T GB/T 類型對應中國的 GB/T 標準。這種類型涵蓋所有 GB_T 類型。
EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET 未指定電源插座。
EV_CONNECTOR_TYPE_NACS 北美充電系統 (NACS),已標準化為 SAE J3400。

FuelOptions

加油站的最新燃料選項資訊。這項資訊會定期更新。

欄位
fuel_prices[]

FuelPrice

加油站提供的各類燃料的最後已知價格。每個加油站的每種燃料類型都有一筆資料。順序並不重要。

FuelPrice

特定類型的燃料價格資訊。

欄位
type

FuelType

燃料類型。

price

Money

燃料價格。

update_time

Timestamp

上次更新油價的時間。

FuelType

燃料類型。

列舉
FUEL_TYPE_UNSPECIFIED 未指定燃料類型。
DIESEL 柴油。
DIESEL_PLUS 柴油加燃料。
REGULAR_UNLEADED 一般無鉛汽油。
MIDGRADE 中級。
PREMIUM Premium。
SP91 SP 91。
SP91_E10 SP 91 E10。
SP92 SP 92。
SP95 SP 95。
SP95_E10 SP95 E10。
SP98 SP 98。
SP99 SP 99。
SP100 SP 100。
LPG 液化石油氣。
E80 E 80。
E85 E 85。
E100 E 100。
METHANE 甲烷。
BIO_DIESEL 生質柴油。
TRUCK_DIESEL 卡車柴油。

GetPhotoMediaRequest

要求使用相片資源名稱擷取地點相片。

欄位
name

string

必填。相片媒體的資源名稱,格式為:places/{place_id}/photos/{photo_reference}/media

地點物件 photos.name 欄位中傳回的相片資源名稱格式為 places/{place_id}/photos/{photo_reference}。您需要在相片資源結尾附加 /media,才能取得相片媒體資源名稱。

max_width_px

int32

(選用步驟) 指定圖片的寬度上限 (以像素為單位)。如果圖片小於指定值,系統會傳回原始圖片。如果圖片任一維度較大,系統會縮放圖片,使較小的維度符合限制,並保留原始顯示比例。max_height_px 和 max_width_px 屬性都接受介於 1 到 4800 之間的整數 (含 1 和 4800)。如果值超出允許範圍,系統會傳回 INVALID_ARGUMENT 錯誤。

至少須指定 max_height_px 或 max_width_px。如果未指定 max_height_px 和 max_width_px,系統會傳回 INVALID_ARGUMENT 錯誤。

max_height_px

int32

(選用步驟) 指定圖片的高度上限 (以像素為單位)。如果圖片小於指定值,系統會傳回原始圖片。如果圖片任一維度較大,系統會縮放圖片,使較小的維度符合限制,並保留原始顯示比例。max_height_px 和 max_width_px 屬性都接受介於 1 到 4800 之間的整數 (含 1 和 4800)。如果值超出允許範圍,系統會傳回 INVALID_ARGUMENT 錯誤。

至少須指定 max_height_px 或 max_width_px。如果未指定 max_height_px 和 max_width_px,系統會傳回 INVALID_ARGUMENT 錯誤。

skip_http_redirect

bool

(選用步驟) 如果已設定,則略過預設的 HTTP 重新導向行為,並以文字格式 (例如 HTTP 用途的 JSON 格式) 呈現回應。如果未設定,系統會發出 HTTP 重新導向,將呼叫重新導向至圖片媒體。非 HTTP 要求會忽略這個選項。

GetPlaceRequest

要求根據資源名稱擷取地點,資源名稱為 places/{place_id} 格式的字串。

欄位
name

string

必填。地點的資源名稱,格式為 places/{place_id}

language_code

string

(選用步驟) 如果地點詳細資料有提供偏好語言版本,系統就會顯示該版本。

目前支援的語言清單:https://developers.google.com/maps/faq#languagesupport

region_code

string

(選用步驟) 要求來源地點的 Unicode 國家/地區代碼 (CLDR)。這個參數用於顯示地點詳細資料,例如特定地區的地點名稱 (如有)。根據適用法律,這項參數可能會影響結果。詳情請參閱 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

請注意,系統目前不支援 3 位數的區域代碼。

session_token

string

(選用步驟) 用於計費的 Autocomplete 工作階段 ID 字串。必須是網址和檔案名稱安全 Base64 字串,長度最多為 36 個 ASCII 字元。否則會傳回 INVALID_ARGUMENT 錯誤。

工作階段是從使用者輸入查詢時開始,到使用者選取地點並呼叫 Place Details 或地址驗證時結束。在每個工作階段中,使用者可以輸入多筆查詢,最終提出一項 Place Details 或地址驗證要求。工作階段中每項要求使用的憑證,都必須屬於同一個 Google Cloud 控制台專案。工作階段結束後,符記就會失效。您的應用程式必須為每個工作階段產生新的符記。如果省略 session_token 參數或重複使用工作階段符記,系統會視為未提供工作階段符記,並針對工作階段收費 (每個要求分別收費)。

建議遵循下列準則:

  • 在所有 Place Autocomplete 呼叫中使用工作階段符記。
  • 為每個工作階段產生新的符記。建議使用第 4 版 UUID。
  • 請確保工作階段中所有 Place Autocomplete、Place Details 和地址驗證要求使用的憑證,都屬於同一個 Cloud 控制台專案。
  • 請務必針對每個新的工作階段傳遞不重複的工作階段符記。如果多個工作階段使用同一個符記,則每個要求會分別計費。

相片

地點相片的相關資訊。

欄位
name

string

ID。代表這張地點相片的參照,可用於再次查詢這張地點相片 (也稱為 API「資源」名稱:places/{place_id}/photos/{photo})。

width_px

int32

最大可用寬度 (以像素為單位)。

height_px

int32

可用的最大高度 (以像素為單位)。

author_attributions[]

AuthorAttribution

這張相片的作者。

flag_content_uri

string

使用者可透過這個連結檢舉相片問題。

google_maps_uri

string

顯示 Google 地圖上相片的連結。

PhotoMedia

Places API 中的相片媒體。

欄位
name

string

相片媒體的資源名稱,格式為:places/{place_id}/photos/{photo_reference}/media

photo_uri

string

可用於算繪相片的短期 URI。

地點

代表地點的所有資訊。

欄位
name

string

這個地點的資源名稱,格式為 places/{place_id}。可用於查詢地點。

id

string

地點的專屬 ID。

display_name

LocalizedText

地點的本地化名稱,適合做為簡短的人類可讀說明。例如「Google Sydney」、「Starbucks」、「Pyrmont」等。

types[]

string

這項結果的類型標記組合。例如「政治」和「所在地」。如需可能值的完整清單,請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types 的表 A 和表 B。

primary_type

string

指定結果的主要類型。類型必須是 Places API 支援的類型。例如「餐廳」、「咖啡廳」、「機場」等。一個地點只能有一個主要類型。如需可能值的完整清單,請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types 的表 A 和表 B。如果地點的主要類型不受支援,可能就不會顯示主要類型。如果存在主要類型,則一律為 types 欄位中的其中一種。

primary_type_display_name

LocalizedText

主要類型的顯示名稱,如適用,會根據要求語言進行本地化。如需可能值的完整清單,請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types 的表 A 和表 B。如果地點的主要類型不受支援,可能就不會顯示主要類型。

google_maps_type_label

LocalizedText

Google 地圖上地點的類型標籤,會視情況以要求語言在地化,例如「餐廳」、「咖啡廳」、「機場」等。類型標籤可能與主要類型顯示名稱不同,且可能不是Places API 地點類型表格中支援的類型。

national_phone_number

string

使用者可解讀的地點電話號碼 (國內電話號碼格式)。

international_phone_number

string

地點的電話號碼 (國際電話號碼格式,使用者可解讀)。

formatted_address

string

這個地點的完整地址,方便使用者閱讀。

short_formatted_address

string

這個地點的簡短地址,方便使用者閱讀。

postal_address

PostalAddress

郵寄地址格式的地址。

address_components[]

AddressComponent

每個地區層級的重複元件。請注意 address_components[] 陣列的下列事項:- 地址元件陣列包含的元件可能比 formatted_address 更多。- 除了 formatted_address 中所含的政治實體以外,這個陣列不一定會納入內含地址的所有政治實體。如要擷取包含特定地址的所有政治實體,建議您使用反向地理編碼,將地址的經緯度做為參數傳遞至要求。- 兩次要求之間的回應格式不一定相同。特別是,address_components 的數量會因要求的地址而異,對於同一個地址,數量也可能會隨時間改變。元件在陣列中的位置可能會變更。元件類型也可能會變更。後續回應中可能會缺少特定元件。

plus_code

PlusCode

地點位置的 Plus Code (緯度/經度)。

location

LatLng

這個地點的位置。

viewport

Viewport

適合在一般大小的地圖上顯示地點的可視區域。這個可視範圍不應做為商家的實體邊界或服務範圍。

rating

double

根據使用者對這個地點的評論,評分介於 1.0 和 5.0。

google_maps_uri

string

提供這個地點相關資訊的網址。

website_uri

string

這個地點的官方網站,例如商家的首頁。請注意,如果是連鎖店 (例如 IKEA 商店),這通常會是個別商店的網站,而非整個連鎖店的網站。

reviews[]

Review

這個地點的評論清單,依關聯性排序。最多可傳回 5 則評論。

photos[]

Photo

這個地點的相片相關資訊 (包括參照)。最多可傳回 10 張相片。

adr_format_address

string

adr 微格式的地址:http://microformats.org/wiki/adr

business_status

BusinessStatus

地點的營業狀態。

opening_date

Date

這個地點未來的開業日期。只有在商家狀態為 FUTURE_OPENING 時,才會填入這個欄位。

price_level

PriceLevel

地點的價格等級。

attributions[]

Attribution

必須與這項結果一起顯示的資料提供者。

icon_mask_base_uri

string

圖示遮罩的截斷網址。使用者可以在結尾附加類型後置字元 (例如「.svg」或「.png」),存取不同類型的圖示。

icon_background_color

string

圖示遮罩的背景顏色,格式為十六進位,例如 #909CE1。

current_opening_hours

OpeningHours

未來七天 (包括今天) 的營業時間,包含任何特殊營業時間。時間範圍從要求當天的午夜開始,到六天後的晚上 11:59 結束。如果實際營業時間超出這個範圍,系統會截斷營業時間。舉例來說,如果某個地點從昨天晚上 10 點營業到今天早上 6 點,系統會將營業時間截斷為今天凌晨 12 點到今天早上 6 點。這個欄位包含所有營業時間的 special_days 子欄位,適用於營業時間與平常不同的日期。

regular_opening_hours

OpeningHours

一般營業時間是指地點在一般時間表上的營業時間。請注意,如果地點全年無休 (24 小時),系統就不會設定 close 欄位。如果用戶端要表示「全年無休 (24 小時)」,可以將 open 時間中 day 的值設為 0hour 的值設為 0,以及 minute 的值設為 0

current_secondary_opening_hours[]

OpeningHours

包含未來七天的項目陣列,包括商家次要營業時間的相關資訊。次要營業時間與商家的主要營業時間不同。舉例來說,餐廳可以將得來速或外送時間設為次要營業時間。這個欄位會根據地點類型,從預先定義的營業時間類型清單 (例如 DRIVE_THROUGH、PICKUP 或 TAKEOUT) 填入類型子欄位。這個欄位包含所有營業時間的 special_days 子欄位,適用於營業時間與平常不同的日期。

regular_secondary_opening_hours[]

OpeningHours

內含商家一般次要營業時間的資訊項目陣列。次要營業時間與商家的主要營業時間不同。舉例來說,餐廳可以將得來速或外送時間設為次要營業時間。這個欄位會根據地點類型,從預先定義的營業時間類型清單 (例如 DRIVE_THROUGH、PICKUP 或 TAKEOUT) 填入類型子欄位。

time_zone

TimeZone

IANA 時區資料庫時區。例如「America/New_York」。

editorial_summary

LocalizedText

含有地點摘要。摘要包含文字總覽,以及這些文字的語言代碼 (如適用)。摘要文字必須照實呈現,不得修改或變更。

payment_options

PaymentOptions

商家接受的付款方式。如果沒有付款方式資料,系統會取消設定付款方式欄位。

parking_options

ParkingOptions

地點提供的停車選項。

sub_destinations[]

SubDestination

與地點相關的子目的地清單。

fuel_options

FuelOptions

加油站的最新燃料選項資訊。這項資訊會定期更新。

ev_charge_options

EVChargeOptions

電動車充電選項的相關資訊。

generative_summary

GenerativeSummary

地點的 AI 生成摘要。

containing_places[]

ContainingPlace

目前地點所在的地區清單。

address_descriptor

AddressDescriptor

地點的地址描述符。地址描述元包含額外資訊,可協助您使用地標和區域描述位置。如要查看地址描述符的區域涵蓋範圍,請參閱 https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage

price_range

PriceRange

與地點相關聯的價格範圍。

review_summary

ReviewSummary

使用使用者評論生成的地點摘要。

ev_charge_amenity_summary

EvChargeAmenitySummary

電動車充電站附近的設施摘要。

neighborhood_summary

NeighborhoodSummary

地點附近的搜尋點摘要。

consumer_alert

ConsumerAlert

如果我們在商家評論偵測到可疑的活動,或是商家違反 Google 政策,系統會顯示地點的消費者警示訊息。

moved_place

string

如果這個地點已永久歇業並搬遷至新地點,這個欄位會包含新地點的資源名稱,格式為 places/{place_id}。如果這個地點多次搬遷,此欄位會顯示第一次搬遷的地點。如果商家未搬遷,這個欄位就不會填入資料。

moved_place_id

string

如果這個地點已永久歇業並搬遷至新地點,這個欄位會包含新地點的 ID。如果這個地點多次搬遷,這個欄位會顯示第一次搬遷的地點。如果商家未搬遷,這個欄位就不會填入資料。

transit_station

TransitStation

該地點的大眾運輸站資訊。

entrances[]

Entrance

這個目的地的入口。

navigation_points[]

NavigationPoint

這個目的地的導航點。

user_rating_count

int32

這個地點的評論總數 (無論是否包含文字)。

takeout

bool

指定商家是否支援外帶。

delivery

bool

指定商家是否支援外送。

dine_in

bool

指定商家是否提供室內或室外雅座。

curbside_pickup

bool

指定商家是否支援路邊取餐。

reservable

bool

指出地點是否支援預訂。

serves_breakfast

bool

指定商家是否供應早餐。

serves_lunch

bool

指定該場所是否供應午餐。

serves_dinner

bool

指定該場所是否供應晚餐。

serves_beer

bool

指定地點是否供應啤酒。

serves_wine

bool

指定地點是否供應葡萄酒。

serves_brunch

bool

指定地點是否供應早午餐。

serves_vegetarian_food

bool

指定該場所是否供應素食餐點。

utc_offset_minutes

int32

這個地點的時區目前與世界標準時間的時差 (以分鐘為單位)。以分鐘為單位表示,支援時差為幾小時又幾分鐘的時區,例如 X 小時 15 分鐘。

outdoor_seating

bool

提供戶外座位。

live_music

bool

提供現場音樂表演。

menu_for_children

bool

提供兒童菜單。

serves_cocktails

bool

供應雞尾酒。

serves_dessert

bool

提供甜點。

serves_coffee

bool

供應咖啡。

good_for_children

bool

適合兒童。

allows_dogs

bool

可帶狗入內。

restroom

bool

地點設有洗手間。

good_for_groups

bool

場所可容納團體。

good_for_watching_sports

bool

適合觀看運動賽事。

accessibility_options

AccessibilityOptions

地點提供的無障礙選項相關資訊。

pure_service_area_business

bool

指出地點是否為完全無店面區域商家。無店面區域商家會直接配送或到場服務,但不在商家地址為顧客提供服務。例如清潔或水電服務。這些商家可能沒有實體地址,或未顯示在 Google 地圖上。

AccessibilityOptions

地點提供的無障礙選項相關資訊。

欄位
wheelchair_accessible_parking

bool

地點提供無障礙停車位。

wheelchair_accessible_entrance

bool

地點設有無障礙入口。

wheelchair_accessible_restroom

bool

地點提供無障礙洗手間。

wheelchair_accessible_seating

bool

場地提供無障礙座位。

AddressComponent

組成格式化地址的結構化元件 (如有)。

欄位
long_text

string

地址元件的完整文字說明或名稱。舉例來說,澳洲地址元件的 long_name 可能為「澳洲」。

short_text

string

地址元件的縮寫文字名稱 (如有)。舉例來說,澳洲地址元件的 short_name 可能為「AU」。

types[]

string

指出地址元件類型的陣列。

language_code

string

以 CLDR 標記表示的語言,用於設定這個元件的格式。

歸因

這個地點的資料供應商資訊。

欄位
provider

string

地點資料供應商的名稱。

provider_uri

string

地點資料供應商的 URI。

BusinessStatus

地點的營業狀態。

列舉
BUSINESS_STATUS_UNSPECIFIED 預設值。這個值不會使用。
OPERATIONAL 商家正在營業,但不一定現在營業。
CLOSED_TEMPORARILY 該商家暫停營業。
CLOSED_PERMANENTLY 該商家已永久歇業。
FUTURE_OPENING 該商家日後會營業。

ConsumerAlert

如果我們在商家評論偵測到可疑的活動,或是商家違反 Google 政策,系統會顯示地點的消費者警示訊息。

欄位
overview

string

消費者快訊訊息總覽。

details

Details

消費者快訊訊息的詳細資料。

language_code

string

消費者警示訊息的語言代碼。這是 BCP 47 語言代碼。

詳細資料

消費者快訊訊息的詳細資料。

欄位
title

string

與說明一起顯示的標題。

description

string

消費者快訊訊息的說明。

ContainingPlace

這個地點所在位置的相關資訊。

欄位
name

string

這個地點所在的資源名稱。

id

string

這個地點所在的場所 ID。

入口位置

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

欄位
location

LatLng

入口位置。

tags[]

Tag

描述入口的標記清單。

標記

描述入口的特徵。

列舉
TAG_UNSPECIFIED 未使用。
PREFERRED

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

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

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

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

EvChargeAmenitySummary

電動車充電站附近的設施摘要。這項功能僅適用於類型為 electric_vehicle_charging_station 的地點。系統保證會提供 overview 欄位,其他欄位則為選填。

欄位
overview

ContentBlock

可用的設施總覽。我們保證會提供這項服務。

coffee

ContentBlock

附近咖啡店的摘要。

restaurant

ContentBlock

附近餐廳的摘要。

store

ContentBlock

附近商店的摘要。

flag_content_uri

string

使用者可透過這個連結回報摘要問題。

disclosure_text

LocalizedText

「使用 Gemini 摘要」AI 揭露訊息 (以及本地化變體)。如果要求中指定的語言有提供這類資訊,就會以該語言顯示。

GenerativeSummary

地點的 AI 生成摘要。

欄位
overview

LocalizedText

地點總覽。

overview_flag_content_uri

string

使用者可透過這個連結檢舉總覽摘要的問題。

disclosure_text

LocalizedText

「使用 Gemini 摘要」AI 揭露訊息 (以及本地化變體)。如果要求中指定的語言有提供這類資訊,就會以該語言顯示。

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

欄位
navigation_point_token

string

可用於識別這個導航點的符記。

display_name

LocalizedText

這個導覽點的顯示名稱。例如「5th Ave」或「Gate B」。

location

LatLng

導航應該結束的路段旁邊的點。該點會刻意稍微偏離道路中心線,清楚標示地點所在的道路側。

travel_modes[]

TravelMode

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

usages[]

Usage

列出這個導覽點支援的清單 usages。如果空白,不一定表示其使用方式受到任何限制。所有導航點都可用於一般導航。

TravelMode

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

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

用量

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

列舉
USAGE_UNSPECIFIED 未使用。
DROPOFF 適合讓乘客下車。例如共乘服務的下車地點。
PICKUP 適合接送乘客。例如共乘服務的上車地點。
PARKING 適合停車。例如停車場內。

NeighborhoodSummary

地點附近的搜尋點摘要。

欄位
overview

ContentBlock

社區的簡要總覽。

description

ContentBlock

社區的詳細說明。

flag_content_uri

string

使用者可透過這個連結回報摘要問題。

disclosure_text

LocalizedText

「使用 Gemini 摘要」AI 揭露訊息 (以及本地化變體)。如果要求中指定的語言有提供這類資訊,就會以該語言顯示。

OpeningHours

地點的營業時間資訊。

欄位
periods[]

Period

這個地點在一週內的營業時段。系統會依時間順序顯示各個時段,並以地點的當地時區為準。如果值為空白 (但並非不存在),表示地點從未營業,例如因整修而暫時關閉。

periods 的起始日「並非」固定,且不應假設為星期日。API 會根據多種因素決定開始日期,舉例來說,如果商家全年無休,第一個週期可能會從提出要求的當天開始。其他商家則可能是每週的第一個營業日。

注意:periods 陣列的順序與 weekday_descriptions 陣列的順序無關。請勿假設兩者會在同一天開始。

weekday_descriptions[]

string

描述這個地點營業時間的本地化字串,一週內每天各有一個字串。

注意:一週的開始日期和星期順序取決於語言和區域設定。periods 陣列的順序與 weekday_descriptions 陣列的順序無關。請勿假設兩者會在同一天開始。

如果營業時間不明或無法轉換為本地化文字,這個欄位會是空白。例如:「Sun: 18:00–06:00」

secondary_hours_type

SecondaryHoursType

用於識別次要營業時間類型的類型字串。

special_days[]

SpecialDay

特殊日期的結構化資訊,這些日期必須在退回營業時間涵蓋的期間內。特殊日子是指可能會影響地點營業時間的日子,例如聖誕節。如有特殊營業時間,請為 current_opening_hours 和 current_secondary_opening_hours 設定。

next_open_time

Timestamp

下次營業時間週期開始的時間,最晚為未來 7 天內。只有在放送請求時營業時間未生效,系統才會填入這個欄位。

next_close_time

Timestamp

下次營業時間結束的時間點,最遠可設為 7 天後。只有在放送請求時,營業時間時段處於有效狀態,這個欄位才會填入資料。

open_now

bool

營業時間是否有效。如果是正常營業時間和目前營業時間,這個欄位表示該地點是否營業中。如果是次要營業時間和目前的次要營業時間,這個欄位表示該地點的次要營業時間是否有效。

期間

地點處於 open_now 狀態的期間。

欄位
open

Point

地點開始營業的時間。

close

Point

商家開始停業的時間。

狀態變更點。

欄位
date

Date

地點所在時區的日期。

truncated

bool

這個端點是否遭到截斷。如果實際營業時間超出我們願意回報的時間範圍,系統就會截斷時間,將營業時間截斷至這些界線。這可確保系統最多會傳回自要求當天午夜起算的 24 * 7 小時。

day

int32

星期幾,以 0 到 6 之間的整數表示。0 代表星期日,1 代表星期一,以此類推。

hour

int32

以 24 小時制表示的小時。範圍為 0 到 23。

minute

int32

分鐘。範圍為 0 到 59。

SecondaryHoursType

用於識別次要時數類型的類型。

列舉
SECONDARY_HOURS_TYPE_UNSPECIFIED 未指定次要時數類型時的預設值。
DRIVE_THROUGH 銀行、餐廳或藥局的得來速營業時間。
HAPPY_HOUR 歡樂時段。
DELIVERY 送達時間。
TAKEOUT 外帶時段。
KITCHEN 廚房時間。
BREAKFAST 早餐時間。
LUNCH 午餐時間。
DINNER 晚餐時間。
BRUNCH 早午餐時段。
PICKUP 取貨時間。
ACCESS 儲存空間的開放時間。
SENIOR_HOURS 年長者專屬的特殊營業時間。
ONLINE_SERVICE_HOURS 線上服務時間。

SpecialDay

特殊日期的結構化資訊,這些日期必須在退回營業時間涵蓋的期間內。特殊日子是指可能會影響地點營業時間的日子,例如聖誕節。

欄位
date

Date

這個特別日期的日期。

ParkingOptions

地點的停車選項資訊。停車場可同時支援多個選項。

欄位
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

提供付費室內停車位。

PaymentOptions

商家接受的付款方式。

欄位
accepts_credit_cards

bool

商家接受信用卡付款。

accepts_debit_cards

bool

商家接受簽帳金融卡付款。

accepts_cash_only

bool

商家只接受現金付款。提供這項屬性的商家可能仍接受其他付款方式。

accepts_nfc

bool

商家接受 NFC 付款。

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」,包含全球代碼的後置字串,並以格式化的參照實體名稱取代前置字串。

ReviewSummary

使用使用者評論生成的地點摘要。

欄位
text

LocalizedText

使用者評論摘要。

flag_content_uri

string

使用者可透過這個連結回報摘要問題。

disclosure_text

LocalizedText

「使用 Gemini 摘要」AI 揭露訊息 (以及本地化變體)。如果要求中指定的語言有提供這類資訊,就會以該語言顯示。

reviews_uri

string

在 Google 地圖上顯示這個地點評論的連結。

SubDestination

子目的地是指與主要地點相關聯的特定地點,如果使用者在機場、國家公園、大學或體育場等大型或複雜地點內搜尋,這些地圖會提供更明確的目的地。舉例來說,機場的子目的地可能包括相關聯的航廈和停車場。子目的地會傳回地點 ID 和地點資源名稱,可用於後續的 Place Details (New) 要求,擷取更豐富的詳細資料,包括子目的地的顯示名稱和位置。

欄位
name

string

子目的地資源名稱。

id

string

子目的地的地點 ID。

折線

路線折線。僅支援編碼折線,可做為字串傳遞,並包含壓縮功能,可將損失降到最低。這是 Routes API 的預設輸出內容。

欄位
聯集欄位 polyline_type。封裝折線類型。Routes API 輸出內容預設為 encoded_polylinepolyline_type 只能是下列其中一項:
encoded_polyline

string

編碼後的折線Routes API 預設會傳回這項資訊。請參閱編碼器解碼器工具。

PriceLevel

地點的價格等級。

列舉
PRICE_LEVEL_UNSPECIFIED 地點價格等級未指定或不明。
PRICE_LEVEL_FREE 地點提供免費服務。
PRICE_LEVEL_INEXPENSIVE 提供平價服務。
PRICE_LEVEL_MODERATE 提供中等價位的服務。
PRICE_LEVEL_EXPENSIVE 地點提供高價服務。
PRICE_LEVEL_VERY_EXPENSIVE 地點提供的服務非常昂貴。

PriceRange

與地點相關聯的價格範圍。end_price 可以不設定,表示範圍沒有上限 (例如「超過 $100 美元」)。

欄位
start_price

Money

價格範圍的下限 (含)。價格應等於或高於這個金額。

end_price

Money

價格範圍的上限 (不含)。價格應低於這個金額。

查看

地點評論的相關資訊。

欄位
name

string

代表這則地點評論的參照,可用於再次查詢這則地點評論 (也稱為 API「資源」名稱:places/{place_id}/reviews/{review})。

relative_publish_time_description

string

格式化的近期時間字串,以適合語言和國家/地區的形式,表示相對於目前時間的評論時間。

text

LocalizedText

評論的本地化文字。

original_text

LocalizedText

評論原文。

rating

double

介於 1.0 到 5.0 之間的數字,也稱為星級數。

author_attribution

AuthorAttribution

這則評論的作者。

publish_time

Timestamp

評論的時間戳記。

flag_content_uri

string

使用者可透過這個連結檢舉評論問題。

google_maps_uri

string

可顯示 Google 地圖評論的連結。

visit_date

Date

作者造訪該地點的日期。這項資訊會截斷至造訪的年份和月份。

RouteModifiers

封裝一組選用條件,用於計算路徑時。

欄位
avoid_tolls

bool

(選用步驟) 如果設為 true,系統會盡量避開收費道路,優先選擇不含收費道路的路線。僅適用於 DRIVETWO_WHEELER TravelMode

avoid_highways

bool

(選用步驟) 如果設為 true,系統會盡量避開高速公路,優先選擇不含高速公路的路線。僅適用於 DRIVETWO_WHEELER TravelMode

avoid_ferries

bool

(選用步驟) 如果設為 true,系統會盡量避開渡輪,優先選擇不含渡輪的路線。僅適用於 DRIVETWO_WHEELER TravelMode

avoid_indoor

bool

(選用步驟) 如果設為 true,系統會盡量避開室內導航,優先選擇不含室內導航的路線。僅適用於 WALK TravelMode

RoutingParameters

設定路徑計算的參數,包括路徑上的地點 (會影響結果排名) 和計算結果的旅行時間。

欄位
origin

LatLng

(選用步驟) 明確的路線起點,會覆寫折線中定義的起點。根據預設,系統會使用折線來源。

travel_mode

TravelMode

(選用步驟) 交通方式。

route_modifiers

RouteModifiers

(選用步驟) 路徑修飾符。

routing_preference

RoutingPreference

(選用步驟) 指定如何計算路徑摘要。伺服器會嘗試使用所選的轉送偏好設定計算路徑。車流量監測路線偏好設定僅適用於 DRIVETWO_WHEELER travelMode

RoutingPreference

一組值,用於指定計算路線時要考量的因素。

列舉
ROUTING_PREFERENCE_UNSPECIFIED 未指定任何轉送偏好設定。預設值為 TRAFFIC_UNAWARE
TRAFFIC_UNAWARE 計算路徑時不會考量即時路況。如果路況不重要或不適用,就很適合使用這項功能。使用這個值可產生最低延遲時間。注意:如果是 TravelModeDRIVETWO_WHEELER,系統會根據路網及與時間無關的平均路況來選擇路線和時間,不會考量目前路況。因此,路線可能會包含暫時封閉的道路。受到路網變動、平均路況更新,以及這項服務的分散性質影響,特定要求的結果可能會隨時間而改變。此外,在時間或頻率都沒有限制的情況下,即使兩條路線幾乎相同,結果還是有可能不同。
TRAFFIC_AWARE 計算路線時會考量即時路況。與 TRAFFIC_AWARE_OPTIMAL 相比,部分最佳化項目可大幅縮短延遲時間。
TRAFFIC_AWARE_OPTIMAL 計算路線時會考量即時路況,但不套用大部分的效能最佳化設定。使用這個值會產生最高延遲。

RoutingSummary

從路線起點到回應中地點的距離和時間,以及從該地點到目的地的第二段路程 (如有要求)。注意:在欄位遮罩中加入 routingSummaries,但未在要求中加入 routingParameters.origin 參數或 searchAlongRouteParameters.polyline.encodedPolyline 參數,會導致錯誤。

欄位
legs[]

Leg

行程的各個路段。

從一組起點計算交通時間和距離時,legs 會包含單一路段,其中含有從起點到目的地的時間和距離。搜尋沿途路線時,legs 包含兩段路線:一段是從出發地到該地點,另一段是從該地點到目的地。

directions_uri

string

這個連結會使用指定路線摘要中的途經點,在 Google 地圖上顯示路線。這個連結產生的路線不一定與產生路線摘要的路線相同。連結會使用要求中提供的資訊 (包括 routingParameterssearchAlongRouteParameters 欄位,視情況而定),產生路線連結。

路段是指從一個地點到另一個地點的單一路程。

欄位
duration

Duration

完成這段行程所需的時間。

distance_meters

int32

這趟行程的距離。

SearchNearbyRequest

要求「搜尋附近」的 proto。

欄位
language_code

string

如果地點詳細資料有提供偏好語言版本,系統就會顯示該版本。如果語言代碼未指定或無法辨識,系統可能會傳回任何語言的商家詳細資料,如果這類詳細資料存在,則會優先傳回英文版本。

目前支援的語言清單:https://developers.google.com/maps/faq#languagesupport

region_code

string

要求來源地點的 Unicode 國家/地區代碼 (CLDR)。這個參數用於顯示地點詳細資料,例如特定地區的地點名稱 (如有)。根據適用法律,這項參數可能會影響結果。

詳情請參閱 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

請注意,系統目前不支援 3 位數的區域代碼。

included_types[]

string

包含的地點類型 (例如「restaurant」或「gas_station」),請參閱 https://developers.google.com/maps/documentation/places/web-service/place-types

最多可指定 表 A 中的 50 種類型。

如有任何衝突類型 (即類型同時出現在 included_types 和 excluded_types 中),系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定地點類型時設有多項限制,系統只會傳回符合所有限制的地點。舉例來說,如果我們有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},傳回的地點會提供「餐廳」相關服務,但主要業務並非「餐廳」。

excluded_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 排除地點類型 (例如「restaurant」或「gas_station」)。

最多可指定 表 A 中的 50 種類型。

如果用戶端同時提供 included_types (例如餐廳) 和 excluded_types (例如咖啡廳),則回應應包含餐廳,但不包含咖啡廳。回應會包含符合至少一個 included_types,且不符合任何 excluded_types 的地點。

如有任何衝突類型 (即類型同時出現在 included_types 和 excluded_types 中),系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定地點類型時設有多項限制,系統只會傳回符合所有限制的地點。舉例來說,如果我們有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},傳回的地點會提供「餐廳」相關服務,但主要業務並非「餐廳」。

included_primary_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 中包含的主要地點類型 (例如「restaurant」或「gas_station」)。一個地點只能與支援類型表中的單一主要類型建立關聯。

最多可指定 表 A 中的 50 種類型。

如有任何衝突的主要類型 (即類型同時出現在 included_primary_types 和 excluded_primary_types 中),系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定地點類型時設有多項限制,系統只會傳回符合所有限制的地點。舉例來說,如果我們有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},傳回的地點會提供「餐廳」相關服務,但主要業務並非「餐廳」。

excluded_primary_types[]

string

https://developers.google.com/maps/documentation/places/web-service/place-types 排除主要地點類型 (例如「restaurant」或「gas_station」)。

最多可指定 表 A 中的 50 種類型。

如有任何衝突的主要類型 (即類型同時出現在 included_primary_types 和 excluded_primary_types 中),系統會傳回 INVALID_ARGUMENT 錯誤。

如果指定地點類型時設有多項限制,系統只會傳回符合所有限制的地點。舉例來說,如果我們有 {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]},傳回的地點會提供「餐廳」相關服務,但主要業務並非「餐廳」。

max_result_count

int32

要傳回的結果數上限。這個值必須介於 1 和 20 之間 (預設值),如果未設定這個數字,系統會改用上限。如果數字設為負數或超過上限,系統會傳回 INVALID_ARGUMENT 錯誤。

location_restriction

LocationRestriction

必填。要搜尋的區域。

rank_preference

RankPreference

回覆中結果的排序方式。

routing_parameters

RoutingParameters

(選用步驟) 影響搜尋結果路徑的參數。

include_future_opening_businesses

bool

(選用步驟) 如果設為 true,則包含尚未開幕但未來會開幕的商家。

LocationRestriction

要搜尋的區域。

欄位

聯集欄位 type

type 只能是下列其中一項:

circle

Circle

以中心點和半徑定義的圓形。

RankPreference

回覆中結果的排序方式。

列舉
RANK_PREFERENCE_UNSPECIFIED 未設定 RankPreference 值。預設會使用「熱門程度」排名。
DISTANCE 依距離排序結果。
POPULARITY 依熱門程度排序結果。

SearchNearbyResponse

搜尋附近地點的回應 Proto。

欄位
places[]

Place

符合使用者需求的地點清單,例如地點類型、地點數量和特定地點限制。

routing_summaries[]

RoutingSummary

路徑摘要清單,每個項目都會與 places 欄位中相同索引的對應地點建立關聯。如果其中一個地點沒有路徑摘要,該項目會留空。如果系統要求,這份清單的項目數量應與地點清單相同。

SearchTextRequest

要求 SearchText 的 proto。

欄位
text_query

string

必填。文字搜尋的文字查詢。

language_code

string

如果地點詳細資料有提供偏好語言版本,系統就會顯示該版本。如果語言代碼未指定或無法辨識,系統可能會傳回任何語言的商家詳細資料,如果這類詳細資料存在,則會優先傳回英文版本。

目前支援的語言清單:https://developers.google.com/maps/faq#languagesupport

region_code

string

要求來源地點的 Unicode 國家/地區代碼 (CLDR)。這個參數用於顯示地點詳細資料,例如特定地區的地點名稱 (如有)。根據適用法律,這項參數可能會影響結果。

詳情請參閱 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html

請注意,系統目前不支援 3 位數的區域代碼。

rank_preference

RankPreference

回覆中結果的排序方式。

included_type

string

要求的地點類型。支援的類型完整清單:https://developers.google.com/maps/documentation/places/web-service/place-types。僅支援一種納入的類型。

open_now

bool

用於將搜尋範圍限制在目前營業中的地點。預設值為 false。

min_rating

double

篩除平均使用者評分嚴格低於此限制的結果。有效值必須是介於 0 到 5 (含) 之間的浮點數,且間隔為 0.5,也就是 [0、0.5、1.0、...、5.0] (含)。輸入的評分會無條件進位至最接近的 0.5。舉例來說,如果評分為 0.6,系統就會排除所有評分低於 1.0 的結果。

max_result_count
(deprecated)

int32

已淘汰:請改用 page_size

每頁可傳回的結果數上限。如果可用結果數量大於 max_result_count,系統會傳回 next_page_token,可將其傳遞至 page_token,在後續要求中取得下一頁結果。如果提供 0 或未提供任何值,系統會使用預設值 20。最大值為 20;超過 20 的值會強制設為 20。負值會傳回 INVALID_ARGUMENT 錯誤。

如果同時指定 max_result_countpage_size,系統會忽略 max_result_count

page_size

int32

(選用步驟) 每頁可傳回的結果數上限。如果可用結果數量大於 page_size,系統會傳回 next_page_token,可將其傳遞至 page_token,在後續要求中取得下一頁結果。如果提供 0 或未提供任何值,系統會使用預設值 20。最大值為 20;超過 20 的值會設為 20。負值會傳回 INVALID_ARGUMENT 錯誤。

如果同時指定 max_result_countpage_size,系統會忽略 max_result_count

page_token

string

(選用步驟) 屬於接收自前一個 TextSearch 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 TextSearch 的所有參數 (page_tokenpage_sizemax_result_count 除外) 須與提供網頁權杖的初始呼叫相符。否則會傳回 INVALID_ARGUMENT 錯誤。

price_levels[]

PriceLevel

用於將搜尋範圍限制在標示為特定價位的地點。使用者可以選擇任何價位組合。預設為選取所有價格等級。

strict_type_filtering

bool

用於為 included_type 設定嚴格的類型篩選條件。如果設為 true,系統只會傳回相同類型的結果。預設值為 false。

location_bias

LocationBias

要搜尋的區域。這個位置會做為偏誤,也就是說,系統可能會傳回指定位置附近的結果。無法與 location_restriction 一併設定。

location_restriction

LocationRestriction

要搜尋的區域。這個位置會做為限制條件,也就是說,系統不會傳回指定位置以外的結果。無法與 location_bias 一起設定。

ev_options

EVOptions

(選用步驟) 設定地點搜尋要求的電動車搜尋選項。

routing_parameters

RoutingParameters

(選用步驟) 將路徑導向結果的其他參數。

search_along_route_parameters

SearchAlongRouteParameters

(選用步驟) 沿路線搜尋時使用的額外參數 Proto。

include_pure_service_area_businesses

bool

(選用步驟) 如果欄位設為 true,則納入完全無店面區域商家。無店面區域商家會直接配送或到場服務,但不在商家地址為顧客提供服務。例如清潔或水電服務。這些商家在 Google 地圖上沒有實體地址或位置。對於這類商家,Places 不會傳回 locationplus_code 和其他地點相關欄位。

include_future_opening_businesses

bool

(選用步驟) 如果設為 true,則包含尚未開幕但未來會開幕的商家。

EVOptions

地點搜尋要求的電動車可搜尋選項。

欄位
minimum_charging_rate_kw

double

(選用步驟) 以千瓦為單位的最低充電速率。系統會篩除充電速率低於指定速率的地點。

connector_types[]

EVConnectorType

(選用步驟) 偏好的電動車充電插頭類型清單。系統會篩除不支援任何列出連接器類型的地點。

LocationBias

要搜尋的區域。這個位置會做為偏誤,也就是可能會傳回指定位置附近的結果。

欄位

聯集欄位 type

type 只能是下列其中一項:

rectangle

Viewport

由東北角和西南角定義的矩形方塊。rectangle.high() 必須是矩形檢視區塊的東北點。rectangle.low() 必須是矩形檢視區塊的西南點。rectangle.low().latitude() 不得大於 rectangle.high().latitude()。這會導致緯度範圍空白。矩形檢視區塊的寬度不得超過 180 度。

circle

Circle

以中心點和半徑定義的圓形。

LocationRestriction

要搜尋的區域。這個位置會做為限制條件,也就是說,系統不會傳回指定位置以外的結果。

欄位

聯集欄位 type

type 只能是下列其中一項:

rectangle

Viewport

由東北角和西南角定義的矩形方塊。rectangle.high() 必須是矩形檢視區塊的東北點。rectangle.low() 必須是矩形檢視區塊的西南點。rectangle.low().latitude() 不得大於 rectangle.high().latitude()。這會導致緯度範圍空白。矩形檢視區塊的寬度不得超過 180 度。

RankPreference

回覆中結果的排序方式。

列舉
RANK_PREFERENCE_UNSPECIFIED 如果是類別查詢 (例如「紐約市的餐廳」),系統預設會依「相關性」排序。對於非類別查詢 (例如「Mountain View, CA」),建議您將 rankPreference 設為未設定。
DISTANCE 依距離排序結果。
RELEVANCE 依關聯性排序結果。排序順序取決於一般排名堆疊。

SearchAlongRouteParameters

指定來自 Routes API 的預先計算折線,定義要搜尋的路徑。沿路線搜尋與使用 locationBiaslocationRestriction 要求選項,來調整搜尋結果的相似度。不過,locationBiaslocationRestriction 選項可讓您指定區域,以調整搜尋結果,而這個選項可讓您沿著行程路線調整結果。

結果不一定會沿著提供的路線顯示,而是會根據多邊形定義的搜尋區域,以及 (選用) locationBiaslocationRestriction,依據從起點到目的地的最短繞道時間排序。結果可能會沿著替代路線,尤其是當提供的折線並未定義從起點到目的地的最佳路線時。

欄位
polyline

Polyline

必填。路線折線。

SearchTextResponse

SearchText 的回應 proto。

欄位
places[]

Place

符合使用者文字搜尋條件的地點清單。

routing_summaries[]

RoutingSummary

路徑摘要清單,每個項目都會與 places 欄位中相同索引的對應地點建立關聯。如果其中一個地點沒有路徑摘要,該項目會留空。如果要求提供地點清單,這份清單就會包含相同數量的項目。

contextual_contents[]

ContextualContent

實驗功能:詳情請參閱 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative

內容清單,每個項目都會與地點欄位中相同索引的對應地點建立關聯。建議提供與要求中 text_query 相關的內容。如果其中一個地點沒有內容相關資訊,系統會傳回非內容相關資訊。只有在該地點沒有內容時,才會顯示空白。如果要求提供地點清單,這份清單就會包含相同數量的項目。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略或留空,就不會有後續頁面。

search_uri

string

使用者可透過連結,在 Google 地圖上使用與要求中指定的相同文字查詢進行搜尋。

TransitAgency

代表運輸公司。

欄位
display_name

LocalizedText

以所選語言顯示的機構名稱 (例如「VTA」)。

url

string

代理商首頁的網址。

fare_url

string

機構票價詳細資料頁面的網址。

icon

TransitIcon

大眾運輸系統 (例如倫敦地鐵) 本地化品牌圖示的圖示 ID,應在使用者介面中取代 TransitLine.vehicle_icon。

lines[]

TransitLine

這間運輸公司提供服務的大眾運輸路線。

TransitIcon

大眾運輸路線、車輛或機構的圖示。

欄位
url

string

圖示的網址。

name_included

bool

名稱是否包含在圖示中,且不需要顯示在圖示旁。

TransitLine

代表單一轉運路線。

欄位
id

string

可做為大眾運輸路線的 ID,用來在同一大眾運輸站點的其他大眾運輸路線中,專屬識別該路線。無法保證不同回應的 ID 穩定一致。

vehicle_type

VehicleType

使用這條路線的交通工具類型。

display_name

LocalizedText

這條大眾運輸路線的長名稱 (例如「Sunnydale local」)。

short_display_name

LocalizedText

這條大眾運輸路線的簡稱 (例如「S2」)。

text_color

string

這個大眾運輸路線的標籤文字顏色,格式為 #RRGGBB 十六進位代碼,例如 #909CE1。

background_color

string

以 #RRGGBB 十六進位格式表示此大眾運輸路線的標籤背景顏色,例如 #909CE1。這個顏色也可用於繪製這條大眾運輸路線的形狀。

url

string

網頁網址,內含這條線的詳細資料。

icon

TransitIcon

這條路線的圖示 ID (例如紐約的地鐵路線)。

vehicle_icon

TransitIcon

這個特定車輛類型的圖示 ID。

VehicleType

大眾運輸路線的交通工具類型。

列舉
VEHICLE_TYPE_UNSPECIFIED 未指定車輛類型時的預設值。
RAIL 火車。
METRO_RAIL 捷運。
SUBWAY 地鐵。
TRAM 電車。
MONORAIL 單軌電車。
HEAVY_RAIL 重軌電車。
COMMUTER_TRAIN 區間車。
HIGH_SPEED_TRAIN 高速火車。
LONG_DISTANCE_TRAIN 長途火車。
BUS 公車。
INTERCITY_BUS 城際巴士。
TROLLEYBUS 無軌電車。
SHARE_TAXI 共乘計程車。
COACH 教練。
FERRY 渡輪。
CABLE_CAR 纜車。
GONDOLA_LIFT 空中纜車。
FUNICULAR 纜索鐵路。
SPECIAL 特別。
HORSE_CARRIAGE 馬車。
AIRPLANE 飛機。

TransitStation

代表地點的交通運輸專屬資訊。

欄位
display_name

LocalizedText

以當地語言顯示的車站名稱。

agencies[]

TransitAgency

為這個車站提供服務的運輸公司。

stops[]

TransitStop

大眾運輸工具會停靠這個車站。

TransitStop

代表車站內的轉運站。這是乘客上下大眾運輸車輛的特定地點,例如月台或公車停靠區。這與 Departure 不同,後者是指車輛在特定時間離開停靠站的事件。

欄位
id

string

大眾運輸停靠站的 ID,可用於在同一大眾運輸車站的其他大眾運輸停靠站中,找出該停靠站。無法保證不同回應的 ID 穩定一致。

display_name

LocalizedText

停靠站名稱。

platform_code

LocalizedText

這個停靠站代表的平台代碼。格式不限。(例如:「2」、「Platform 2」、「2-4」或「1x」)。

signage_text

LocalizedText

這個月台看板上所寫的全文,例如「往市中心」或「東城和布魯克林」。如果沒有 platform_code,這個欄位可能就是平台的唯一 ID;不過,platform_codesignage_text 也可以同時設定。

stop_code

LocalizedText

停靠站的人類可讀 ID,運輸公司會使用這個 ID 區分同名停靠站。

location

LatLng

停靠站位置。

wheelchair_accessible_entrance

bool

這個停靠站的無障礙設施。這個欄位會指出從車站外到停靠站有無障礙通道。但不會指出是否可從該站牌上車。

TravelMode

交通方式選項。這些選項會對應至 Routes API 提供的功能

列舉
TRAVEL_MODE_UNSPECIFIED 未指定交通方式,預設值為 DRIVE
DRIVE 搭乘客車。
BICYCLE 騎自行車。不支援search_along_route_parameters
WALK 步行。不支援search_along_route_parameters
TWO_WHEELER 所有類型的機動雙輪車輛,例如輕型機車和摩托車。請注意,這與涵蓋人力運輸的 BICYCLE 交通方式不同。不支援search_along_route_parameters。僅適用於「支援兩輪車輛的國家/地區和區域」一文所列的國家/地區。