Method: places.searchText

Wyszukiwanie miejsc na podstawie zapytania tekstowego.

Żądanie HTTP

POST https://places.googleapis.com/v1/places:searchText

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean
}
Pola
textQuery

string

Wymagane. Zapytanie tekstowe do wyszukiwania tekstowego.

languageCode

string

Informacje o miejscu będą wyświetlane w preferowanym języku, jeśli jest on dostępny. Jeśli kod języka jest nieokreślony lub nierozpoznany, mogą zostać zwrócone szczegóły miejsca w dowolnym języku, przy czym preferowany jest język angielski, jeśli takie szczegóły istnieją.

Aktualna lista obsługiwanych języków: https://developers.google.com/maps/faq#languagesupport.

regionCode

string

Kod Unicode kraju lub regionu (CLDR) lokalizacji, z której pochodzi żądanie. Ten parametr służy do wyświetlania szczegółów miejsca, np. nazwy miejsca w danym regionie, jeśli jest dostępna. W zależności od obowiązujących przepisów parametr może wpływać na wyniki.

Więcej informacji znajdziesz na stronie https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Pamiętaj, że 3-cyfrowe kody regionów nie są obecnie obsługiwane.

rankPreference

enum (RankPreference)

Określa kolejność wyników w odpowiedzi.

includedType

string

Rodzaj miejsca, o który prosisz. Pełna lista obsługiwanych typów: https://developers.google.com/maps/documentation/places/web-service/place-types. Obsługuje tylko 1 typ.

openNow

boolean

Służy do ograniczenia wyszukiwania do miejsc, które są obecnie otwarte. Domyślnie ma wartość fałsz.

minRating

number

Odfiltrowuje wyniki, których średnia ocena użytkowników jest ściśle mniejsza niż ten limit. Prawidłowa wartość musi być liczbą zmiennoprzecinkową z zakresu od 0 do 5 (włącznie) z krokiem 0,5, czyli [0, 0,5, 1,0, ..., 5,0] włącznie. Wpisana ocena zostanie zaokrąglona w górę do najbliższej wartości 0,5. Na przykład ocena 0,6 wyeliminuje wszystkie wyniki z oceną poniżej 1,0.

maxResultCount
(deprecated)

integer

Wycofana: zamiast niej używaj zasady pageSize.

Maksymalna liczba wyników na stronę, które można zwrócić. Jeśli liczba dostępnych wyników jest większa niż maxResultCount, zwracana jest wartość nextPageToken, którą można przekazać do funkcji pageToken, aby w kolejnych żądaniach uzyskać następną stronę wyników. Jeśli podasz wartość 0 lub nie podasz żadnej wartości, zostanie użyta wartość domyślna 20. Maksymalna wartość to 20. Wartości powyżej 20 zostaną zmienione na 20. Wartości ujemne spowodują zwrócenie błędu INVALID_ARGUMENT.

Jeśli podasz zarówno maxResultCount, jak i pageSize, parametr maxResultCount zostanie zignorowany.

pageSize

integer

Opcjonalnie. Maksymalna liczba wyników na stronę, które można zwrócić. Jeśli liczba dostępnych wyników jest większa niż pageSize, zwracana jest wartość nextPageToken, którą można przekazać do funkcji pageToken, aby w kolejnych żądaniach uzyskać następną stronę wyników. Jeśli podasz wartość 0 lub nie podasz żadnej wartości, zostanie użyta wartość domyślna 20. Maksymalna wartość to 20. Wartości powyżej 20 zostaną ustawione na 20. Wartości ujemne spowodują zwrócenie błędu INVALID_ARGUMENT.

Jeśli podasz zarówno maxResultCount, jak i pageSize, parametr maxResultCount zostanie zignorowany.

pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania TextSearch. Podaj ten token, aby pobrać kolejną stronę.

Podczas paginacji wszystkie parametry przekazane do TextSearch z wyjątkiem pageToken, pageSizemaxResultCount muszą być zgodne z pierwszym wywołaniem, które dostarczyło token strony. W przeciwnym razie zwracany jest błąd INVALID_ARGUMENT.

priceLevels[]

enum (PriceLevel)

Służy do ograniczenia wyszukiwania do miejsc oznaczonych określonymi poziomami cen. Użytkownicy mogą wybrać dowolną kombinację poziomów cen. Domyślnie wybrane są wszystkie poziomy cenowe.

strictTypeFiltering

boolean

Służy do ustawiania ścisłego filtrowania typu dla parametru includedType. Jeśli ma wartość Prawda, zwracane są tylko wyniki tego samego typu. Domyślnie ma wartość fałsz.

locationBias

object (LocationBias)

Region, w którym ma się odbywać wyszukiwanie. Ta lokalizacja służy jako punkt odniesienia, co oznacza, że mogą być zwracane wyniki w jej pobliżu. Nie można go ustawić razem z parametrem locationRestriction.

locationRestriction

object (LocationRestriction)

