Package google.maps.addressvalidation.v1

Indice

Convalida degli indirizzi

Il servizio per la convalida degli indirizzi.

Fornisci un feedback di convalida

rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse)

Feedback sull'esito della sequenza di tentativi di convalida. Dovrebbe essere l'ultima chiamata effettuata dopo una sequenza di chiamate di convalida per lo stesso indirizzo e dovrebbe essere chiamata al termine della transazione. Questo comando deve essere inviato una sola volta per la sequenza di ValidateAddress richieste necessarie per convalidare completamente un indirizzo.

Convalidaindirizzo

rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse)

Convalida un indirizzo.

Indirizzo

Dettagli dell'indirizzo post-elaborazione. La post-elaborazione include la correzione di parti errate dell'indirizzo, la sostituzione di parti errate e l'inferenza di parti mancanti.

Campi
formatted_address

string

L'indirizzo post-elaborato, formattato come indirizzo a riga singola che segue le regole di formattazione degli indirizzi della regione in cui si trova l'indirizzo.

postal_address

PostalAddress

L'indirizzo post-elaborato rappresentato come indirizzo postale.

address_components[]

AddressComponent

Elenco non ordinato. I singoli componenti dell'indirizzo dell'indirizzo formattato e corretto, insieme alle informazioni di convalida. Fornisce informazioni sullo stato di convalida dei singoli componenti.

I componenti dell'indirizzo non vengono ordinati in un determinato modo. Non fare ipotesi sull'ordine dei componenti dell'indirizzo nell'elenco.

missing_component_types[]

string

I tipi di componenti che avrebbero dovuto essere presenti in un indirizzo postale formattato correttamente, ma che non sono stati trovati nell'input E non possono essere dedotti. I componenti di questo tipo non sono presenti in formatted_address, postal_address o address_components. Un esempio potrebbe essere ['street_number', 'route'] per un input come "Boulder, Colorado, 80301, USA". L'elenco dei possibili tipi è disponibile qui.

unconfirmed_component_types[]

string

I tipi di componenti presenti in address_components, ma che non è stato possibile confermare che siano corretti. Questo campo viene fornito per praticità: i suoi contenuti corrispondono a iterazione tramite address_components per trovare i tipi di tutti i componenti in cui confirmation_level non è CONFIRMED o il flag inferred non è impostato su true. L'elenco dei possibili tipi è disponibile qui.

unresolved_tokens[]

string

Eventuali token nell'input che non è stato possibile risolvere. Potrebbe trattarsi di un input non riconosciuto come parte valida di un indirizzo (ad esempio, in un input come "123235253253 Main St, San Francisco, CA, 94105"), i token non risolti potrebbero avere l'aspetto ["123235253253"] perché non sembra un numero di strada valido.

ComponenteIndirizzo

Rappresenta un componente dell'indirizzo, ad esempio una via, una città o una provincia.

Campi
component_name

ComponentName

Il nome di questo componente.

component_type

string

Il tipo di componente dell'indirizzo. Consulta la Tabella 2: tipi aggiuntivi restituiti dal servizio Places per un elenco dei possibili tipi.

confirmation_level

ConfirmationLevel

Indica il grado di certezza che il componente è corretto.

inferred

bool

Indica che il componente non faceva parte dell'input, ma l'abbiamo dedotto per la posizione dell'indirizzo e riteniamo che debba essere fornito per un indirizzo completo.

spell_corrected

bool

Indica che l'ortografia del nome del componente è stata corretta in modo minore, ad esempio cambiando due caratteri visualizzati nell'ordine sbagliato. Questo indica un cambiamento estetico.

replaced

bool

Indica che il nome del componente è stato sostituito con uno completamente diverso, ad esempio un codice postale errato è stato sostituito con uno corretto per l'indirizzo. Non si tratta di una modifica estetica; il componente di input è stato cambiato.

unexpected

bool

Indica un componente dell'indirizzo che non è previsto essere presente in un indirizzo postale per la regione specificata. L'abbiamo conservato solo perché faceva parte dell'input.

Livello di conferma

I diversi valori possibili per i livelli di conferma.

Enum
CONFIRMATION_LEVEL_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
CONFIRMED Siamo riusciti a verificare l'esistenza di questo componente e a dare un senso al contesto del resto dell'indirizzo.
UNCONFIRMED_BUT_PLAUSIBLE Impossibile confermare questo componente, ma è plausibile che esista. Ad esempio, un numero civico all'interno di un intervallo noto di numeri validi per una strada in cui non sono noti numeri di casa specifici.
UNCONFIRMED_AND_SUSPICIOUS Questo componente non è stato confermato e potrebbe essere sbagliato. Ad esempio, un quartiere che non rientra nel resto dell'indirizzo.

