Method: places.autocomplete

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 (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "includedPrimaryTypes": [
    string
  ],
  "includedRegionCodes": [
    string
  ],
  "languageCode": string,
  "regionCode": string,
  "origin": {
    object (LatLng)
  },
  "inputOffset": integer,
  "includeQueryPredictions": boolean,
  "sessionToken": string,
  "includePureServiceAreaBusinesses": boolean
}
Pola
input

string

Wymagany. Tekst, w którym ma być przeprowadzone wyszukiwanie.
locationBias

object (LocationBias)

Opcjonalnie: Wyniki są przybliżone do określonej lokalizacji.

Maksymalnie jeden z tych parametrów: locationBias lub locationRestriction powinien być ustawiony. Jeśli żaden z tych parametrów nie zostanie ustawiony, wyniki będą obarczone błędem wynikającym z adresu IP, co oznacza, że adres IP zostanie zmapowany na nieprecyzyjną lokalizację i użyty jako sygnał zastępczy.
locationRestriction

object (LocationRestriction)

Opcjonalnie: Ogranicz wyniki do określonej lokalizacji.

Maksymalnie jeden z tych parametrów: locationBias lub locationRestriction powinien być ustawiony. Jeśli żaden z tych parametrów nie zostanie ustawiony, wyniki będą obarczone błędem wynikającym z adresu IP, co oznacza, że adres IP zostanie zmapowany na nieprecyzyjną lokalizację i użyty jako sygnał zastępczy.
includedPrimaryTypes[]

string

Opcjonalnie: Uwzględnij podstawowy typ Miejsca (np. „restaurant” lub „gas_station”) w typach Miejsc (https://developers.google.com/maps/documentation/places/web-service/place-types) lub tylko (regions) lub tylko (cities). Miejsce jest zwracane tylko wtedy, gdy jego podstawowy typ znajduje się na tej liście. Możesz podać maksymalnie 5 wartości. Jeśli nie podasz żadnych typów, zwrócone zostaną wszystkie typy miejsc.
includedRegionCodes[]

string

Opcjonalnie: Uwzględniaj tylko wyniki z określonych regionów, które są określone jako maksymalnie 15-cyfrowe kody regionów CLDR. Pusty zbiór nie ograniczy wyników. Jeśli ustawisz zarówno parametr locationRestriction, jak i includedRegionCodes, wyniki będą znajdować się w obszarze ich przecięcia.
languageCode

string

Opcjonalnie: Język, w którym mają być zwracane wyniki. Domyślna wartość to en-US. Wyniki mogą być podane w różnych językach, jeśli język używany w input różni się od języka languageCode lub jeśli zwrócone Miejsce nie ma tłumaczenia z języka lokalnego na languageCode.
regionCode

string

Opcjonalnie: Kod regionu określony jako dwuznakowy kod regionu CLDR. Ma to wpływ na formatowanie adresu, ranking wyników i może wpływać na wyniki zwracane. Nie ogranicza to wyników do określonego regionu. Aby ograniczyć wyniki do regionu, użyj region_code_restriction.
origin

object (LatLng)

Opcjonalnie: Punkt początkowy, z którego ma być obliczona odległość geodezyjna do punktu docelowego (zwracana jako distanceMeters). Jeśli ta wartość zostanie pominięta, odległość geodezyjna nie zostanie zwrócona.
inputOffset

integer

Opcjonalnie: Odsunięcie znaku Unicode o wartość input liczone od 0, wskazujące pozycję kursora w elementach input. Pozycja kursora może wpływać na prognozy zwracane przez model.

Jeśli jest puste, przyjmuje domyślnie długość input.
includeQueryPredictions

boolean

Opcjonalnie: Jeśli wartość to prawda, odpowiedź będzie zawierać zarówno prognozy dotyczące Miejsca, jak i zapytania. W przeciwnym razie odpowiedź zwróci tylko prognozy dotyczące miejsc.
sessionToken

string

Opcjonalnie: Ciąg tekstowy identyfikujący sesję Autouzupełniania na potrzeby rozliczeń. Musi być bezpiecznym ciągiem znaków w formacie base64, który może zawierać maksymalnie 36 znaków ASCII. W przeciwnym razie zwracany jest błąd INVALID_ARGUMENT.

Sesja rozpoczyna się, gdy użytkownik zacznie wpisywać zapytanie, a kończy, gdy wybierze miejsce i wywoła szczegóły miejsca lub weryfikację adresu. Każda sesja może zawierać wiele zapytań, po których następuje jedno żądanie dotyczące szczegółów miejsca docelowego lub weryfikacji adresu. Dane logowania używane w przypadku każdego żądania w ramach sesji muszą należeć do tego samego projektu w Google Cloud Console. Po zakończeniu sesji token nie jest już ważny. Aplikacja musi wygenerować nowy token dla każdej sesji. Jeśli pominiesz parametr sessionToken lub użyjesz ponownie tokenu sesji, sesja zostanie obciążona opłatą tak, jakby nie podano tokenu sesji (każda prośba jest rozliczana osobno).

Zalecamy przestrzeganie tych wskazówek:

  • Używaj tokenów sesji we wszystkich wywołaniach autouzupełniania w Google Places.
  • generować nowy token dla każdej sesji; Zalecamy używanie identyfikatora UUID w wersji 4.
  • Upewnij się, że dane logowania używane do wszystkich żądań autouzupełniania, szczegółów miejsca i weryfikacji adresu w ramach sesji należą do tego samego projektu w Cloud Console.
  • Pamiętaj, aby w przypadku każdej nowej sesji przekazać unikalny token sesji. Użycie tego samego tokena w więcej niż 1 sesji spowoduje, że za każde żądanie zostanie naliczona osobna opłata.
includePureServiceAreaBusinesses

boolean

Opcjonalnie: Uwzględnij firmy działające tylko na określonym obszarze, jeśli pole zawiera wartość true. Firma działająca 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. Firmy te nie mają adresu fizycznego ani lokalizacji w Mapach Google. W przypadku tych firm Places nie zwróci pól location, plusCode ani innych pól związanych z lokalizacją.

Treść odpowiedzi

Protokół odpowiedzi dla places.autocomplete.

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

Zapis JSON 
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Pola
suggestions[]

object (Suggestion)

Zawiera listę sugestii uporządkowaną w kolejności malejącej według trafności.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

LocationBias

Region wyszukiwania. Wyniki mogą być stronnicze w przypadku regionu, którego dotyczyły.

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

type może być tylko jednym z tych elementów:
rectangle

object (Viewport)

Widok definiowany przez narożnik północno-wschodni i narożnik południowo-zachodni.
circle

object (Circle)

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

LocationRestriction

Region wyszukiwania. Wyniki zostaną ograniczone do wybranego regionu.

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

type może być tylko jednym z tych elementów:
rectangle

object (Viewport)

Widok definiowany przez narożnik północno-wschodni i narożnik południowo-zachodni.
circle

object (Circle)

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

Sugestia

Wynik sugestii autouzupełniania.

Zapis JSON 
{

  // Union field kind can be only one of the following:
  "placePrediction": {
    object (PlacePrediction)
  },
  "queryPrediction": {
    object (QueryPrediction)
  }
  // End of list of possible types for union field kind.
}
Pola

Pole unii kind.

kind może być tylko jednym z tych elementów:
placePrediction

object (PlacePrediction)

Prognoza dotycząca miejsca.
queryPrediction

object (QueryPrediction)

Prognoza dla zapytania.

PlacePrediction

Wyniki prognozy dla podpowiedzi autouzupełniania Miejsce.

Zapis JSON 
{
  "place": string,
  "placeId": string,
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  },
  "types": [
    string
  ],
  "distanceMeters": integer
}
Pola
place

