Method: places.autocomplete

Restituisce previsioni per l'input specificato.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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
}
Campi
input

string

Obbligatorio. La stringa di testo in cui eseguire la ricerca.

locationBias

object (LocationBias)

(Facoltativo) Indirizza i risultati verso una località specificata.

Deve essere impostato al massimo un valore tra locationBias o locationRestriction. Se nessuno dei due è impostato, i risultati saranno polarizzati in base all'indirizzo IP, il che significa che l'indirizzo IP verrà mappato su una posizione imprecisa e utilizzato come segnale di differenziazione.

locationRestriction

object (LocationRestriction)

(Facoltativo) Limita i risultati a una località specificata.

Deve essere impostato al massimo un valore tra locationBias o locationRestriction. Se nessuno dei due è impostato, i risultati saranno polarizzati in base all'indirizzo IP, il che significa che l'indirizzo IP verrà mappato su una posizione imprecisa e utilizzato come segnale di differenziazione.

includedPrimaryTypes[]

string

(Facoltativo) Tipo di luogo principale incluso (ad esempio "ristorante" o "gas_station") della Tabella A o della Tabella B nei tipi di luogo (https://developers.google.com/maps/documentation/places/web-service/place-types), solo (regioni) o solo (città). Un luogo viene restituito solo se il suo tipo principale è incluso in questo elenco. È possibile specificare fino a 5 valori. Se non viene specificato alcun tipo, vengono restituiti tutti i tipi di luogo.

includedRegionCodes[]

string

(Facoltativo) Includi i risultati solo nelle regioni specificate, specificate fino a un massimo di 15 codici regione a due caratteri CLDR. Un set vuoto non limiterà i risultati. Se sono impostati sia locationRestriction sia includedRegionCodes, i risultati verranno posizionati nell'area di intersezione.

languageCode

string

(Facoltativo) La lingua in cui restituire i risultati. Il valore predefinito è en-US. I risultati potrebbero essere in lingue diverse se la lingua utilizzata in input è diversa da languageCode o se il luogo restituito non ha una traduzione dalla lingua locale in languageCode.

regionCode

string

(Facoltativo) Il codice regione, specificato come codice regione a due caratteri CLDR. Ciò influisce sulla formattazione degli indirizzi e sul ranking dei risultati e potrebbe influire sui risultati restituiti. I risultati non vengono limitati alla regione specificata. Per limitare i risultati a una regione, utilizza region_code_restriction.

origin

object (LatLng)

(Facoltativo) Il punto di partenza da cui calcolare la distanza geodetica alla destinazione (restituito come distanceMeters). Se questo valore viene omesso, la distanza geodetica non verrà restituita.

inputOffset

integer

(Facoltativo) Un offset del carattere Unicode in base zero di input che indica la posizione del cursore in input. La posizione del cursore può influire sulle previsioni restituite.

Se vuoto, il valore predefinito è la lunghezza di input.

includeQueryPredictions

boolean

(Facoltativo) Se il valore è true, la risposta includerà le previsioni sia di Place sia di query. In caso contrario, la risposta restituirà solo previsioni sui luoghi.

sessionToken

string

(Facoltativo) Una stringa che identifica una sessione di completamento automatico ai fini della fatturazione. Deve essere una stringa base64 sicura per URL e nomi file con una lunghezza massima di 36 caratteri ASCII. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

La sessione inizia quando l'utente inizia a digitare una query e termina quando seleziona un luogo e viene effettuata una chiamata a Place Details o Address Validation. Ogni sessione può avere più query, seguite da una richiesta Place Details o Address Validation. Le credenziali utilizzate per ogni richiesta all'interno di una sessione devono appartenere allo stesso progetto della console Google Cloud. Una volta terminata la sessione, il token non è più valido. la tua app deve generare un nuovo token per ogni sessione. Se il parametro sessionToken viene omesso o se riutilizzi un token di sessione, la sessione viene addebitata come se non fosse stato fornito alcun token di sessione (ogni richiesta viene fatturata separatamente).

Consigliamo di attenerti alle seguenti linee guida:

  • Utilizza i token di sessione per tutte le chiamate Place Autocomplete.
  • Generare un nuovo token per ogni sessione. Si consiglia di utilizzare un UUID versione 4.
  • Assicurati che le credenziali utilizzate per tutte le richieste Place Autocomplete, Place Details e Address Validation all'interno di una sessione appartengano allo stesso progetto Cloud Console.
  • Assicurati di trasmettere un token di sessione univoco per ogni nuova sessione. Se utilizzi lo stesso token per più di una sessione, ogni richiesta verrà fatturata individualmente.

Corpo della risposta

Protocollo risposta per places.autocomplete.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Campi
suggestions[]

object (Suggestion)

Contiene un elenco di suggerimenti, in ordine decrescente di pertinenza.

LocationBias

La regione in cui eseguire la ricerca. I risultati potrebbero essere distorti rispetto alla regione specificata.

Rappresentazione 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.
}
Campi

