Package google.maps.places.v1

索引

地點

Places API 的服務定義。注意:每個請求 (Autocomplete 請求除外) 都需要在請求原型 (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/cloud-platform
GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

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

授權範圍

需要下列 OAuth 範圍:

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

rpc GetPlace(GetPlaceRequest) returns (Place)

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

授權範圍

需要下列 OAuth 範圍:

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

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

搜尋地點附近的場所。

授權範圍

需要下列 OAuth 範圍:

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

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

以文字查詢為基礎的地點搜尋。

授權範圍

需要下列 OAuth 範圍:

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

AddressDescriptor

地點的關聯說明。包含一組經過排名的附近地標和精確包含區域,以及這些區域與目標位置的關係。

欄位
landmarks[]

Landmark

附近地標的排名清單。最容易辨識且最近的地標會排在第一。

areas[]

Area

包含或相鄰區域的排名清單。最容易辨識且精確的區域會排在前面。

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

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

欄位
name

string

區域的資源名稱。

place_id

string

區域的 Place ID。

display_name

LocalizedText

區域的顯示名稱。

containment

Containment

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

防堵

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

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

地標

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

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

欄位
name

string

地標的資源名稱。

place_id

string

地標的 Place 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 的 Request proto。

欄位
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),或僅包含 (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

選用設定。以零為基底的 input Unicode 字元位移值,表示 input 中的游標位置。游標位置可能會影響傳回的預測結果。

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

include_query_predictions

bool

選用設定。如果為 true,回應會同時包含 Place 和查詢預測結果。否則回應只會傳回 Place 預測結果。

session_token

string

選用設定。用於計費的 Autocomplete 工作階段識別字串。必須是安全的 base64 字串,且長度不得超過 36 個 ASCII 字元。否則會傳回 INVALID_ARGUMENT 錯誤。

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

建議您遵循下列準則:

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

bool

選用設定。如果這個欄位設為 true,就包含純區域服務商家。純區域服務商家是指直接為客戶提供送貨或到府服務,但未在商家地址為客戶提供服務的商家。例如清潔或水電服務。這些商家在 Google 地圖上沒有實體地址或位置。地點服務不會為這些商家傳回 locationplus_code 和其他位置相關欄位。

LocationBias

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

欄位

聯集欄位 type

type 只能是下列其中一項:

rectangle

Viewport

由東北角和西南角定義的視區範圍。

circle

Circle

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

LocationRestriction

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

欄位

聯集欄位 type

type 只能是下列其中一項:

rectangle

Viewport

由東北角和西南角定義的視區範圍。

circle

Circle

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

AutocompletePlacesResponse

AutocompletePlaces 的回應原型。

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

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

place_id

string

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

text

FormattableText

包含傳回結果的使用者可解讀名稱。對於商家結果,通常是商家名稱和地址。

如果開發人員想顯示單一 UI 元素,建議使用 text。如果開發人員想顯示兩個分開但相關的 UI 元素,建議改用 structured_format。這兩種方法是表示 Place 預測結果的兩種不同方式。使用者不應嘗試將 structured_format 剖析為 text,反之亦然。

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

如果要求 inputlanguage_code 使用不同語言,或是地點沒有從當地語言翻譯成 language_code 的譯文,則可能會混用多種語言。

structured_format

StructuredFormat

將地點預測結果分割為主要文字 (包含地點名稱) 和次要文字 (包含其他可用於區分的功能,例如城市或區域)。

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

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_format 剖析為 text,反之亦然。

如果要求 inputlanguage_code 使用不同語言,或是部分查詢沒有從當地語言翻譯成 language_code 的譯文,可能會混用多種語言。

structured_format

StructuredFormat

將查詢預測結果分成包含查詢的「主要文字」和包含其他不含歧義功能 (例如城市或區域) 的「次要文字」。

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

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

可個別放送的內容區塊。

欄位
topic

string

內容主題,例如「總覽」或「餐廳」。

content

LocalizedText

與主題相關的內容。

references

References

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

與這段內容相關的參考資料。

ContextualContent

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

與地點查詢相關的內容。

欄位
reviews[]

Review

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

photos[]

Photo

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

justifications[]

Justification

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

地點的說明。

原因

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

地點的說明。說明原因,回答「為何某個地點可能引起使用者興趣」的問題。

欄位

聯集欄位 justification

justification 只能是下列其中一項:

review_justification

ReviewJustification

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

business_availability_attributes_justification

BusinessAvailabilityAttributesJustification

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

BusinessAvailabilityAttributesJustification

實驗功能:詳情請參閱 https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative。BusinessAvailabilityAttributes 屬性理由。這會顯示商家擁有的某些屬性,這些屬性可能會引起使用者的興趣。

欄位
takeout

bool

店家是否提供外帶服務。

delivery

bool

店家是否提供外送服務。

dine_in

bool

是否提供內用服務。

ReviewJustification

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

使用者評論的理由。這會標示使用者評論中可能引起使用者興趣的部分。舉例來說,如果搜尋查詢是「firewood pizza」,則審查理由會醒目顯示與搜尋查詢相關的文字。

欄位
highlighted_text

HighlightedText

review

Review

系統根據哪則評論產生標示文字。

HighlightedText

由對齊方式醒目顯示的文字。這是評論本身的子集。醒目顯示的確切字詞會標示為 HighlightedTextRange。文字中可能有幾個字詞會被標示。

欄位
text

string

highlighted_text_ranges[]

HighlightedTextRange

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

HighlightedTextRange

醒目顯示文字的範圍。

欄位
start_index

int32

end_index

int32

EVChargeOptions

關於在 Place 中代管的電動車充電站資訊。以下術語依據 https://afdc.energy.gov/fuels/electricity_infrastructure.html 的定義。一個充電埠一次只能為一輛車充電。一個連接埠有一個或多個連接器。一個充電站會有一或多個充電座。

欄位
connector_count

int32

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

connector_aggregation[]

ConnectorAggregation

電動車充電連接器匯總清單,其中包含相同類型和相同充電率的連接器。

ConnectorAggregation

電動車充電資訊會依據 [type, max_charge_rate_kw] 分組。顯示相同類型和最高充電率 (以千瓦為單位) 的連接器 EV 充電匯總資料。

欄位
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 型 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)。這個值較不代表實際的連接器類型,而是代表在特斯拉自有充電站為特斯拉品牌車輛充電的能力。
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 進階版。
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

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

