Method: places.autocomplete

Restituisce le 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,
  "includePureServiceAreaBusinesses": boolean,
  "includeFutureOpeningBusinesses": boolean
}
Campi
input

string

Obbligatorio. La stringa di testo su cui eseguire la ricerca.
locationBias

object (LocationBias)

Facoltativo. Orientare i risultati verso una posizione specificata.

Deve essere impostato al massimo un valore per locationBias o locationRestriction. Se non è impostato nessuno dei due, i risultati saranno influenzati dall'indirizzo IP, il che significa che l'indirizzo IP verrà mappato a una posizione imprecisa e utilizzato come segnale di distorsione.
locationRestriction

object (LocationRestriction)

Facoltativo. Limita i risultati a una posizione specificata.

Deve essere impostato al massimo un valore per locationBias o locationRestriction. Se non è impostato nessuno dei due, i risultati saranno influenzati dall'indirizzo IP, il che significa che l'indirizzo IP verrà mappato a una posizione imprecisa e utilizzato come segnale di distorsione.
includedPrimaryTypes[]

string

Facoltativo. Tipo di luogo principale incluso (ad esempio "ristorante" o "stazione di servizio") in Tipi di luoghi (https://developers.google.com/maps/documentation/places/web-service/place-types) o solo (regions) o solo (cities). Un luogo viene restituito solo se il suo tipo principale è incluso in questo elenco. È possibile specificare fino a 5 valori. Se non vengono specificati tipi, vengono restituiti tutti i tipi di luoghi.
includedRegionCodes[]

string

Facoltativo. Includi solo i risultati nelle regioni specificate, indicate come massimo 15 codici regionali CLDR di due caratteri. Un insieme vuoto non limiterà i risultati. Se sono impostati sia locationRestriction sia includedRegionCodes, i risultati si troveranno 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 miste se la lingua utilizzata in input è diversa da languageCode o se il luogo restituito non ha una traduzione dalla lingua locale a languageCode.
regionCode

string

Facoltativo. Il codice regione, specificato come codice regione CLDR di due caratteri. Ciò influisce sulla formattazione degli indirizzi, sul ranking dei risultati e può influenzare i risultati restituiti. Ciò non limita i risultati alla regione specificata. Per limitare i risultati a una regione, utilizza region_code_restriction.
origin

object (LatLng)

Facoltativo. Il punto di origine da cui calcolare la distanza geodetica dalla destinazione (restituita 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 è true, la risposta includerà sia le previsioni di luogo che quelle di query. In caso contrario, la risposta restituirà solo le previsioni dei luoghi.
sessionToken

string

Facoltativo. Una stringa che identifica una sessione Autocomplete ai fini della fatturazione. Deve essere una stringa base64 sicura per URL e nomi di 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 di dettagli sul luogo o di convalida dell'indirizzo. Le credenziali utilizzate per ogni richiesta all'interno di una sessione devono appartenere allo stesso progetto Google Cloud Console. Una volta terminata una sessione, il token non è più valido e 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).

Ti consigliamo di seguire le seguenti linee guida:

  • Utilizza i token di sessione per tutte le chiamate di Place Autocomplete.
  • Genera un nuovo token per ogni sessione. Si consiglia l'uso di 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. L'utilizzo dello stesso token per più sessioni comporterà l'addebito individuale di ogni richiesta.
includePureServiceAreaBusinesses

boolean

Facoltativo. Includi le attività al domicilio del cliente se il campo è impostato su true. Un'attività al domicilio del cliente è un'attività che effettua consegne a domicilio o che raggiunge direttamente i clienti, ma che non presta servizio ai clienti presso l'indirizzo dell'attività. Ad esempio, attività come servizi di pulizia o idraulici. Queste attività non hanno un indirizzo fisico o una sede su Google Maps. Places non restituirà campi tra cui location, plusCode e altri campi correlati alla posizione per queste attività.
includeFutureOpeningBusinesses

boolean

Facoltativo. Se è vero, includi le attività che non sono ancora aperte, ma lo saranno in futuro.

Corpo della risposta

Proto di 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, ordinati in ordine decrescente di pertinenza.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

LocationBias

La regione in cui eseguire la ricerca. I risultati potrebbero essere distorti in base 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 tipi:
rectangle

object (Viewport)

Un viewport definito da un angolo nord-est e uno sud-ovest.
circle

object (Circle)

Un cerchio definito da un punto centrale e 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 tipi:
rectangle

object (Viewport)

Un viewport definito da un angolo nord-est e uno sud-ovest.
circle

object (Circle)

Un cerchio definito da un punto centrale e un raggio.

Suggerimento

Un risultato del 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 tipi:
placePrediction

object (PlacePrediction)

Una previsione per un luogo.
queryPrediction

object (QueryPrediction)

Una previsione per una query.

PlacePrediction

Risultati della previsione per una previsione di completamento automatico di Place.

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 nomi di luoghi.
placeId

string

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

object (FormattableText)

Contiene il nome leggibile del risultato restituito. Per i risultati relativi a un'attività, di solito si tratta del nome e dell'indirizzo dell'attività.

text è consigliato per gli sviluppatori che vogliono mostrare un singolo elemento UI. Gli sviluppatori che vogliono mostrare due elementi dell'interfaccia utente separati, ma correlati, potrebbero voler utilizzare structuredFormat. Sono due modi diversi per rappresentare una previsione di luogo. Gli utenti non devono tentare di analizzare structuredFormat in text o viceversa.

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

Potrebbe essere in lingue miste se la richiesta input e languageCode sono in lingue diverse o se il luogo non ha una traduzione dalla lingua locale a languageCode.
structuredFormat

object (StructuredFormat)

Una suddivisione del suggerimento del luogo in testo principale contenente il nome del luogo e testo secondario contenente ulteriori caratteristiche di disambiguazione (ad esempio una città o una regione).

structuredFormat è consigliato per gli sviluppatori che vogliono mostrare due elementi UI separati, ma correlati. Gli sviluppatori che vogliono mostrare un singolo elemento UI potrebbero preferire l'utilizzo di text. Sono due modi diversi per rappresentare una previsione di luogo. Gli utenti non devono tentare di analizzare structuredFormat in text o viceversa.
types[]

string

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

Un tipo è una classificazione 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 i percorsi, potrebbero non compilare questo campo.

FormattableText

Testo che rappresenta un luogo o una previsione di 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 la corrispondenza della richiesta di input in text. Gli intervalli possono essere utilizzati per formattare parti specifiche di text. Le sottostringhe potrebbero non corrispondere esattamente a input se la corrispondenza è stata determinata da criteri diversi dalla corrispondenza di stringhe (ad esempio, correzioni ortografiche o traslitterazioni).

Questi valori sono offset di caratteri Unicode di text. Gli intervalli sono garantiti per essere ordinati in base ai valori di offset crescenti.

StringRange

Identifica una sottostringa all'interno di un determinato testo.

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

integer

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

integer

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

StructuredFormat

Contiene la suddivisione di un luogo o di una previsione di query in testo principale e testo secondario.

Per i suggerimenti di luoghi, il testo principale contiene il nome specifico del luogo. Per i suggerimenti per le query, il testo principale contiene la query.

Il testo secondario contiene ulteriori 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 ulteriori funzionalità di disambiguazione (come una città o una regione) per identificare ulteriormente il luogo o perfezionare la query.

QueryPrediction

Risultati della previsione per una previsione di completamento automatico delle query.

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

object (FormattableText)

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

text è consigliato per gli sviluppatori che vogliono mostrare un singolo elemento UI. Gli sviluppatori che vogliono mostrare due elementi dell'interfaccia utente separati, ma correlati, potrebbero voler utilizzare structuredFormat. Sono due modi diversi per rappresentare una previsione di query. Gli utenti non devono tentare di analizzare structuredFormat in text o viceversa.

Potrebbe essere in lingue miste se la richiesta input e languageCode sono in lingue diverse o se parte della query non ha una traduzione dalla lingua locale a languageCode.
structuredFormat

object (StructuredFormat)

Una suddivisione della previsione della query in testo principale contenente la query e testo secondario contenente funzionalità di disambiguazione aggiuntive (come una città o una regione).

structuredFormat è consigliato per gli sviluppatori che vogliono mostrare due elementi UI separati, ma correlati. Gli sviluppatori che vogliono mostrare un singolo elemento UI potrebbero preferire l'utilizzo di text. Sono due modi diversi per rappresentare una previsione di query. Gli utenti non devono tentare di analizzare structuredFormat in text o viceversa.