Campo unione type.

type può essere solo uno dei seguenti:

rectangle

object (Viewport)

Una visualizzazione definita da un angolo nord-est e un angolo sud-ovest.

circle

object (Circle)

Un cerchio definito da un centro e da un raggio.

LocationRestriction

La regione in cui eseguire la ricerca. I risultati saranno limitati alla regione specificata.

Rappresentazione 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.
}
Campi

Campo unione type.

type può essere solo uno dei seguenti:

rectangle

object (Viewport)

Una visualizzazione definita da un angolo nord-est e un angolo sud-ovest.

circle

object (Circle)

Un cerchio definito da un centro e da un raggio.

Suggerimento

Un risultato di suggerimento di completamento automatico.

Rappresentazione 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.
}
Campi

Campo unione kind.

kind può essere solo uno dei seguenti:

placePrediction

object (PlacePrediction)

Una previsione per un luogo.

queryPrediction

object (QueryPrediction)

Una previsione per una query.

PlacePrediction

Risultati della previsione per una previsione di Place Autocomplete.

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

string

Il nome della risorsa del luogo suggerito. Questo nome può essere utilizzato in altre API che accettano i nomi dei luoghi.

placeId

string

L'identificatore univoco del luogo suggerito. Questo identificatore può essere utilizzato in altre API che accettano gli ID luogo.

text

object (FormattableText)

Contiene il nome leggibile per il risultato restituito. Per i risultati relativi alle attività, generalmente si tratta del nome e dell'indirizzo dell'attività.

L'istruzione text è consigliata per gli sviluppatori che vogliono mostrare un singolo elemento UI. Gli sviluppatori che vogliono mostrare due elementi UI separati ma correlati possono usare invece structuredFormat. Sono due modi diversi per rappresentare una previsione di un luogo. Gli utenti non dovrebbero provare ad analizzare structuredFormat in text o viceversa.

Questo testo potrebbe essere diverso da displayName restituito da places.get.

Potrebbero essere in lingue diverse se le richieste input e languageCode sono in lingue diverse o se il luogo non ha una traduzione dalla lingua locale in languageCode.

structuredFormat

object (StructuredFormat)

Una suddivisione della previsione relativa a un luogo in testo principale contenente il nome del luogo e testo secondario contenente altri elementi di disambiguazione (ad esempio una città o una regione).

L'istruzione structuredFormat è consigliata per gli sviluppatori che vogliono mostrare due elementi UI separati ma correlati. Gli sviluppatori che vogliono mostrare un singolo elemento UI potrebbero usare invece text. Sono due modi diversi per rappresentare una previsione di un luogo. Gli utenti non dovrebbero provare ad analizzare structuredFormat in text o viceversa.

types[]

string

Elenco dei tipi applicabili a questo luogo dalla Tabella A o dalla Tabella B in https://developers.google.com/maps/documentation/places/web-service/place-types.