max_width_px

int32

選用設定。指定圖片的寬度上限 (以像素為單位)。如果圖片小於指定的值,系統會傳回原始圖片。如果圖片的任何一邊尺寸較大,系統會將圖片縮放至兩個尺寸中較小的尺寸,並限制為原始顯示比例。max_height_px 和 max_width_px 屬性都接受 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 之間的整數 (含兩者)。如果值不在允許範圍內,系統會傳回 INVALID_ARGUMENT 錯誤。

至少需要指定 max_height_px 或 max_width_px 其中一個。如果未指定 max_height_px 或 max_width_px,系統會傳回 INVALID_ARGUMENT 錯誤。

skip_http_redirect

bool

選用設定。如果已設定,系統會略過預設的 HTTP 重新導向行為,並轉譯文字格式 (例如 JSON 格式,適用於 HTTP 用途) 回應。如果未設定,系統會發出 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 工作階段識別字串。必須是安全的 base64 字串,且長度不得超過 36 個 ASCII 字元。否則會傳回 INVALID_ARGUMENT 錯誤。

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

建議您遵循下列準則:

  • 在所有 Place Autocomplete 呼叫中使用工作階段符記。
  • 為每個工作階段產生新的符記。建議使用第 4 版 UUID。
  • 請確認在工作階段中,所有 Place Autocomplete、Place Details 和 Address Validation 要求使用的憑證都屬於同一個 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

primary_type_display_name

LocalizedText

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

national_phone_number

string

