Method: places.searchText

Tekstowe wyszukiwanie miejsca na podstawie zapytania.

Żą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)
  }
}
Pola
textQuery

string

Wymagane. Zapytanie tekstowe dla wyszukiwania tekstowego.

languageCode

string

Informacje o miejscu będą wyświetlane w preferowanym języku, jeśli jest dostępny. Jeśli kod języka jest nieokreślony lub nierozpoznany, mogą zostać zwrócone informacje o dowolnym języku z preferencją języka angielskiego, jeśli takie dane istnieją.

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

regionCode

string

Kod kraju/regionu Unicode (CLDR) lokalizacji, z której pochodzi żądanie. Ten parametr służy do wyświetlania szczegółowych informacji o miejscu, takich jak nazwa miejsca w określonym regionie, jeśli jest dostępna. Ten parametr może wpływać na wyniki w zależności od obowiązującego prawa.

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)

Sposób sortowania wyników w odpowiedzi.

includedType

string

Wybrany typ miejsca. Pełna lista obsługiwanych typów: https://developers.google.com/maps/documentation/places/web-service/place-types. Obsługuj tylko 1 uwzględniony typ.

openNow

boolean

Służy do ograniczenia wyszukiwania do miejsc, które są aktualnie otwarte. Wartość domyślna to false (fałsz).

minRating

number

Odfiltruj wyniki, w przypadku których średnia ocena użytkowników jest znacznie niższa od tego limitu. Prawidłowa wartość musi być liczbą zmiennoprzecinkową z zakresu od 0 do 5 (włącznie) z częstotliwością 0,5, czyli [0, 0,5, 1,0, ... , 5,0] włącznie. Ocena wejściowa zostanie zaokrąglona w górę do najbliższej wielokrotności 0,5. Na przykład ocena 0,6 spowoduje wyeliminowanie wszystkich wyników z oceną mniejszą niż 1,0.

maxResultCount
(deprecated)

integer

Wycofane: użyj atrybutu pageSize.

Maksymalna liczba wyników na stronę, które mogą zostać zwrócone. Jeśli liczba dostępnych wyników jest większa niż maxResultCount, zwracany jest parametr nextPageToken, który można przekazać do funkcji pageToken, aby w kolejnych żądaniach wyświetlić następną stronę wyników. Jeśli nie podasz żadnej wartości lub zostanie ona podana, zostanie użyta wartość domyślna, czyli 20. Maksymalna wartość to 20. wartości powyżej 20 zostaną zmienione na 20. Wartości ujemne będą zwracały błąd invalid_ARGUMENT.

Jeśli określono zarówno maxResultCount, jak i pageSize, parametr maxResultCount jest ignorowany.

pageSize

integer

Opcjonalnie: Maksymalna liczba wyników na stronę, które mogą zostać zwrócone. Jeśli liczba dostępnych wyników jest większa niż pageSize, zwracany jest parametr nextPageToken, który można przekazać do funkcji pageToken, aby w kolejnych żądaniach wyświetlić następną stronę wyników. Jeśli nie podasz żadnej wartości lub zostanie ona podana, zostanie użyta wartość domyślna, czyli 20. Maksymalna wartość to 20. wartości powyżej 20 zostaną ustawione na 20. Wartości ujemne będą zwracały błąd invalid_ARGUMENT.

Jeśli określono zarówno maxResultCount, jak i pageSize, parametr maxResultCount jest ignorowany.

pageToken

string

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

Podczas dzielenia na strony wszystkie parametry inne niż pageToken, pageSize i maxResultCount podane w TextSearch muszą pasować do pierwszego wywołania, które dostarczyło token strony. W przeciwnym razie zwracany jest błąd DOCUMENT_AR.

priceLevels[]

enum (PriceLevel)

Służy do ograniczenia wyszukiwania do miejsc oznaczonych jako określone poziomy cen. Użytkownicy mogą wybierać dowolne kombinacje poziomów cen. Domyślnie wybieraj wszystkie poziomy cenowe.

strictTypeFiltering

boolean

Służy do ustawiania ścisłego filtrowania typów atrybutów includeType. Jeśli ma wartość Prawda, zwracane są tylko wyniki tego samego typu. Wartość domyślna to fałsz.

locationBias

object (LocationBias)

Region do przeszukania. Ta lokalizacja powoduje odchylenie, co oznacza, że wyniki dotyczące danej lokalizacji mogą być zwracane. Nie można ustawić tej wartości razem z ograniczeniem lokalizacji.

locationRestriction

object (LocationRestriction)

Region do przeszukania. Ta lokalizacja stanowi ograniczenie, co oznacza, że wyniki spoza danej lokalizacji nie będą zwracane. Nie można go ustawić razem z informacjami o Bias.

evOptions

object (EVOptions)

Opcjonalnie: Ustaw dostępne dla wyszukiwarki opcje EV w żądaniu wyszukiwania miejsca.

Treść odpowiedzi

Protokół odpowiedzi na temat places.searchText.

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

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

object (Place)

Lista miejsc, które spełniają kryteria wyszukiwania tekstowego.

contextualContents[]

