- Żądanie HTTP
- Treść żądania
- Treść odpowiedzi
- LocationBias
- LocationRestriction
- Sugestia
- PlacePrediction
- FormattableText
- StringRange:
- StructuredFormat
- QueryPrediction
Zwraca prognozy dla podanych danych wejściowych.
Żądanie HTTP
POST https://places.googleapis.com/v1/places:autocomplete
Adres URL używa składni transkodowania gRPC.
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "input": string, "locationBias": { object ( |
Pola | |
---|---|
input |
To pole jest wymagane. Ciąg tekstowy służący do wyszukiwania. |
locationBias |
Opcjonalnie. Odchylenia wyników do określonej lokalizacji. Należy ustawić maksymalnie jedną z tych wartości: |
locationRestriction |
Opcjonalnie. Ogranicz wyniki do określonej lokalizacji. Należy ustawić maksymalnie jedną z tych wartości: |
includedPrimaryTypes[] |
Opcjonalnie. Uwzględniono typ głównego miejsca (np. „restauracja” lub „stacja benzynowa”) ze strony https://developers.google.com/maps/documentation/places/web-service/place-types. Miejsce jest zwracane tylko wtedy, gdy na liście znajduje się jego główny typ. Można określić maksymalnie 5 wartości. Jeśli nie podasz żadnych typów miejsc, zwracane są wszystkie typy miejsc. |
includedRegionCodes[] |
Opcjonalnie. Uwzględnij wyniki tylko z określonych regionów określonych jako maksymalnie 15 2-znakowych kodów regionów CLDR. Pusty zestaw nie ogranicza wyników. Jeśli ustawisz zarówno wartość |
languageCode |
Opcjonalnie. Język, w którym mają być zwracane wyniki. Wartość domyślna to en-US. Wyniki mogą być w różnych językach, jeśli język używany w |
regionCode |
Opcjonalnie. Kod regionu określony jako dwuznakowy kod regionu CLDR. Ma to wpływ na formatowanie adresu i ranking wyników oraz może wpływać na zwracane wyniki. Nie ogranicza to wyników do określonego regionu. Aby ograniczyć wyniki do regionu, użyj operatora |
origin |
Opcjonalnie. Punkt początkowy, z którego należy obliczyć odległość geodezyjną do miejsca docelowego (zwrócony jako |
inputOffset |
Opcjonalnie. Przesunięcie znaków w standardzie Unicode liczone od zera za pomocą Jeśli pole jest puste, domyślnie przyjmuje długość |
includeQueryPredictions |
Opcjonalnie. Jeśli ma wartość true (prawda), odpowiedź będzie zawierać zarówno podpowiedzi dotyczące miejsca, jak i zapytania. W przeciwnym razie odpowiedź będzie zwracać tylko podpowiedzi dotyczące miejsc. |
sessionToken |
Opcjonalnie. Ciąg znaków, który identyfikuje sesję autouzupełniania na potrzeby rozliczeń. Musi to być bezpieczny adres URL i bezpieczny dla nazwy pliku ciąg base64 o długości nie większej niż 36 znaków ASCII. W przeciwnym razie zwracany jest błąd INVALID_ARGUMENT. Sesja zaczyna się, gdy użytkownik zaczyna wpisywać zapytanie, a kończy się, gdy wybiera miejsce i wysyła żądanie informacji o miejscu lub weryfikacji adresu. Każda sesja może obejmować wiele zapytań, po których następuje 1 prośba o informacje o miejscu lub o weryfikację adresu. Dane logowania używane w przypadku każdego żądania w ramach sesji muszą należeć do tego samego projektu w konsoli Google Cloud. Po zakończeniu sesji token traci ważność. Aplikacja musi generować nowy token dla każdej sesji. Jeśli parametr Zalecamy stosowanie tych wytycznych:
|
Treść odpowiedzi
Odpowiedź proto dotycząca miejsca places.autocomplete.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"suggestions": [
{
object ( |
Pola | |
---|---|
suggestions[] |
Zawiera listę sugestii uporządkowanych malejąco według trafności. |
LocationBias
Region do przeszukania. Wyniki mogą być stronnicze.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
rectangle |
Widoczny obszar wyznaczony przez róg północno-wschodni. |
circle |
Okrąg określony przez punkt środkowy i promień. |
LocationRestriction
Region do przeszukania. Wyniki będą ograniczone do określonego regionu.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
rectangle |
Widoczny obszar wyznaczony przez róg północno-wschodni. |
circle |
Okrąg określony przez punkt środkowy i promień. |
Sugestia
Wynik sugestii autouzupełniania.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
placePrediction |
Prognoza dotycząca miejsca. |
queryPrediction |
Prognoza dla zapytania. |
PlacePrediction
Wyniki prognozy dla podpowiedzi autouzupełniania miejsc.
Zapis JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Pola | |
---|---|
place |
Nazwa zasobu sugerowanego miejsca. Ta nazwa może być używana w innych interfejsach API, które akceptują nazwy miejsc. |
placeId |
Unikalny identyfikator sugerowanego miejsca. Tego identyfikatora można używać w innych interfejsach API, które akceptują identyfikatory miejsc. |
text |
Zawiera zrozumiałą dla człowieka nazwę zwróconego wyniku. W przypadku wyników firmy zwykle jest to nazwa i adres firmy. Parametr Ten tekst może się różnić od wartości Mogą być podane w różnych językach, jeśli |
structuredFormat |
Podział prognozy miejsca na tekst główny zawierający nazwę miejsca i tekst dodatkowy zawierający dodatkowe cechy ujednoznaczniejące, np. nazwę miasta lub regionu. Parametr |
types[] |
Lista typów dotyczących tego miejsca z Tabeli A lub B na stronie https://developers.google.com/maps/documentation/places/web-service/place-types. Typ to kategoria miejsca. Miejsca o wspólnych typach mają podobne cechy. |
distanceMeters |
Długość geodezyjna w metrach od |
FormattableText
Tekst reprezentujący podpowiedź dotyczącą miejsca lub zapytania. Tekst może być używany w niezmienionej postaci lub w sposób sformatowany.
Zapis JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Pola | |
---|---|
text |
Tekst, który może być użyty w niezmienionej formie lub za pomocą funkcji |
matches[] |
Lista zakresów ciągów znaków wskazujących miejsce dopasowania żądania wejściowego w funkcji Te wartości to przesunięcia znaków Unicode |
StringRange
Identyfikuje podłańcuch w podanym tekście.
Zapis JSON |
---|
{ "startOffset": integer, "endOffset": integer } |
Pola | |
---|---|
startOffset |
Przesunięcie od zera pierwszego znaku Unicode ciągu znaków (włącznie). |
endOffset |
Przesunięcie od zera ostatniego znaku Unicode (wyłącznie). |
StructuredFormat
Zawiera podział prognozy miejsca lub zapytania na tekst główny i dodatkowy.
W przypadku podpowiedzi dotyczących miejsc główny tekst zawiera konkretną nazwę miejsca. W przypadku prognoz zapytań tekst główny zawiera zapytanie.
Tekst dodatkowy zawiera dodatkowe elementy ujednoznaczniejące (np. nazwę miasta lub regionu), które umożliwiają dalszą identyfikację miejsca lub doprecyzowanie zapytania.
Zapis JSON |
---|
{ "mainText": { object ( |
Pola | |
---|---|
mainText |
Reprezentuje nazwę miejsca lub zapytania. |
secondaryText |
Przedstawia dodatkowe jednoznaczne obiekty (takie jak miasto lub region) w celu dalszej identyfikacji miejsca lub doprecyzowania zapytania. |
QueryPrediction
Wyniki prognozy dla prognozy autouzupełniania zapytania.
Zapis JSON |
---|
{ "text": { object ( |
Pola | |
---|---|
text |
Przewidywany tekst. Ten tekst nie reprezentuje miejsca, lecz zapytaniem, którego można użyć w punkcie końcowym wyszukiwania (np. wyszukiwanie tekstowe). Parametr Może występować w różnych językach, jeśli żądania |
structuredFormat |
Podział prognozy zapytania na tekst główny zawierający zapytanie i tekst dodatkowy z dodatkowymi cechami ujednoznaczniejącymi (np. nazwą miasta lub regionu). Parametr |