使用者可解讀的電話號碼,以國家/地區格式表示。

international_phone_number

string

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

formatted_address

string

這個地點的完整地址,可供人類閱讀。

short_formatted_address

string

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

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 則評論。

regular_opening_hours

OpeningHours

一般營業時間。請注意,如果地點全年無休 (24 小時營業),系統不會設定 close 欄位。用戶端可以將全年無休 (24 小時) 表示為 [open][google.maps.places.v1.Place.OpeningHours.Period.open] 期間,其中 [day][Point.day] 的值為 0[hour][Point.hour] 的值為 0,而 [minute][Point.minute] 的值為 0

time_zone

TimeZone

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

photos[]

Photo

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

adr_format_address

string

地點的地址以 adr 微格式表示:http://microformats.org/wiki/adr

business_status

BusinessStatus

地點的商家狀態。

price_level

PriceLevel

地點的價格等級。

attributions[]

Attribution

一組必須與此結果一併顯示的資料提供者。

icon_mask_base_uri

string

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

icon_background_color

string

以十六進位格式指定 icon_mask 的背景顏色,例如 #909CE1。

current_opening_hours

OpeningHours

未來七天 (含今天) 的營業時間。這段時間會從要求當天的午夜開始,並在六天後的晚上 11 點 59 分結束。這個欄位包含所有時段的 special_days 子欄位,並針對有特殊營業時間的日期設定。

current_secondary_opening_hours[]

OpeningHours

包含未來七天的陣列項目,包括商家次要營業時間的資訊。次要營業時間與商家的營業時間不同。舉例來說,餐廳可以將得來速或外送時間指定為次要營業時間。這個欄位會填入類型子欄位,該欄位會根據地點類型,從預先定義的營業時間類型清單 (例如 DRIVE_THROUGH、PICKUP 或 TAKEOUT) 中擷取資料。這個欄位包含所有時段的 special_days 子欄位,並針對有特殊營業時間的日期設定。

regular_secondary_opening_hours[]

OpeningHours

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

editorial_summary

LocalizedText

包含地點摘要。摘要包含文字概覽,並在適用情況下加入語言代碼。摘要文字必須維持原樣,無法修改或變更。

payment_options

PaymentOptions

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

parking_options

ParkingOptions

地點提供的停車選項。

sub_destinations[]

SubDestination

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

fuel_options

FuelOptions

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

ev_charge_options

EVChargeOptions

電動車充電選項的資訊。

generative_summary

GenerativeSummary

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

AI 生成的地點摘要。

area_summary

AreaSummary

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

AI 生成的摘要,說明地點所在的區域。

containing_places[]

ContainingPlace

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

address_descriptor

AddressDescriptor

地點的地址描述元。地址描述元包含其他資訊,可協助使用者透過地標和區域描述地點。請參閱 https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage 中的地址描述符區域涵蓋範圍。

price_range

PriceRange

與地點相關的價格範圍。

utc_offset_minutes

int32

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

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

指定該地點是否供應素食。

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 可能為「Australia」。

short_text

string

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

types[]

string

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

language_code

string

用於格式化此元件的語言,以 CLDR 符號表示。

AreaSummary

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

AI 生成的摘要,說明地點所在的區域。

欄位
content_blocks[]

ContentBlock

組成區域摘要的內容區塊。每個區塊都有各自的相關主題。

flag_content_uri

string

使用者可透過此連結回報摘要相關問題。

歸因

這個地點的資料提供者相關資訊。

欄位
provider

string

地點資料供應商的名稱。

provider_uri

string

地點資料供應商的 URI。

BusinessStatus

地點的商家狀態。

列舉
BUSINESS_STATUS_UNSPECIFIED 預設值。此值未使用。
OPERATIONAL 該機構正在運作,但不一定是現在開放。
CLOSED_TEMPORARILY 該商家目前暫停營業。
CLOSED_PERMANENTLY 該商家已永久歇業。

ContainingPlace

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

欄位
name

string

此地點所在地點的資源名稱。

id