MetadatiIndirizzo

I metadati dell'indirizzo. Non è garantita la compilazione completa di metadata per ogni indirizzo inviato all'API Address Validation.

Campi
business

bool

Indica che questo è l'indirizzo di un'attività. Se non impostato, indica che il valore è sconosciuto.

po_box

bool

Indica che l'indirizzo di una casella postale. Se non impostato, indica che il valore è sconosciuto.

residential

bool

Indica che si tratta dell'indirizzo di una residenza. Se non impostato, indica che il valore è sconosciuto.

Nome componente

Un wrapper per il nome del componente.

Campi
text

string

Il testo del nome. Ad esempio, "5th Avenue" per un nome di strada o "1253" per un numero di strada.

language_code

string

Il codice lingua BCP-47. Non sarà presente se il nome del componente non è associato a una lingua, ad esempio una via.

Codice geografico

Contiene informazioni sul luogo in cui è stato geocodificato l'input.

Campi
location

LatLng

La posizione geocodificata dell'input.

È preferibile utilizzare gli ID luogo rispetto agli indirizzi, alle coordinate di latitudine/longitudine o ai plus code. L'utilizzo delle coordinate durante il calcolo del percorso o l'indicazione delle indicazioni stradali comporterà sempre l'allineamento del punto alla strada più vicina a quelle coordinate. Potrebbe non essere una strada che conduce in modo rapido o sicuro alla destinazione e potrebbe non essere vicino a un punto di accesso alla proprietà. Inoltre, se una località è geocodificata in modo inverso, non è garantito che l'indirizzo restituito corrisponda all'originale.

plus_code

PlusCode

Il Plus Code corrispondente a location.

bounds

Viewport

I confini del luogo geocodificato.

feature_size_meters

float

Le dimensioni del luogo geocodificato, in metri. Questa è un'altra misura della grossolana della posizione geocodificata, ma in termini di dimensioni fisiche anziché di significato semantico.

place_id

string

Il PlaceID del luogo in cui viene inserito il codice geografico.

Per ulteriori informazioni sugli ID luogo, fai clic qui.

place_types[]

string

Il tipo o i tipi di luogo in cui è stato geocodificato l'input. Ad esempio, ['locality', 'political']. L'elenco completo dei tipi è disponibile qui.

PlusCode