Region, w którym ma się odbywać wyszukiwanie. Ta lokalizacja służy jako ograniczenie, co oznacza, że wyniki spoza podanej lokalizacji nie będą zwracane. Nie można go ustawić razem z parametrem locationBias.

evOptions

object (EVOptions)

Opcjonalnie. Ustaw opcje wyszukiwania pojazdów elektrycznych w żądaniu wyszukiwania miejsca.

routingParameters

object (RoutingParameters)

Opcjonalnie. Dodatkowe parametry kierowania do wyników.

searchAlongRouteParameters

object (SearchAlongRouteParameters)

Opcjonalnie. Dodatkowy protokół parametrów do wyszukiwania miejsc przy trasie.

includePureServiceAreaBusinesses

boolean

Opcjonalnie. Uwzględnij firmy działające tylko na określonym obszarze, jeśli pole ma wartość true. Firma działająca tylko na określonym obszarze to firma, która świadczy usługi na miejscu u klienta lub samodzielnie dostarcza produkty odbiorcom, ale nie obsługuje klientów pod swoim adresem. Mogą to być hydraulicy lub firmy świadczące usługi sprzątania. Nie mają one fizycznego adresu ani lokalizacji w Mapach Google. Miejsca nie będą zwracać pól, w tym location, plusCode i innych pól związanych z lokalizacją tych firm.

Treść odpowiedzi

Protokół odpowiedzi dla places.searchText.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string,
  "searchUri": string
}
Pola
places[]

object (Place)

Lista miejsc spełniających kryteria wyszukiwania tekstowego użytkownika.

routingSummaries[]

object (RoutingSummary)

Lista podsumowań routingu, w której każdy wpis jest powiązany z odpowiednim miejscem o tym samym indeksie w polu places. Jeśli podsumowanie wyznaczania trasy jest niedostępne w przypadku jednego z miejsc, będzie zawierać pusty wpis. Jeśli poprosisz, lista będzie zawierać tyle wpisów, ile jest miejsc.

contextualContents[]

object (ContextualContent)

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

Lista treści kontekstowych, w której każdy wpis jest powiązany z odpowiednim miejscem w tym samym indeksie w polu miejsc. Preferowane są treści, które są istotne dla textQuery w prośbie. Jeśli treści kontekstowe nie są dostępne w przypadku jednego z miejsc, zostaną zwrócone treści bez kontekstu. Będzie ona pusta tylko wtedy, gdy treści dotyczące tego miejsca są niedostępne. Jeśli poprosisz, lista będzie zawierać tyle wpisów, ile jest miejsc.

nextPageToken

string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole lub pozostawisz je puste, nie będzie kolejnych stron.

searchUri

string

Link umożliwia użytkownikowi wyszukiwanie w Mapach Google za pomocą tego samego zapytania tekstowego, które zostało określone w żądaniu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

RankPreference

Określa kolejność wyników w odpowiedzi.

Wartości w polu enum
RANK_PREFERENCE_UNSPECIFIED W przypadku zapytania kategorycznego, np. „Restauracje w Nowym Jorku”, domyślnym kryterium jest TRAFNOŚĆ. W przypadku zapytań niekategorycznych, takich jak „Mountain View, CA”, zalecamy pozostawienie parametru rankPreference bez ustawienia.
DISTANCE Sortuje wyniki według odległości.
RELEVANCE Uporządkuj wyniki według trafności. Kolejność sortowania jest określana przez normalny stos rankingowy.

LocationBias

Region, w którym ma się odbywać wyszukiwanie. Ta lokalizacja służy jako punkt odniesienia, co oznacza, że mogą być zwracane wyniki w jej pobliżu.

Zapis JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Pola

Pole zbiorcze type.

Pole type może mieć tylko jedną z tych wartości:

rectangle

object (Viewport)

Prostokąt określony przez narożniki północno-wschodni i południowo-zachodni. rectangle.high() musi być punktem północno-wschodnim prostokątnego obszaru widocznego. rectangle.low() musi być południowo-zachodnim punktem prostokątnego obszaru widocznego. Wartość rectangle.low().latitude() nie może być większa niż rectangle.high().latitude(). Spowoduje to powstanie pustego zakresu szerokości geograficznej. Prostokątny obszar widoku nie może być szerszy niż 180 stopni.

circle

object (Circle)

Okrąg zdefiniowany przez punkt środkowy i promień.

LocationRestriction

Region, w którym ma się odbywać wyszukiwanie. Ta lokalizacja służy jako ograniczenie, co oznacza, że wyniki spoza podanej lokalizacji nie będą zwracane.

Zapis JSON
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Pola

Pole zbiorcze type.

Pole type może mieć tylko jedną z tych wartości:

rectangle

object (Viewport)

Prostokąt określony przez narożniki północno-wschodni i południowo-zachodni. rectangle.high() musi być punktem północno-wschodnim prostokątnego obszaru widocznego. rectangle.low() musi być południowo-zachodnim punktem prostokątnego obszaru widocznego. Wartość rectangle.low().latitude() nie może być większa niż rectangle.high().latitude(). Spowoduje to powstanie pustego zakresu szerokości geograficznej. Prostokątny obszar widoku nie może być szerszy niż 180 stopni.

