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,
  "includeFutureOpeningBusinesses": boolean
}
Pola
input

string

Wymagane. Ciąg tekstowy, w którym ma zostać przeprowadzone wyszukiwanie.
locationBias

object (LocationBias)

Opcjonalnie. Przesuwanie wyników w kierunku określonej lokalizacji.

Należy ustawić co najwyżej jedną z tych właściwości: locationBias lub locationRestriction. Jeśli żadna z tych opcji nie zostanie ustawiona, wyniki będą obciążone adresem IP, co oznacza, że adres IP zostanie przypisany do niedokładnej lokalizacji i użyty jako sygnał obciążający.
locationRestriction

object (LocationRestriction)

Opcjonalnie. Ogranicz wyniki do określonej lokalizacji.

Należy ustawić co najwyżej jedną z tych właściwości: locationBias lub locationRestriction. Jeśli żadna z tych opcji nie zostanie ustawiona, wyniki będą obciążone adresem IP, co oznacza, że adres IP zostanie przypisany do niedokładnej lokalizacji i użyty jako sygnał obciążający.
includedPrimaryTypes[]

string

Opcjonalnie. Zawiera podstawowy typ miejsca (np. „restaurant” lub „gas_station”) w sekcji Typy 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 główny typ znajduje się na tej liście. Możesz określić maksymalnie 5 wartości. Jeśli nie określisz żadnych typów, zwracane będą wszystkie typy miejsc.
includedRegionCodes[]

string

Opcjonalnie. Uwzględniaj tylko wyniki z określonych regionów, podanych jako maksymalnie 15 dwuznakowych kodów 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 przecięcia.
languageCode

string

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

string

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

object (LatLng)

Opcjonalnie. Punkt początkowy, od którego należy obliczyć odległość geodezyjną do miejsca docelowego (zwracany jako distanceMeters). Jeśli ta wartość zostanie pominięta, odległość geodezyjna nie zostanie zwrócona.
inputOffset

integer

Opcjonalnie. Przesunięcie znaku Unicode liczone od zera, wynoszące input, które wskazuje pozycję kursora w input. Pozycja kursora może wpływać na zwracane prognozy.

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

boolean

Opcjonalnie. Jeśli wartość to „true”, odpowiedź będzie zawierać zarówno prognozy dotyczące miejsca, jak i prognozy dotyczące zapytania. W przeciwnym razie odpowiedź będzie zawierać tylko podpowiedzi dotyczące miejsc.
sessionToken

string

Opcjonalnie. Ciąg znaków, który identyfikuje sesję autouzupełniania na potrzeby rozliczeń. Musi to być bezpieczny ciąg znaków 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 zaczyna wpisywać zapytanie, a kończy się, gdy wybierze miejsce i wykona wywołanie interfejsu informacje o miejscu lub Weryfikacja adresów. Każda sesja może zawierać wiele zapytań, po których następuje 1 żądanie informacji o miejscu lub weryfikacji adresu. Dane logowania używane w każdym żądaniu 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 sessionToken zostanie pominięty lub jeśli użyjesz ponownie tokena sesji, sesja zostanie obciążona tak, jakby nie podano tokena sesji (każde żądanie jest rozliczane osobno).

Zalecamy stosowanie tych wytycznych:

  • Używaj tokenów sesji we wszystkich wywołaniach autouzupełniania miejsc.
  • Generuj nowy token dla każdej sesji. Zalecamy używanie identyfikatora UUID w wersji 4.
  • Upewnij się, że dane logowania używane we wszystkich żądaniach autouzupełniania miejsc, szczegółów miejsc i weryfikacji adresu w ramach sesji należą do tego samego projektu w Konsoli Cloud.
  • Pamiętaj, aby przekazywać unikalny token sesji dla każdej nowej sesji. Używanie tego samego tokena w przypadku więcej niż jednej sesji spowoduje naliczenie opłaty za każde żądanie z osobna.
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 firmy. Mogą to być hydraulicy lub firmy świadczące usługi sprzątania. Nie mają one fizycznego adresu ani lokalizacji w Mapach Google. W przypadku tych firm Miejsca nie będą zwracać pól, w tym location, plusCode i innych pól związanych z lokalizacją.
includeFutureOpeningBusinesses

boolean