Il Plus Code (http://plus.codes) è un riferimento di località con due formati: un codice globale che definisce un rettangolo di 14 x 14 m (1/8000 di grado) o più piccolo e un codice composto che sostituisce il prefisso con un percorso di riferimento.

Campi
global_code

string

Il codice globale (completo) del luogo, ad esempio "9FWM33GV+HQ ", che rappresenta un'area di 1/8000 di 1/8000 di grado (~14 di 14 di 14 metri).

compound_code

string

Il codice composto del luogo, ad esempio "33GV+HQ, Ramberg, Norvegia ", contenente il suffisso del codice globale e sostituendo il prefisso con un nome formattato di un'entità di riferimento.

Fornisci convalida convalida richiesta

La richiesta per l'invio di un feedback di convalida.

Campi
conclusion

ValidationConclusion

Obbligatorio. Il risultato della sequenza di tentativi di convalida.

Se questo campo viene impostato su VALIDATION_CONCLUSION_UNSPECIFIED, verrà restituito un errore INVALID_ARGUMENT.

response_id

string

Obbligatorio. L'ID della risposta relativa al feedback. Questo dovrebbe essere [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] della prima risposta in una serie di tentativi di convalida dell'indirizzo.

ConvalidaConclusione

I possibili risultati finali della sequenza di richieste di convalida dell'indirizzo necessarie per convalidare un indirizzo.

Enum
VALIDATION_CONCLUSION_UNSPECIFIED Questo valore non è utilizzato. Se il campo ProvideValidationFeedbackRequest.conclusion è impostato su VALIDATION_CONCLUSION_UNSPECIFIED, verrà restituito un errore INVALID_ARGUMENT.
VALIDATED_VERSION_USED Per la transazione è stata utilizzata la versione dell'indirizzo restituito dall'API Address Validation.
USER_VERSION_USED La versione dell'indirizzo fornito dall'utente è stata utilizzata per la transazione
UNVALIDATED_VERSION_USED Per la transazione è stata utilizzata una versione dell'indirizzo inserita dopo l'ultimo tentativo di convalida, ma che non è stata convalidata di nuovo.
UNUSED La transazione è stata abbandonata e l'indirizzo non è stato utilizzato.

Fornisci convalidaFeedbackResponse

La risposta per il feedback di convalida.

La risposta è vuota se il feedback viene inviato correttamente.

Indirizzo Usps

Rappresentazione USPS di un indirizzo statunitense.

Campi
first_address_line

string

Prima riga indirizzo.

firm

string

Nome azienda.

second_address_line

string

Seconda riga indirizzo.

urbanization

string

Nome dell'urbanizzazione di Portorico.

city_state_zip_address_line

string

Città + stato + codice postale.

city

string

Nome della città.

state

string

Codice di stato a 2 lettere.

zip_code

string

Codice postale (ad es. 10009).

zip_code_extension

string

Estensione del codice postale di 4 cifre, ad esempio 5023.

Dati Usps

I dati USPS per l'indirizzo. Non è garantita la compilazione completa di uspsData per ogni indirizzo statunitense o PR inviato all'API Address Validation. Ti consigliamo di integrare i campi dell'indirizzo di backup nella risposta se utilizzi uspsData come parte principale della risposta.

Campi
standardized_address

UspsAddress

Indirizzo standardizzato USPS.

delivery_point_code

string

Codice del punto di consegna di 2 cifre

delivery_point_check_digit

string

La cifra di controllo del punto di consegna. Questo numero viene aggiunto alla fine del codice a barre_delivery_point per la posta scansionata meccanicamente. Sommando tutte le cifre di delivery_point_bar_code, delivery_point_check_digit, codice postale e ZIP+4, dovrebbe risultare un numero divisibile per 10.

dpv_confirmation

string

I valori possibili per la conferma DPV. Restituisce un singolo carattere.

  • Y: l'indirizzo è stato confermato dal DPV per i numeri principali e per tutti i numeri secondari.
  • N: le informazioni sul numero primario e su qualsiasi numero secondario non sono state confermate da DPV.
  • S: l'indirizzo è stato confermato come DPV solo per il numero principale e le informazioni relative al numero secondario erano presenti non confermate.
  • D: l'indirizzo è stato confermato come DPV solo per il numero principale e mancano le informazioni relative al numero secondario.
dpv_footnote

string

Le note a piè di pagina della convalida del punto di consegna. Più note a piè di pagina potrebbero essere unite nella stessa stringa.

  • AA: indirizzo di input corrispondente al file ZIP+4
  • A1: l'indirizzo di input non è stato trovato nel file ZIP+4
  • BB: corrispondenza con DPV (tutti i componenti)
  • CC: numero secondario senza corrispondenza (presente ma non valido)
  • N1: indirizzo secondario mancante nel numero secondario
  • M1: numero principale mancante
  • M3: numero principale non valido
  • P1: indirizzo della casella di immissione dell'indirizzo RR o HC mancante
  • P3: indirizzo di input valido, numero RR o numero di casella postale non valido
  • F1: indirizzo di input abbinato a un indirizzo militare
  • G1: indirizzo di input corrispondente a un indirizzo di consegna generico
  • U1: indirizzo di input associato a un codice postale univoco
  • PB: indirizzo di input corrispondente al record PBSA
  • RR: indirizzo confermato DPV con informazioni PMB
  • R1: indirizzo DPV confermato senza informazioni sul PMB
  • R7: record R777 o R779 del vettore
dpv_cmra

string

Indica se l'indirizzo è una CMRA (Commercial Mail Ricezione Agency)--un'azienda privata che riceve la posta per i clienti. Restituisce un singolo carattere.

  • Y: l'indirizzo è un CMRA
  • N: l'indirizzo non è un CMRA
dpv_vacant

string

Questo posto è vuoto? Restituisce un singolo carattere.

  • Y: l'indirizzo non è disponibile
  • N: l'indirizzo non è disponibile
dpv_no_stat

string

Non è un indirizzo statistico o è un indirizzo attivo? Nessun indirizzo statistica è un indirizzo che non occupa regolarmente o indirizzi che non sono serviti dall'USPS. Restituisce un singolo carattere.

  • Y: l'indirizzo non è attivo
  • N: l'indirizzo è attivo
carrier_route

string

Il codice di percorso dell'operatore. Un codice di quattro caratteri composto da un prefisso di una lettera e da un indicatore di percorso a tre cifre.

Prefissi:

  • C: percorso dell'operatore (o percorso in città)
  • R: itinerario rurale
  • H: percorso a contratto per autostrade
  • B: sezione "Ufficio postale"
  • G: unità di consegna generale
carrier_route_indicator

string

Indicatore di ordinamento delle tariffe per le route di corriere.

ews_no_match

bool

L'indirizzo di consegna può essere abbinato, ma il file EWS indica che a breve sarà disponibile una corrispondenza esatta.

post_office_city

string

Città dell'ufficio postale principale.

post_office_state

string

Stato dell'ufficio postale principale.

abbreviated_city

string

Città abbreviata.

fips_county_code

string

Codice paese FIPS.

county

string

Nome contea.

elot_number

string

Numero della linea di viaggio avanzata (eLOT).

elot_flag

string

eLOT Bandiera Ascendente o Decrescente (A/D).

po_box_only_postal_code

bool

Codice postale della casella postale:

pmb_designator

string

Indicatore PMB (casella di posta privata).

pmb_number

string

numero PMB (casella di posta privata);

address_record_type

string

Tipo del record dell'indirizzo che corrisponde all'indirizzo di input.

  • F: DURANTE. Si tratta di una corrispondenza con il record di un'azienda, che è il miglior livello di corrispondenza disponibile per un indirizzo.
  • G: CONSEGNA GENERALE. Si tratta di una corrispondenza con un record di consegna generale.
  • H: Edifici / Appartamenti. Si tratta di una corrispondenza con un record di edificio o appartamento.
  • P: POSTA APERTURA. Si abbina a una casella postale.
  • R: RURAL ROUTE o CONTRATTO autostradale: si tratta di una corrispondenza con un percorso rurale o con un record di contratto autostradale, entrambi associati a intervalli di numeri di casella.
  • S: STREET RECORD: corrisponde a un record stradale contenente un intervallo di numeri principali valido.
default_address

bool

Indicatore che indica che è stato trovato un indirizzo predefinito, ma esistono indirizzi più specifici.

error_message

string

Messaggio di errore per il recupero dei dati USPS. Questo campo viene completato quando l'elaborazione USPS viene sospesa a causa del rilevamento di indirizzi creati artificialmente.

I campi di dati USPS potrebbero non essere completati quando è presente questo errore.

cass_processed

bool

Indicatore che la richiesta è stata elaborata in modalità CASS.

ConvalidaIndirizzoRichiesta

La richiesta di convalida di un indirizzo.

Campi
address

PostalAddress

Obbligatorio. L'indirizzo in fase di convalida. Gli indirizzi non formattati devono essere inviati tramite address_lines.

La lunghezza totale dei campi in questo input non deve superare 280 caratteri.

Le aree geografiche supportate sono disponibili qui.

Il valore language_code nell'indirizzo di input è riservato per scopi futuri e viene ignorato oggi. Il risultato dell'indirizzo convalidato verrà compilato in base alla lingua preferita per l'indirizzo specificato, come identificato dal sistema.

L'API Address Validation ignora i valori in recipients e organization. I valori in questi campi verranno eliminati e non verranno restituiti. Non impostarli.

previous_response_id

string

Questo campo deve essere vuoto per la prima richiesta di convalida dell'indirizzo. Se sono necessarie più richieste per convalidare completamente un singolo indirizzo (ad esempio, se le modifiche apportate dall'utente dopo la convalida iniziale devono essere riconvalidate), ogni richiesta di follow-up deve completare questo campo con response_id a partire dalla prima risposta nella sequenza di convalida.