string

這個地點所在地點的 ID。

GenerativeSummary

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

AI 生成的地點摘要。

欄位
overview

LocalizedText

地點的總覽。

overview_flag_content_uri

string

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

description

LocalizedText

地點的詳細說明。

description_flag_content_uri

string

使用者可透過這個連結,針對說明摘要中的某個問題提出警示。

references

References

用於產生摘要說明的參照。

OpeningHours

地點的營業時間資訊。

欄位
periods[]

Period

這個地點在本週的營業時間。時段會按時間順序排列,從當地時區的星期日開始。空白 (但非缺少) 值表示地點從未營業,例如因整修而暫時關閉。

weekday_descriptions[]

string

描述此地點營業時間的本地化字串,每週一天一個字串。如果營業時間不明或無法轉換為本地化文字,則會是空白。例如:「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」,包含全球代碼的後置字串,並將前置字串替換為參考實體的格式化名稱。

SubDestination

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

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

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

參考資料

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

參照生成式內容的相關內容。

欄位
reviews[]

Review

可做為參考的評論。

places[]

string

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

查看

地點評論的相關資訊。

欄位
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 地圖上顯示評論的連結。

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 不考量實際交通狀況來計算路線。適合用於交通狀況不重要或不適用的情況。使用這個值可產生最低的延遲時間。注意:對於 TravelMode DRIVETWO_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

包含的 Place type (例如「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

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

最多可指定 表 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。地點只能具有單一主要類型,且該類型必須是與該地點相關聯的支援類型表格中所列的類型。

最多可指定 表 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 排除的主要地點類型 (例如「餐廳」或「加油站」)。

最多可指定 表 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

選用設定。影響搜尋結果路由的參數。

LocationRestriction

要搜尋的區域。

欄位

聯集欄位 type

type 只能是下列其中一項:

circle

Circle

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

RankPreference

回應中結果的排序方式。

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

SearchNearbyResponse

搜尋附近地點的回應原型檔。

欄位
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。負值會傳回 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

選用設定。設定地點搜尋要求的可搜尋 EV 選項。

routing_parameters

RoutingParameters

選用設定。用於將結果導向其他位置的其他參數。

search_along_route_parameters

SearchAlongRouteParameters

選用設定。沿路搜尋的其他參數原型檔。

include_pure_service_area_businesses

bool

選用設定。如果這個欄位設為 true,就包含純區域服務商家。純區域服務商家是指直接為客戶提供送貨或到府服務,但未在商家地址為客戶提供服務的商家。例如清潔或水電服務。這些商家在 Google 地圖上沒有實體地址或位置。地點服務不會為這些商家傳回 locationplus_code 和其他位置相關欄位。

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 如果是類別查詢 (例如「紐約市的餐廳」),預設值為 RELEVANCE。對於非分類查詢 (例如「Mountain View, CA」),建議您不要設定 rankPreference。
DISTANCE 依距離排序結果。
RELEVANCE 依關聯性排序結果。排序順序由一般排名堆疊決定。

SearchAlongRouteParameters

指定 Routes API 中定義搜尋路徑的預先計算多邊形。沿著路線搜尋的功能類似於使用 locationBiaslocationRestriction 要求選項,可偏向搜尋結果。不過,locationBiaslocationRestriction 選項可讓您指定偏好區域,以便搜尋結果偏重該區域,而這個選項則可讓您偏重某個行程路線。

系統不會保證結果會沿著所提供的路線,而是會在多邊形定義的搜尋區域內,以及 (選用) locationBiaslocationRestriction 中,根據從起點到目的地的最短繞路時間來排序。結果可能會沿著替代路線,尤其是當您提供的多邊形路線未定義從起點到目的地的最佳路線時。

欄位
polyline

Polyline

必要欄位。路線折線。

SearchTextResponse

SearchText 的回應原型檔。

欄位
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 地圖上要求中指定的文字查詢進行搜尋。

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。僅支援兩輪車輛支援的國家/地區中列出的國家/地區。