EVOptions

Opcje wyszukiwania pojazdów elektrycznych w przypadku wyszukiwania miejsca.

Zapis JSON
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Pola
minimumChargingRateKw

number

Opcjonalnie. Minimalna wymagana moc ładowania w kilowatach. Miejsce z szybkością ładowania niższą niż określona zostanie odfiltrowane.

connectorTypes[]

enum (EVConnectorType)

Opcjonalnie. Lista preferowanych typów złączy EV. Miejsce, które nie obsługuje żadnego z wymienionych typów złączy, jest odfiltrowywane.

SearchAlongRouteParameters

Określa wstępnie obliczoną linię łamaną z interfejsu Routes API, która definiuje trasę wyszukiwania. Wyszukiwanie wzdłuż trasy jest podobne do używania opcji żądania locationBias lub locationRestriction w celu ukierunkowania wyników wyszukiwania. Opcje locationBiaslocationRestriction umożliwiają określenie regionu, który ma wpływać na wyniki wyszukiwania, a ta opcja pozwala wpływać na wyniki wyszukiwania wzdłuż trasy podróży.

Wyniki nie muszą znajdować się na podanej trasie, ale są uszeregowane w obszarze wyszukiwania zdefiniowanym przez linię łamaną i opcjonalnie przez locationBias lub locationRestriction na podstawie minimalnego czasu objazdu z miejsca początkowego do docelowego. Wyniki mogą dotyczyć trasy alternatywnej, zwłaszcza jeśli podana linia łamana nie określa optymalnej trasy z miejsca początkowego do miejsca docelowego.

Zapis JSON
{
  "polyline": {
    object (Polyline)
  }
}
Pola
polyline

object (Polyline)

Wymagane. Linia łamana trasy.

Linia łamana

linia łamana trasy, Obsługuje tylko zakodowaną linię łamaną, którą można przekazać jako ciąg znaków i która obejmuje kompresję z minimalną utratą jakości. Są to domyślne dane wyjściowe interfejsu Routes API.

Zapis JSON
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
Pola
Pole zbiorcze polyline_type. Zawiera typ linii łamanej. Domyślne dane wyjściowe interfejsu Routes API to encoded_polyline. polyline_type może mieć tylko jedną z tych wartości:
encodedPolyline

string

Zakodowana linia łamana, która jest domyślnie zwracana przez interfejs Routes API. Zapoznaj się z narzędziami enkoder i dekoder.

ContextualContent

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

treści kontekstowe w stosunku do zapytania o miejsce;

Zapis JSON
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Pola
reviews[]

object (Review)

Lista opinii o tym miejscu, powiązanych z zapytaniem o miejsce.

photos[]

object (Photo)

Informacje (w tym odniesienia) o zdjęciach tego miejsca, które są powiązane z zapytaniem o to miejsce.

justifications[]

object (Justification)

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

uzasadnienia dotyczące miejsca;

Uzasadnienie

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

uzasadnienia dotyczące miejsca; Uzasadnienia odpowiadają na pytanie, dlaczego dane miejsce może zainteresować użytkownika.

Zapis JSON
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
Pola

Pole zbiorcze justification.

Pole justification może mieć tylko jedną z tych wartości:

reviewJustification

object (ReviewJustification)

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

ReviewJustification

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative.

uzasadnienia opinii użytkowników, Wyróżnia to fragment opinii użytkownika, który może zainteresować użytkownika końcowego. Jeśli na przykład wyszukiwane hasło to „pizza z pieca opalanego drewnem”, uzasadnienie opinii wyróżnia tekst związany z tym hasłem.

Zapis JSON
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Pola
highlightedText

object (HighlightedText)

review

object (Review)

Opinia, na podstawie której wygenerowano podświetlony tekst.

HighlightedText

Tekst wyróżniony przez uzasadnienie. Jest to podzbiór samej opinii. Dokładne słowo do wyróżnienia jest oznaczone przez HighlightedTextRange. W tekście może być wyróżnionych kilka słów.

Zapis JSON
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
Pola
text

string

highlightedTextRanges[]

object (HighlightedTextRange)

Lista zakresów zaznaczonego tekstu.

HighlightedTextRange

Zakres zaznaczonego tekstu.

Zapis JSON
{
  "startIndex": integer,
  "endIndex": integer
}
Pola
startIndex

integer

endIndex

integer

BusinessAvailabilityAttributesJustification

Eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. Uzasadnienia atrybutów dostępności firmy. Wyświetla niektóre atrybuty firmy, które mogą zainteresować użytkownika końcowego.

Zapis JSON
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Pola
takeout

boolean

Czy miejsce oferuje dania na wynos.

delivery

boolean

Czy to miejsce oferuje dostawę.

dineIn

boolean

Czy w tym miejscu można zjeść posiłek.