enable_usps_cass

bool

Abilita la modalità compatibile con USPS CASS. Questo riguarda solo il campo google.maps.addressvalidation.v1.ValidationResult.usps_data di google.maps.addressvalidation.v1.ValidationResult. Nota: per le richieste abilitate per USPS CASS per gli indirizzi a Portorico, devi fornire google.type.PostalAddress.region_code di address come "PR" oppure google.type.PostalAddress.administrative_area di address come "Portorico" (senza distinzione tra maiuscole e minuscole) o "PR".

Consigliamo di utilizzare una proprietà address componente oppure, in alternativa, specifica almeno google.type.PostalAddress.address_lines dove la prima riga contiene il numero civico e il nome, mentre la seconda contiene la città, la provincia e il codice postale.

ValidateAddressResponse

La risposta a una richiesta di convalida dell'indirizzo.

Campi
result

ValidationResult

Il risultato della convalida dell'indirizzo.

response_id

string

L'UUID che identifica questa risposta. Se l'indirizzo deve essere riconvalidato, questo UUID deve accompagnare la nuova richiesta.

ValidationResult

Il risultato della convalida di un indirizzo.

Campi
verdict

Verdict

Contrassegni degli esiti complessivi

address

Address

Informazioni sull'indirizzo stesso anziché sul codice geografico.