Opcjonalnie. Jeśli tak, uwzględnij firmy, które nie są jeszcze otwarte, ale zostaną otwarte w przyszłości.

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ądkowanych 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, w którym ma się odbywać wyszukiwanie. Wyniki mogą być obciążone w odniesieniu do określonego 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 zbiorcze type.

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

object (Viewport)

Obszar widoczny zdefiniowany przez północno-wschodni i południowo-zachodni róg.
circle

object (Circle)

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

LocationRestriction

Region, w którym ma się odbywać wyszukiwanie. Wyniki zostaną ograniczone do określonego 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 zbiorcze type.

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

object (Viewport)

Obszar widoczny zdefiniowany przez północno-wschodni i południowo-zachodni róg.
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 zbiorcze kind.

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

object (PlacePrediction)

Prognoza dla miejsca.
queryPrediction

object (QueryPrediction)

Prognoza dotycząca zapytania.

PlacePrediction

Wyniki prognozy dla podpowiedzi Autouzupełniania miejsc.

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. Ten identyfikator może być używany w innych interfejsach API, które akceptują identyfikatory miejsc.
text

object (FormattableText)

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

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

Ten tekst może się różnić od tekstu displayName zwracanego przez places.get.

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

object (StructuredFormat)

Zestawienie podpowiedzi Miejsc na tekst główny zawierający nazwę Miejsca i tekst dodatkowy zawierający dodatkowe cechy rozróżniające (np. miasto lub region).

structuredFormat jest zalecany dla deweloperów, którzy chcą wyświetlać 2 osobne, ale powiązane ze sobą elementy interfejsu. Deweloperzy, którzy chcą wyświetlić jeden element interfejsu, mogą zamiast tego użyć text. Są to 2 różne sposoby przedstawiania podpowiedzi dotyczącej Miejsca. Użytkownicy nie powinni próbować przekształcać structuredFormat w text ani odwrotnie.
types[]

string

Lista typów, które odnoszą się do 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 udostępnionych typach będą miały podobne cechy.
distanceMeters

integer

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

FormattableText

Tekst reprezentujący miejsce lub prognozę zapytania. Tekst może być używany w niezmienionej postaci lub sformatowany.

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

string

Tekst, którego można użyć w niezmienionej formie lub sformatować za pomocą matches.
matches[]

object (StringRange)

Lista zakresów ciągów tekstowych określających, gdzie w text wystąpiło dopasowanie żądania wejściowego. Zakresy można stosować do formatowania określonych części text. Podciągi mogą nie być dokładnymi dopasowaniami do input, jeśli dopasowanie zostało określone na podstawie kryteriów innych niż dopasowanie ciągów znaków (np. korekty pisowni lub transliteracji).

Te wartości to przesunięcia znaków Unicode względem znaku text. Zakresy są uporządkowane według rosnących wartości przesunięcia.

StringRange

Wskazuje podłańcuch w danym tekście.

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

integer

Indeks pierwszego znaku Unicode w ciągu (włącznie), liczony od zera.
endOffset

integer

Indeks ostatniego znaku Unicode (wykluczając najwyższą wartość).

StructuredFormat

Zawiera podział prognozy Miejsca lub zapytania na tekst główny i tekst dodatkowy.

W przypadku prognoz dotyczących miejsca główny tekst zawiera konkretną nazwę miejsca. W przypadku prognoz zapytań główny tekst zawiera zapytanie.

Tekst dodatkowy zawiera dodatkowe cechy rozróżniające (np. miasto lub region), które pozwalają dokładniej zidentyfikować miejsce lub doprecyzować zapytanie.

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

object (FormattableText)

Reprezentuje nazwę miejsca lub zapytania.
secondaryText

object (FormattableText)

Reprezentuje dodatkowe cechy rozróżniające (np. miasto lub region), które pozwalają dokładniej zidentyfikować miejsce lub doprecyzować zapytanie.

QueryPrediction

Wyniki podpowiedzi autouzupełniania zapytania.

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

object (FormattableText)

Przewidywany tekst. Ten tekst nie reprezentuje Miejsca, ale zapytanie tekstowe, które można wykorzystać w punkcie końcowym wyszukiwania (np. w Wyszukaj tekst).

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

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

object (StructuredFormat)

Podział podpowiedzi zapytania na tekst główny zawierający zapytanie i tekst dodatkowy zawierający dodatkowe funkcje uściślające (np. miasto lub region).

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