Package google.maps.places.v1

索引

地點介面集

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

AutocompletePlaces

rpc AutocompletePlaces(AutocompletePlacesRequest) returns (AutocompletePlacesResponse)

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

GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

取得包含相片參考字串的相片媒體。

GetPlace

rpc GetPlace(GetPlaceRequest) returns (Place)

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

SearchNearby

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

搜尋附近地點。

SearchText

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

文字查詢 Place Search。

AuthorAttribution

使用者原創內容資料作者的相關資訊。用於 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 的主要地點類型 (例如「餐廳」或「gas_station」)。只有在其主要類型列於此清單中時,才會傳回「地點」。最多可以指定 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_UNIT 錯誤。

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

我們建議遵循下列規範:

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

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

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

place_id

string

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

text

FormattableText

包含傳回結果中人類可讀的名稱。對建築物結果而言,這通常都是商家名稱和地址。

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

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

如果要求 inputlanguage_code 使用不同語言,或「地點」未提供當地語言的翻譯成 language_code,則可使用混合語言。

structured_format

StructuredFormat

「地點」預測結果細分為主要文字,其中包含「地點」的名稱和次要文字,其中包含其他能夠釐清的地圖項目 (例如城市或區域)。

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

types[]

string

適用於此地點的類型清單,請見 https://developers.google.com/maps/documentation/places/web-service/place-types

類型是地點的分類,含有共用類型的地點會具備類似的特性。

distance_meters

int32

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

QueryPrediction

Query Autocomplete 預測結果的預測結果。

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

使用者評論理由。這張圖片會醒目顯示使用者可能會感興趣的使用者評論部分。舉例來說,如果搜尋查詢是「火柴披薩」,審查原因會醒目顯示與該搜尋查詢相關的文字。

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

