文字查詢 Place Search。
HTTP 要求
POST https://places.googleapis.com/v1/places:searchText
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "textQuery": string, "languageCode": string, "regionCode": string, "rankPreference": enum ( |
欄位 | |
---|---|
textQuery |
必要欄位。文字搜尋的文字查詢。 |
languageCode |
如果有偏好的語言,地點詳細資訊就會顯示。如未指定或無法識別語言代碼,系統可能會傳回任何語言的地點詳細資料,但如果有這類資料的詳細資訊,偏好設定會顯示為英文。 目前支援語言清單:https://developers.google.com/maps/faq#languagesupport。 |
regionCode |
要求來源地區的 Unicode 國家/地區代碼 (CLDR)。這個參數是用來顯示地點詳細資料,例如特定區域的地點名稱 (如有)。根據適用法律,這個參數可能會影響結果。 如需更多資訊,請參閱 https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html。 請注意,系統目前不支援 3 位數的區碼。 |
rankPreference |
回應中的結果排名方式。 |
includedType |
要求的地點類型。支援類型的完整清單:https://developers.google.com/maps/documentation/places/web-service/place-types。僅支援一個包含類型。 |
openNow |
用於將搜尋範圍限制在目前營業的地點。預設值為 false。 |
minRating |
篩除使用者平均評分嚴格低於這個上限的結果。有效的值必須是介於 0 到 5 (含) 之間的浮點數,且中間以 0.5 的頻率表示,例如 [0, 0.5, 1.0, ... , 5.0]。輸入評分會無條件進位至最接近的 0.5(天花板)。舉例來說,如果評分為 0.6,就會排除評分低於 1.0 的所有結果。 |
maxResultCount |
要傳回的結果數上限。這個值必須介於 1 至 20 (含 1 和 20)。預設值為 20)。如未設定,號碼會改回原本的上限。如果這個數字設為負數或超過上限,系統會傳回 INVALID_市場 錯誤。 |
priceLevels[] |
用於將搜尋範圍限制在標示為特定價位的地點。使用者可以選擇任何價位的組合。預設為選取所有價位。 |
strictTypeFiltering |
用於為 includeType 設定嚴格類型篩選。如果設為 True,系統只會傳回相同類型的結果。預設為 false。 |
locationBias |
要搜尋的區域。這個位置會做為自訂區域,這表示系統可能會傳回指定位置周圍的結果。無法同時設定 locationRestriction。 |
locationRestriction |
要搜尋的區域。這個位置會受到限制,表示不會傳回指定地區以外的結果。無法同時設定 locationBias。 |
evOptions |
選用設定。針對地點搜尋要求設定可搜尋的電動車選項。 |
回應主體
Places.searchText 的回應通訊協定。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"places": [
{
object ( |
欄位 | |
---|---|
places[] |
符合使用者文字搜尋條件的地點清單。 |
RankPreference
回應中的結果排名方式。
列舉 | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
如果是如「紐約市餐廳」這類類別查詢,預設值為 RELEVANCE。如果是「加州山景城」這類非類別的查詢,則建議您不要設定 rankPreference。 |
DISTANCE |
依距離排名結果。 |
RELEVANCE |
依關聯性排名結果。按照一般排名堆疊決定的排序順序。 |
LocationBias
要搜尋的區域。這個位置會做為自訂區域,這表示系統可能會傳回指定位置周圍的結果。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
rectangle |
由東北角和西南角定義的矩形方塊。 |
circle |
由中心點和半徑定義的圓形。 |
LocationRestriction
要搜尋的區域。這個位置會受到限制,表示不會傳回指定地區以外的結果。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
rectangle |
由東北角和西南角定義的矩形方塊。 |
EVOptions
Place Search 要求中可供搜尋的電動車選項。
JSON 表示法 |
---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
欄位 | |
---|---|
minimumChargingRateKw |
選用設定。最低所需充電速率,以千瓦為單位。系統會篩除充電率低於指定費率的地點。 |
connectorTypes[] |
選用設定。偏好的電動車連接器類型清單。不支援指定連接器類型的位置會遭到篩除。 |