geocode

Geocode

Informazioni sulla località e sul luogo in cui è stato geocodificato l'indirizzo.

metadata

AddressMetadata

Altre informazioni pertinenti per la consegna. Non è garantita la compilazione completa di metadata per ogni indirizzo inviato all'API Address Validation.

usps_data

UspsData

Flag di consegna extra forniti da USPS. Disponibile solo nelle regioni US e PR.

Esito

Panoramica di alto livello del risultato della convalida dell'indirizzo e della geocodifica.

Campi
input_granularity

Granularity

La granularità dell'indirizzo di input. Questo è il risultato dell'analisi dell'indirizzo di input e non fornisce indicatori di convalida. Per gli indicatori di convalida, consulta la sezione validation_granularity di seguito.

Ad esempio, se l'indirizzo di input include un numero di appartamento specifico, input_granularity sarà SUB_PREMISE. Se non è possibile trovare la corrispondenza con il numero di appartamento presente nei database o se il numero di appartamento non è valido, è probabile che il valore di validation_granularity sia PREMISE o inferiore.

validation_granularity

Granularity

Il livello di granularità in cui l'API può convalidare completamente l'indirizzo. Ad esempio, un validation_granularity di PREMISE indica che è possibile convalidare tutti i componenti dell'indirizzo a livello di PREMISE o più grossolani.

Il risultato della convalida del componente per indirizzo è disponibile in google.maps.addressvalidation.v1.Address.address_components.

geocode_granularity

Granularity

Informazioni sulla granularità dell'elemento geocode. Questo può essere inteso come il significato semantico di quanto sia grossolana o fine la posizione geocodificata.

Occasionalmente potrebbe essere diverso dalla validation_granularity riportata sopra. Ad esempio, il nostro database potrebbe registrare l'esistenza di un numero di appartamento ma non indicare esattamente la posizione dell'appartamento all'interno di un grande complesso. In questo caso, validation_granularity sarà SUB_PREMISE, mentre geocode_granularity sarà PREMISE.

address_complete

bool

L'indirizzo è considerato completo se non sono presenti token irrisolti, componenti di indirizzi imprevisti o mancanti. Per ulteriori dettagli, consulta i campi missing_component_types, unresolved_tokens o unexpected.

has_unconfirmed_components

bool

Almeno un componente dell'indirizzo non può essere classificato o convalidato; consulta google.maps.addressvalidation.v1.Address.address_components per i dettagli.

has_inferred_components

bool

Almeno un componente dell'indirizzo è stato dedotto (aggiunto) ma non era nell'input. Per i dettagli, consulta google.maps.addressvalidation.v1.Address.address_components.

has_replaced_components

bool

Almeno un componente dell'indirizzo è stato sostituito. Per i dettagli, consulta la pagina google.maps.addressvalidation.v1.Address.address_components.

Granularità

I vari livelli di granularità che possono avere un indirizzo o un codice geografico. Se utilizzati per indicare la granularità di un indirizzo, questi valori indicano la granularità con cui l'indirizzo identifica una destinazione postale. Ad esempio, un indirizzo come "Via Roma 22, 90165" identifica un PREMISE, mentre qualcosa come "Roma, 04044" identifica un LOCALITY. Tuttavia, se non riusciamo a trovare un codice geografico per "Via Garibaldi 123" a Redwood City, il codice geografico restituito potrebbe avere una granularità pari a LOCALITY anche se l'indirizzo è più granulare.

Enum
GRANULARITY_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
SUB_PREMISE Risultato di un livello inferiore a un edificio, ad esempio un appartamento.
PREMISE Risultato a livello di edificio.
PREMISE_PROXIMITY Un codice geografico che approssima la posizione dell'indirizzo a livello di edificio.
BLOCK L'indirizzo o la geocodifica indica un blocco. Utilizzato solo nelle regioni con indirizzi a livello di blocco, come il Giappone.
ROUTE Il codice geografico o l'indirizzo sono granulari per includere il percorso, ad esempio una strada, una strada o un'autostrada.
OTHER Tutte le altre granularità, suddivise in bucket in quanto non disponibili per la pubblicazione.