Un tipo è la categorizzazione di un luogo. I luoghi con tipi condivisi avranno caratteristiche simili.

distanceMeters

integer

La lunghezza della geodetica in metri da origin se origin è specificato. Alcune previsioni come le route potrebbero non compilare questo campo.

FormattableText

Testo che rappresenta una previsione di un luogo o di una query. Il testo può essere utilizzato così com'è o formattato.

Rappresentazione JSON
{
  "text": string,
  "matches": [
    {
      object (StringRange)
    }
  ]
}
Campi
text

string

Testo che può essere utilizzato così com'è o formattato con matches.

matches[]

object (StringRange)

Un elenco di intervalli di stringhe che identificano il punto in cui la richiesta di input ha trovato una corrispondenza in text. Gli intervalli possono essere utilizzati per formattare parti specifiche di text. Le sottostringhe potrebbero non essere corrispondenze esatte di input se la corrispondenza è stata determinata da criteri diversi dalla corrispondenza delle stringhe (ad esempio, correzioni ortografiche o traslitterazioni).

Questi valori sono offset di caratteri Unicode di text. Gli intervalli vengono comunque ordinati in valori di offset crescenti.

StringRange

Identifica una sottostringa all'interno di un determinato testo.

Rappresentazione JSON
{
  "startOffset": integer,
  "endOffset": integer
}
Campi
startOffset

integer

Offset su base zero del primo carattere Unicode della stringa (incluso).

endOffset

integer

Offset su base zero dell'ultimo carattere Unicode (escluso).

StructuredFormat

Contiene una suddivisione di una previsione relativa a luoghi o query in testo principale e testo secondario.

Per le previsioni di luoghi, il testo principale contiene il nome specifico del luogo. Per le previsioni delle query, il testo principale contiene la query.

Il testo secondario contiene altre caratteristiche di disambiguazione (come una città o una regione) per identificare ulteriormente il luogo o perfezionare la query.

Rappresentazione JSON
{
  "mainText": {
    object (FormattableText)
  },
  "secondaryText": {
    object (FormattableText)
  }
}
Campi
mainText

object (FormattableText)

Rappresenta il nome del luogo o della query.

secondaryText

object (FormattableText)

Rappresenta altre caratteristiche di disambiguazione (come una città o una regione) per identificare ulteriormente il luogo o perfezionare la query.

QueryPrediction

Risultati di una previsione di completamento automatico di query.

Rappresentazione JSON
{
  "text": {
    object (FormattableText)
  },
  "structuredFormat": {
    object (StructuredFormat)
  }
}
Campi
text

object (FormattableText)

Il testo previsto. Questo testo non rappresenta un luogo, ma una query di testo che potrebbe essere utilizzata in un endpoint di ricerca (ad esempio, Ricerca testuale).

L'istruzione text è consigliata per gli sviluppatori che vogliono mostrare un singolo elemento UI. Gli sviluppatori che vogliono mostrare due elementi UI separati ma correlati possono usare invece structuredFormat. Sono due modi diversi per rappresentare una previsione di query. Gli utenti non dovrebbero provare ad analizzare structuredFormat in text o viceversa.

Potrebbero essere in lingue diverse se le richieste input e languageCode sono in lingue diverse o se parte della query non ha una traduzione dalla lingua locale a languageCode.

structuredFormat

object (StructuredFormat)

Un'analisi della previsione della query in testo principale contenente la query e testo secondario contenente ulteriori caratteristiche di disambiguazione (ad esempio una città o una regione).

L'istruzione structuredFormat è consigliata per gli sviluppatori che vogliono mostrare due elementi UI separati ma correlati. Gli sviluppatori che vogliono mostrare un singolo elemento UI potrebbero usare invece text. Sono due modi diversi per rappresentare una previsione di query. Gli utenti non dovrebbero provare ad analizzare structuredFormat in text o viceversa.