object (ContextualContent)

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

Lista treści kontekstowych, w przypadku których każdy wpis wiąże się z odpowiednim miejscem w tym samym indeksie w polu miejsc. Preferowane są treści, które odnoszą się do elementu textQuery w żądaniu. Jeśli treści kontekstowe nie są dostępne dla danego miejsca, zostaną wyświetlone treści niezwiązane z kontekstem. Będzie pusta tylko wtedy, gdy treść będzie niedostępna dla tego miejsca. Lista powinna zawierać tyle pozycji, ile brakuje na liście miejsc.

nextPageToken

string

Token, który może zostać wysłany jako pageToken w celu pobrania następnej strony. Jeśli to pole zostanie pominięte lub będzie puste, kolejne strony nie będą wyświetlane.

RankPreference

Sposób sortowania wyników w odpowiedzi.

Wartości w polu enum
RANK_PREFERENCE_UNSPECIFIED W przypadku zapytań kategorialnych, takich jak „Restauracje w Krakowie”, wartość ODPOWIEDNIA jest domyślna. W przypadku zapytań niezwiązanych z kategorią, np. „Mountain View, CA” zalecamy nieskonfigurowanie pozycji rankPreference.
DISTANCE Ranking wyników według odległości.
RELEVANCE Ranking wyników według trafności. Kolejność sortowania jest określana przez normalny stos rankingowy.

LocationBias

Region do przeszukania. Ta lokalizacja powoduje odchylenie, co oznacza, że wyniki dotyczące danej lokalizacji mogą być zwracane.

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 sumy type.

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

rectangle

object (Viewport)

Prostokątna ramka wyznaczone przez narożnik północno-wschodni i południowy. rectangle.high() musi być północno-wschodnim punktem widocznego obszaru prostokąta. rectangle.low() musi znajdować się w południowo-zachodnim punkcie widocznego obszaru prostokąta. Wartość rectangle.low().latitude() nie może być większa niż rectangle.high().latitude(). Spowoduje to pusty zakres szerokości geograficznej. Widoczny prostokątny obszar nie może być szerszy niż 180 stopni.

circle

object (Circle)

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

LocationRestriction

Region do przeszukania. Ta lokalizacja stanowi ograniczenie, co oznacza, że wyniki spoza danej 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 sumy type.

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

rectangle

object (Viewport)

Prostokątna ramka wyznaczone przez narożnik północno-wschodni i południowy. rectangle.high() musi być północno-wschodnim punktem widocznego obszaru prostokąta. rectangle.low() musi znajdować się w południowo-zachodnim punkcie widocznego obszaru prostokąta. Wartość rectangle.low().latitude() nie może być większa niż rectangle.high().latitude(). Spowoduje to pusty zakres szerokości geograficznej. Widoczny prostokątny obszar nie może być szerszy niż 180 stopni.

EVOptions

Opcje EV dostępne do przeszukiwania w przypadku żądania wyszukiwania miejsca.

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

number

Opcjonalnie: Minimalna wymagana szybkość ładowania w kilowatach. Miejsce, w którym cena ładowania jest niższa niż podana stawka, zostanie odfiltrowana.

connectorTypes[]

enum (EVConnectorType)

Opcjonalnie: Lista preferowanych typów złączy EV. Miejsce, które nie obsługuje żadnego z wymienionych typów oprogramowania sprzęgającego, zostanie odfiltrowane.

ContextualContent

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

Treść, która ma związek z zapytaniem dotyczącym miejsca.

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

object (Review)

Lista opinii o tym miejscu, połączonych z zapytaniem dotyczącym miejsca.

photos[]

object (Photo)

Informacje (w tym odniesienia) o zdjęciach tego miejsca, powiązane z zapytaniem dotyczącym miejsca.

justifications[]

object (Justification)

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

Uzasadnienie miejsca.

Uzasadnienie

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

Uzasadnienie miejsca. Uzasadnienie odpowiada 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 sumy justification.

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

reviewJustification

object (ReviewJustification)

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

businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

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

ReviewJustification

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

Uzasadnienie opinii użytkownika. Powoduje to wyróżnienie sekcji opinii użytkownika, która może zainteresować użytkownika. Jeśli na przykład zapytanie to „pizza z drewna”, w uzasadnieniu opinii zostanie wyróżniony tekst pasujący do wyszukiwanego hasła.

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

object (HighlightedText)

review

object (Review)

Opinia, na podstawie której wygenerowano zaznaczony tekst.

HighlightedText

Tekst wyróżniony uzasadnieniem. Jest to podzbiór opinii. Dokładne słowo, które ma zostać zaznaczone, jest oznaczone wartością zaznaczonego zakresutekstu. 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

Funkcja eksperymentalna: więcej informacji znajdziesz na stronie https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative. Uzasadnienia atrybutów BusinessAvailability. Pokazuje atrybuty firmy, które mogą zainteresować użytkownika.

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

boolean

Jeśli miejsce oferuje dania na wynos.

delivery

boolean

Jeśli dane miejsce oferuje dostawę.

dineIn

boolean

czy miejsce oferuje jedzenie na miejscu;