string

Nazwa zasobu sugerowanego Miejsca. Tej nazwy można używać w innych interfejsach API, które akceptują nazwy miejsc.
placeId

string

Unikalny identyfikator sugerowanego Miejsca. Można go używać w innych interfejsach API, które akceptują identyfikatory miejsc.
text

object (FormattableText)

Zawiera czytelną dla człowieka nazwę zwróconego wyniku. W przypadku wyników dotyczących obiektów jest to zwykle nazwa i adres firmy.

text jest zalecana dla programistów, którzy chcą wyświetlać pojedynczy element interfejsu. Deweloperzy, którzy chcą wyświetlać 2 oddzielne, ale powiązane elementy interfejsu, mogą zamiast tego użyć structuredFormat. Są to 2 różne sposoby przedstawiania prognozy miejsca. Użytkownicy nie powinni próbować przekształcać structuredFormat w text ani odwrotnie.

Ten tekst może się różnić od wartości displayName zwracanej przez places.get.

Może być w różnych językach, jeśli żądanie input i languageCode są w różnych językach lub jeśli miejsce docelowe nie ma tłumaczenia z języka lokalnego na languageCode.
structuredFormat

object (StructuredFormat)

Podział przewidywanej lokalizacji na tekst główny zawierający nazwę lokalizacji i tekst dodatkowy z dodatkowymi funkcjami rozróżniającymi (np. miasto lub region).