按照 [類型、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 Type 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 未指定電源插座。

FuelOptions

加油站的最新資訊。我們會定期更新這項資訊,

欄位
fuel_prices[]

FuelPrice

這個站點的各類燃料最近已知的燃油價格。這個站點的每個燃料類型只能有一個項目。順序不重要。

FuelPrice

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

欄位
type

FuelType

燃料類型。

price

Money

燃料的價格。

update_time

Timestamp

燃油價格上次更新的時間。

FuelType

燃油類型。

列舉
FUEL_TYPE_UNSPECIFIED 未指定燃油類型。
DIESEL 柴油燃料。
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 第 80 集。
E85 第 85 集。
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 (含) 之間的整數。如果值不在允許範圍內,系統會傳回 INVALID_GIVEN 錯誤。

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

max_height_px

int32

選用設定。指定所需的圖片高度上限 (以像素為單位)。如果圖片小於指定的值,系統就會傳回原始圖片。如果圖片的任一尺寸比較大,系統會配合原始顯示比例縮放圖片,以配合兩者中較小尺寸的尺寸。max_height_px 和 max_width_px 屬性都接受介於 1 到 4800 (含) 之間的整數。如果值不在允許範圍內,系統會傳回 INVALID_GIVEN 錯誤。

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

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 工作階段的字串。必須是網址和檔案名稱安全 Base64 字串,長度上限為 36 個 ASCII 字元。否則系統會傳回 INVALID_UNIT 錯誤。

工作階段是從使用者輸入查詢時開始,到使用者選取地點,並呼叫 Place Details 或地址驗證時結束。每個工作階段可以有多個查詢,後面接著一個 Place Details 或 Address 驗證要求。工作階段內每個要求使用的憑證,必須隸屬於同一個 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

這張相片的作者。

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

此結果的一組類型標記。例如「political」和「locality」。如需可用值的完整清單,請參閱表格 A 和表格 B (網址為 https://developers.google.com/maps/documentation/places/web-service/place-types)

primary_type

string

指定結果的主要類型。這個類型必須是 Places API 支援的類型之一。例如「餐廳」、「咖啡廳」、「機場」等。地點只能有一個主要類型。如需可用值的完整清單,請參閱表格 A 和表格 B (網址為 https://developers.google.com/maps/documentation/places/web-service/place-types)

primary_type_display_name

LocalizedText

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

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

地點位置經緯度的加號。

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

一般營業時間。

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

未來 7 天的營業時間 (包括今天)。時間範圍是從要求日期的午夜開始,到 6 天後的晚上 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 針對地點所在的區域產生了摘要。

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

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

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

組成區域摘要的內容區塊。每個區塊對該區域各有一個主題。

歸因

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

欄位
provider

string

地點的資料提供者名稱。

provider_uri

string

地點資料提供者的 URI。

BusinessStatus

地點的商家狀態。

列舉
BUSINESS_STATUS_UNSPECIFIED 預設值。未使用這個值。
OPERATIONAL 建築物開始營運,不一定營業中。
CLOSED_TEMPORARILY 該場所暫停營業。
CLOSED_PERMANENTLY 此場所已永久停業。

GenerativeSummary

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

AI 生成的地點摘要。

欄位
overview

LocalizedText

地點總覽。

description

LocalizedText

地點的詳細說明。

references

References

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

OpeningHours

地點的營業時間相關資訊。

欄位
periods[]

Period

此地點在週間營業的時段。經期依時間順序排序,週日則是以地點/當地時區為準。空白 (但非缺少) 值代表不開放營業的地點,例如因重新調整而暫時停業。

weekday_descriptions[]

string

用於說明這個地點的本地化營業時間,一個字串代表一週內每天的營業時間。如果營業時間不明或無法轉換為本地化文字,則這個欄位會留空。例如:「週日:18:00–06:00」

secondary_hours_type

SecondaryHoursType

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

special_days[]

SpecialDay

特殊節日的結構化資訊,也就是傳回的營業時間涵蓋的期間。特殊日子是指對地點的營業時間產生影響,例如聖誕節。如果營業時間不同,請為 current_opening_hours 和 current_secondary_opening_hours 設定。

open_now

bool

這個地點目前是否在營業?除非我們缺乏營業時間或時區資料,否則一律會顯示這項資訊。

時間範圍

地點仍維持 open_now 狀態的時段。

欄位
open

Point

地點開始營業的時間,

close

Point

地點開始停業的時間。

狀態變化分數。

欄位
date

Date

地點當地時區的日期。

truncated

bool

這個端點是否遭到截斷。如果實際營業時間不在我們願意傳回營業時間的時段,就會遭到截斷,因此我們將營業時間截斷到這些界線。確保從要求當天午夜起算,最多能傳回 24 * 7 小時。

day

int32

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

hour

int32

2 位數的小時。範圍介於 00 到 23 之間。

minute

int32

2 位數的分鐘。範圍介於 00 到 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) 是一種位置參照,格式有兩種:定義 14mx14m (度數 1/8000 度) 或小矩形代碼,以及複合代碼,將前置字串替換為參考位置。

欄位
global_code

string

地點的全球 (完整) 代碼,例如「9FWM33GV+HQ」,代表 1/8000 x 1/8000 度角 (約 14 x 14 公尺)。

compound_code

string

地點的複合代碼 (例如「33GV+HQ, Ramberg, Norway」) 包含全域代碼後置字串,並將前置字串替換成參照實體的格式化名稱。

SubDestination

地點與地點相關的子目的地的資源名稱和 ID。舉例來說,不同的航廈是機場的不同目的地。

欄位
name

string

子目的地的資源名稱。

id

string

子目的地的地點 ID,

PriceLevel

地點的價位等級,

列舉
PRICE_LEVEL_UNSPECIFIED 未指定或未知的地點價格層級。
PRICE_LEVEL_FREE 商家提供免費服務。
PRICE_LEVEL_INEXPENSIVE 這個地點提供價格低廉的服務。
PRICE_LEVEL_MODERATE 此地點提供價格合理的服務。
PRICE_LEVEL_EXPENSIVE 這個地點提供昂貴的服務。
PRICE_LEVEL_VERY_EXPENSIVE 這裡提供極為昂貴的服務。

參考資料

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

提及生成式內容相關。

欄位
reviews[]

Review

可做為參考的評論。

places[]

string

參照地點的資源名稱清單。這個名稱可用於其他接受「地點」資源名稱的 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

評論時間戳記。

SearchNearbyRequest

要求使用 Search Nearby 適用的通訊協定。

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

納入的地點類型 (例如「餐廳」或「gas_station」),來自 https://developers.google.com/maps/documentation/places/web-service/place-types

最多可在「表格 A」中指定 50 種類型。

如果有相衝突的類型,例如兩個 include_types 和 excluded_types 中都出現類型,系統就會傳回 INVALID_並進行 錯誤。

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

excluded_types[]

string

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

最多可在「表格 A」中指定 50 種類型。

如果客戶同時提供 include_types (例如餐廳) 和 excluded_types (例如:咖啡廳),則回覆中應包含餐廳,而不是咖啡廳的地點。回應會包含至少符合其中一個 include_types 以及完全無「excluded_types」相符的地點。

如果有相衝突的類型,例如兩個 include_types 和 excluded_types 中都出現類型,系統就會傳回 INVALID_並進行 錯誤。

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

included_primary_types[]

string

納入 https://developers.google.com/maps/documentation/places/web-service/place-types 的主要地點類型 (例如「餐廳」或「gas_station」)。地點在相關聯的支援類型表格中只能有一個主要類型。

最多可在「表格 A」中指定 50 種類型。

如果有相衝突的主要類型,也就是兩個 include_primary_types 和 excluded_primary_types 中都有,系統會傳回 INVALID_UNIT 錯誤。

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

excluded_primary_types[]

string

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

最多可在「表格 A」中指定 50 種類型。

如果有相衝突的主要類型,也就是兩個 include_primary_types 和 excluded_primary_types 中都有,系統會傳回 INVALID_UNIT 錯誤。

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

max_result_count

int32

要傳回的結果數上限。這個值必須介於 1 到 20 (預設值) 之間。如未設定,號碼會改回原本的上限。如果這個數字設為負數或超過上限,系統會傳回 INVALID_市場 錯誤。

location_restriction

LocationRestriction

必要欄位。要搜尋的區域。

rank_preference

RankPreference

回應中的結果排名方式。

LocationRestriction

要搜尋的區域。

欄位

聯集欄位 type

type 只能採用下列其中一種設定:

circle

Circle

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

RankPreference

回應中的結果排名方式。

列舉
RANK_PREFERENCE_UNSPECIFIED 未設定 RankPreference 值。根據預設,將使用 POPULARITY 排名。
DISTANCE 依距離排名結果。
POPULARITY 依熱門程度將結果排名。

SearchNearbyResponse

Search Nearby 的回應通訊協定。

欄位
places[]

Place

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

SearchTextRequest

要求 SearchText 的原型。

欄位
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_Gradle 錯誤。

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

page_size

int32

選用設定。每頁可傳回的結果數量上限。如果可用結果的數量大於 page_size,系統會傳回 next_page_token 並傳遞至 page_token,在後續要求中取得下一頁的結果。如果提供 0 或未提供值,系統會使用預設值 20。最大值是 20;高於 20 的值會設為 20。負值會傳回 INVALID_Gradle 錯誤。

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

page_token

string

選用設定。接收自先前的 TextSearch 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供給 TextSearch 的 page_tokenpage_sizemax_result_count 以外的所有參數,都必須與提供網頁權杖的初始呼叫相符。否則系統會傳回 INVALID_UNIT 錯誤。

price_levels[]

PriceLevel

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

strict_type_filtering

bool

用於設定 include_type 嚴格類型篩選。如果設為 True,系統只會傳回相同類型的結果。預設為 false。

location_bias

LocationBias

要搜尋的區域。這個位置會做為自訂區域,這表示系統可能會傳回指定位置周圍的結果。無法與 location_restriction 一併設定。

location_restriction

LocationRestriction

要搜尋的區域。這個位置會受到限制,表示不會傳回指定地區以外的結果。無法與 location_bias 同時設定。

ev_options

EVOptions

選用設定。針對地點搜尋要求設定可搜尋的電動車選項。

EVOptions

Place Search 要求中可供搜尋的電動車選項。

欄位
minimum_charging_rate_kw

double

選用設定。最低所需充電速率,以千瓦為單位。系統會篩除充電率低於指定費率的地點。

connector_types[]

EVConnectorType

選用設定。偏好的電動車連接器類型清單。不支援指定連接器類型的位置會遭到篩除。

LocationBias

要搜尋的區域。這個位置會做為自訂區域,這表示系統可能會傳回指定位置周圍的結果。

欄位

聯集欄位 type

type 只能採用下列其中一種設定:

rectangle

Viewport

由東北角和西南角定義的矩形方塊。rectangle.high() 必須是矩形可視區域的 northeast 點。rectangle.low() 必須是矩形可視區域的西南點。rectangle.low().latitude()不得大於 rectangle.high().latitude()。如此一來,緯度範圍就會是空的。矩形可視區域的寬度不得超過 180 度。

circle

Circle

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

LocationRestriction

要搜尋的區域。這個位置會受到限制,表示不會傳回指定地區以外的結果。

欄位

聯集欄位 type

type 只能採用下列其中一種設定:

rectangle

Viewport

由東北角和西南角定義的矩形方塊。rectangle.high() 必須是矩形可視區域的 northeast 點。rectangle.low() 必須是矩形可視區域的西南點。rectangle.low().latitude()不得大於 rectangle.high().latitude()。如此一來,緯度範圍就會是空的。矩形可視區域的寬度不得超過 180 度。

RankPreference

回應中的結果排名方式。

列舉
RANK_PREFERENCE_UNSPECIFIED 如果是如「紐約市餐廳」這類類別查詢,預設值為 RELEVANCE。如果是「加州山景城」這類非類別的查詢,則建議您不要設定 rankPreference。
DISTANCE 依距離排名結果。
RELEVANCE 依關聯性排名結果。按照一般排名堆疊決定的排序順序。

SearchTextResponse

SearchText 的回應通訊協定。

欄位
places[]

Place

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

contextual_contents[]

ContextualContent

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

內容相關內容清單,每個項目都會與地點欄位中相同索引的對應位置建立關聯。最好提供與要求中 text_query 相關的內容。如果其中一個地點無法取得相關內容,就會傳回非相關內容。除非該內容不適用於這個地點,否則這裡不會顯示任何內容。如果系統提出要求,這份清單應包含地點清單的項目數量。

next_page_token

string

可做為 page_token 傳送的權杖,用於擷取後續網頁。如果省略這個欄位或留空,表示沒有後續網頁。