structuredFormat jest zalecany deweloperom, którzy chcą wyświetlać 2 oddzielne, ale powiązane elementy interfejsu. Deweloperzy, którzy chcą wyświetlić pojedynczy element interfejsu, mogą użyć elementu text. Są to 2 różne sposoby przedstawiania prognozy miejsca. Użytkownicy nie powinni próbować przekształcać structuredFormat w text ani odwrotnie.
types[]

string

Lista typów, które dotyczą tego Miejsca, z tabeli A lub tabeli B na stronie https://developers.google.com/maps/documentation/places/web-service/place-types.

Typ to kategoria Miejsca. Miejsca o tych samych typach mają podobne cechy.
distanceMeters

integer

Długość geodezyjna w metrach od origin, jeśli origin jest określony. Niektóre prognozy, np. trasy, mogą nie wypełniać tego pola.

FormattableText

Tekst przedstawiający prognozę Miejsca lub zapytania. Tekst może być użyty w takiej postaci lub sformatowany.

Zapis JSON 
{
  "text": string,
  "matches": [
    {
      object (StringRange)
    }
  ]
}
Pola
text

string

Tekst, który można użyć w takiej postaci lub sformatowany za pomocą matches.
matches[]

object (StringRange)

Lista zakresów ciągów tekstowych określająca, w których miejscach żądanie wejściowe pasuje do ciągu text. Za ich pomocą możesz sformatować określone części wyrażenia text. Podciągi podrzędne mogą nie być dopasowaniami ścisłymi do input, jeśli dopasowanie zostało określone na podstawie kryteriów innych niż dopasowanie ciągu znaków (np. poprawki ortograficzne lub transliteracje).

Te wartości to przesunięcie znaku Unicode o wartość text. Zakresy są zawsze sortowane według rosnących wartości przesunięcia.

StringRange

Wyznacza podciąg w danym tekście.

Zapis JSON 
{
  "startOffset": integer,
  "endOffset": integer
}
Pola
startOffset

integer

Odsunięcie pierwszego znaku Unicode w ciągu liczone od 0 (włącznie).
endOffset

integer

Odsunięcie ostatniego znaku Unicode (nie wliczając go) liczone od zera.

StructuredFormat

Zawiera podział przewidywanej nazwy miejsca lub zapytania na tekst główny i dodatkowy.

W przypadku przewidywanej lokalizacji tekst główny zawiera nazwę tej lokalizacji. W przypadku prognoz zapytań tekst główny zawiera zapytanie.

Tekst dodatkowy zawiera dodatkowe funkcje rozróżniania (np. miasto lub region), które umożliwiają dokładniejsze zidentyfikowanie Miejsca lub doprecyzowanie zapytania.

Zapis JSON 
{
  "mainText": {
    object (FormattableText)
  },
  "secondaryText": {
    object (FormattableText)
  }
}
Pola
mainText

object (FormattableText)

Reprezentuje nazwę Miejsca lub zapytania.
secondaryText

object (FormattableText)

Reprezentują dodatkowe cechy rozróżniające (np. miasto lub region), które umożliwiają dokładniejsze zidentyfikowanie Miejsca lub doprecyzowanie zapytania.

QueryPrediction

Wyniki prognozy dla podpowiedzi autouzupełniania zapytań.

Zapis JSON 
{
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  }
}
Pola
text

object (FormattableText)

Przewidziany tekst. Ten tekst nie reprezentuje Miejsca, ale zapytanie tekstowe, które może być użyte w punkcie końcowym wyszukiwania (np. wyszukiwaniu tekstowym).

text jest zalecana dla programistów, którzy chcą wyświetlać pojedynczy element interfejsu. Deweloperzy, którzy chcą wyświetlać 2 oddzielne, ale powiązane elementy interfejsu, mogą zamiast tego użyć structuredFormat. Są to 2 różne sposoby przedstawiania prognozy zapytań. Użytkownicy nie powinni próbować przekształcać structuredFormat w text ani odwrotnie.

Może być w różnych językach, jeśli zapytania input i languageCode są w różnych językach lub jeśli część zapytania nie ma tłumaczenia z języka lokalnego na languageCode.
structuredFormat

object (StructuredFormat)

Podział prognozy zapytania na tekst główny zawierający zapytanie i tekst dodatkowy zawierający dodatkowe cechy rozróżniające (np. miasto lub region).

structuredFormat jest zalecana dla deweloperów, którzy chcą wyświetlać 2 oddzielne, ale powiązane elementy interfejsu. Deweloperzy, którzy chcą wyświetlić pojedynczy element interfejsu, mogą użyć elementu text. Są to 2 różne sposoby przedstawiania prognozy zapytania. Użytkownicy nie powinni próbować przekształcać structuredFormat w text ani odwrotnie.