Method: validateAddress

Convalida un indirizzo.

Richiesta HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Campi
address

object (PostalAddress)

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

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

Le regioni supportate sono disponibili qui.

Il valore languageCode nell'indirizzo di input è riservato per utilizzi 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. Tutti i valori in questi campi verranno ignorati e non verranno restituiti. Non impostarli.

previousResponseId

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 il responseId dalla prima risposta nella sequenza di convalida.

enableUspsCass

boolean

Attiva la modalità compatibile con CASS di USPS. Questo influisce solo sul campo google.maps.addressvalidation.v1.ValidationResult.usps_data di google.maps.addressvalidation.v1.ValidationResult. Nota: per le richieste USPS CASS abilitate per gli indirizzi a Portorico, è necessario fornire un google.type.PostalAddress.region_code del address come "PR" oppure un google.type.PostalAddress.administrative_area del address deve essere fornito come "Portorico" (senza distinzione tra maiuscole e minuscole) o "PR".

Ti consigliamo di utilizzare un valore compositi del address o, in alternativa, di specificare almeno due google.type.PostalAddress.address_lines dove la prima riga contiene il numero civico e il nome e la seconda la città, lo stato e il codice postale.

languageOptions

object (LanguageOptions)

(Facoltativo) Anteprima: questa funzionalità è in anteprima (pre-GA). I prodotti e le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche ai prodotti e alle funzionalità pre-GA potrebbero non essere compatibili con altre versioni pre-GA. Le offerte pre-GA sono coperte dai Termini di servizio specifici di Google Maps Platform. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

Consente all'API Address Validation di includere informazioni aggiuntive nella risposta.

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 esegue una query di completamento automatico e termina quando seleziona un luogo e viene effettuata una chiamata a Place Details o Address Validation. Ogni sessione può avere più query di completamento automatico, 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).

Nota: Address Validation può essere utilizzato solo nelle sessioni con l'API Autocomplete (nuova) , non con l'API Autocomplete. Per maggiori dettagli, visita la pagina https://developers.google.com/maps/documentation/places/web-service/session-pricing.

Corpo della risposta

La risposta a una richiesta di convalida degli indirizzi.

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

Rappresentazione JSON
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Campi
result

object (ValidationResult)

Il risultato della convalida dell'indirizzo.

responseId

string

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

PostalAddress

Rappresenta un indirizzo postale, ad esempio per gli indirizzi di consegna postale o di pagamento. Dato un indirizzo postale, un servizio postale può consegnare gli articoli a una sede, una P.O. Box o simile. Non è progettato per creare modelli di località geografiche (strade, città, montagne).

Nell'utilizzo tipico, un indirizzo verrebbe creato tramite l'input dell'utente o importando dati esistenti, a seconda del tipo di processo.

Consigli sull'inserimento / modifica di indirizzi: - Usa un widget degli indirizzi pronto per l'internazionalizzazione, come https://github.com/google/libaddressinput. - Agli utenti non dovrebbero essere mostrati elementi di interfaccia utente per l'inserimento o la modifica di campi al di fuori dei paesi in cui viene utilizzato quel campo.

Per ulteriori indicazioni su come utilizzare questo schema, consulta la pagina: https://support.google.com/business/answer/6397478

Rappresentazione JSON
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Campi
revision

integer

La revisione dello schema di PostalAddress. Qualsiasi valore diverso da 0 farà sì che l'API restituisca un errore INVALID_ARGUMENT.

regionCode

string

(Facoltativo) Codice regione CLDR del paese o della regione dell'indirizzo. Per informazioni dettagliate, visita le pagine https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Esempio: "CH" per la Svizzera. Se il codice regione non viene fornito, verrà dedotto dall'indirizzo. Per prestazioni ottimali, ti consigliamo di includere il codice regione, se lo conosci. La presenza di regioni incoerenti o ripetute può portare a un rendimento scarso. Ad esempio, se addressLines include già la regione, non fornire di nuovo il codice regione in questo campo. Le regioni supportate sono disponibili nelle Domande frequenti.

languageCode

string

Il codice della lingua nell'indirizzo inserito è riservato per utilizzi futuri e oggi viene ignorato. L'API restituisce l'indirizzo nella lingua appropriata in cui si trova l'indirizzo.

postalCode

string

(Facoltativo) Codice postale dell'indirizzo. Non tutti i paesi utilizzano o richiedono la presenza di codici postali, ma se vengono utilizzati, possono attivare un'ulteriore convalida con altre parti dell'indirizzo (ad es. convalida stato/codice postale negli Stati Uniti).

sortingCode

string

(Facoltativo) Codice di ordinamento aggiuntivo specifico per il paese. Questa opzione non è utilizzata nella maggior parte delle regioni. Dove viene utilizzato, il valore è una stringa come "CEDEX", facoltativamente seguita da un numero (ad es. "CEDEX 7") o solo un numero, che rappresenta il "codice di settore" (Giamaica), "indicatore zona di consegna" (Malawi) o "indicatore dell'ufficio postale" (ad es. Costa d'Avorio).

administrativeArea

string

(Facoltativo) Suddivisione amministrativa di livello più elevato utilizzata per gli indirizzi postali di un paese o di una regione. Ad esempio, può essere uno stato, una provincia, un oblast o una prefettura. In particolare, per la Spagna si tratta della provincia e non della comunità autonoma (ad es. "Barcellona" e non "Catalogna"). Molti paesi non utilizzano un'area amministrativa negli indirizzi postali. Ad es. in Svizzera, deve essere lasciato vuoto.

locality

string

(Facoltativo) In genere si riferisce alla porzione di città dell'indirizzo. Esempi: città USA, comune in Italia, città postale nel Regno Unito. Nelle regioni del mondo in cui le località non sono ben definite o non si adattano bene a questa struttura, lascia il campo della località vuoto e utilizza addressLines.

sublocality

string

(Facoltativo) Quartiere dell'indirizzo. Ad esempio, possono essere quartieri, quartieri e distretti.

addressLines[]

string

Obbligatorio. Righe di indirizzo non strutturate che descrivono i livelli inferiori di un indirizzo.

Poiché i valori in addressLines non hanno informazioni sul tipo e a volte possono contenere più valori in un singolo campo (ad es. "Austin, TX"), è importante che l'ordine delle linee sia chiaro. L'ordine delle righe dell'indirizzo deve essere "ordine busta" per il paese o la regione dell'indirizzo.

La rappresentazione strutturale minima consentita di un indirizzo è composta da tutte le informazioni inserite nel addressLines. Se non viene fornito un valore regionCode, la regione viene ricavata dalle righe dell'indirizzo.

Creare un indirizzo contenente solo addressLines e poi la geocodifica è il modo consigliato per gestire indirizzi completamente non strutturati (anziché indovinare quali parti dell'indirizzo devono essere località o aree amministrative).

recipients[]

string

Evita di impostare questo campo. Al momento l'API Address Validation non la utilizza. Anche se in questo momento l'API non rifiuterà le richieste per cui è stato impostato questo campo, le informazioni verranno ignorate e non verranno restituite nella risposta.

organization

string

Evita di impostare questo campo. Al momento l'API Address Validation non la utilizza. Anche se in questo momento l'API non rifiuterà le richieste per cui è stato impostato questo campo, le informazioni verranno ignorate e non verranno restituite nella risposta.

LanguageOptions

Anteprima: questa funzionalità è in anteprima (pre-GA). I prodotti e le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche ai prodotti e alle funzionalità pre-GA potrebbero non essere compatibili con altre versioni pre-GA. Le offerte pre-GA sono coperte dai Termini di servizio specifici di Google Maps Platform. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

Consente all'API Address Validation di includere informazioni aggiuntive nella risposta.

Rappresentazione JSON
{
  "returnEnglishLatinAddress": boolean
}
Campi
returnEnglishLatinAddress

boolean

Anteprima: restituisci google.maps.addressvalidation.v1.Address in inglese. Per informazioni dettagliate, visita la pagina google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

ValidationResult

Il risultato della convalida di un indirizzo.

Rappresentazione JSON
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Campi
verdict

object (Verdict)

Segnalazioni dell'esito complessivo

address

object (Address)

Informazioni sull'indirizzo stesso anziché sul geocodice.

geocode

object (Geocode)

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

metadata

object (AddressMetadata)

Altre informazioni pertinenti ai fini della consegna. Non è garantito che il campo metadata sia completamente compilato per ogni indirizzo inviato all'API Address Validation.

uspsData

object (UspsData)

Flag di consegnabilità extra forniti da USPS. Fornito solo nelle regioni US e PR.

englishLatinAddress

object (Address)

Anteprima: questa funzionalità è in anteprima (pre-GA). I prodotti e le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche ai prodotti e alle funzionalità pre-GA potrebbero non essere compatibili con altre versioni pre-GA. Le offerte pre-GA sono coperte dai Termini di servizio specifici di Google Maps Platform. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

L'indirizzo tradotto in inglese.

Gli indirizzi tradotti non sono riutilizzabili come input API. Il servizio le fornisce in modo che l'utente possa usare la propria lingua madre per confermare o negare la convalida dell'indirizzo fornito in origine.

Se parte dell'indirizzo non ha una traduzione in inglese, il servizio restituisce quella parte in una lingua alternativa che utilizza un alfabeto latino. Leggi qui per una spiegazione di come viene selezionata la lingua alternativa. Se una parte dell'indirizzo non ha traduzioni o traslitterazioni in una lingua che utilizza un alfabeto latino, il servizio restituisce quella parte nella lingua locale associata all'indirizzo.

Abilita questo output utilizzando il flag google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Nota: i campi google.maps.addressvalidation.v1.Address.unconfirmed_component_types in englishLatinAddress e google.maps.addressvalidation.v1.AddressComponent.confirmation_level in englishLatinAddress.address_components non sono compilati.

Verdetto

Panoramica generale del risultato della convalida dell'indirizzo e del geocodice.

Rappresentazione JSON
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Campi
inputGranularity

enum (Granularity)

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

Ad esempio, se l'indirizzo inserito include un numero di appartamento specifico, il valore inputGranularity qui sarà SUB_PREMISE. Se non riusciamo a trovare il numero dell'appartamento nei database o se il numero non è valido, il valore validationGranularity probabilmente sarà PREMISE o inferiore.

validationGranularity

enum (Granularity)

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

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

geocodeGranularity

enum (Granularity)

Informazioni sulla granularità del geocode. Può essere inteso come il significato semantico di quanto è approssimativa o precisa la posizione geocodificata.

Questo può occasionalmente differire dalla validationGranularity indicata sopra. Ad esempio, il nostro database potrebbe registrare l'esistenza di un numero di appartamento, ma non indicare una posizione precisa dell'appartamento all'interno di un grande complesso residenziale. In questo caso, il valore di validationGranularity sarà SUB_PREMISE, mentre il valore di geocodeGranularity sarà di PREMISE.

addressComplete

boolean

L'indirizzo è considerato completo se non ci sono token non risolti o componenti dell'indirizzo inaspettati o mancanti. Se non viene configurato, indica che il valore è false. Vedi i campi missingComponentTypes, unresolvedTokens o unexpected per ulteriori dettagli.

hasUnconfirmedComponents

boolean

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

hasInferredComponents

boolean

È stato dedotto (aggiunto) almeno un componente dell'indirizzo che non era nell'input. Vedi google.maps.addressvalidation.v1.Address.address_components per i dettagli.

hasReplacedComponents

boolean

Almeno un componente dell'indirizzo è stato sostituito. Consulta google.maps.addressvalidation.v1.Address.address_components per i dettagli.

Granularità

Le diverse granularità di un indirizzo o di un geocodice. Se utilizzati per indicare il livello di granularità di un indirizzo, questi valori indicano il livello di granularità di un indirizzo che identifica una destinazione postale. Ad esempio, un indirizzo simile a "Via Roma 120, Roma, RM" identifica un PREMISE, mentre ad esempio "Redwood City, CA, 94061" identifica un LOCALITY. Se invece non riusciamo a trovare un geocodice per "Via Roma 123" a Redwood City, il codice geografico restituito potrebbe essere di una granularità pari a LOCALITY, anche se l'indirizzo è più granulare.

Enum
GRANULARITY_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
SUB_PREMISE Risultato al di sotto di un edificio, ad esempio un appartamento.
PREMISE Risultato a livello di edificio.
PREMISE_PROXIMITY Un codice geografico che si avvicina alla posizione dell'indirizzo a livello di edificio.
BLOCK L'indirizzo o il geocodice indica un blocco. Utilizzato solo nelle regioni con indirizzi a livello di blocco, come il Giappone.
ROUTE Il geocodice o indirizzo è granulare per il percorso, ad esempio una strada, una strada o un'autostrada.
OTHER Tutte le altre granularità, che sono raggruppate insieme poiché non sono raggiungibili.

Indirizzo

Dettagli dell'indirizzo post-elaborato. La post-elaborazione include la correzione delle parti dell'indirizzo con errori ortografici, la sostituzione di parti errate e la deduzione delle parti mancanti.

Rappresentazione JSON
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Campi
formattedAddress

string

L'indirizzo post-elaborato, formattato come indirizzo di una sola riga che segue le regole di formattazione dell'indirizzo della regione in cui si trova l'indirizzo.

postalAddress

object (PostalAddress)

L'indirizzo post-elaborato rappresentato come indirizzo postale.

addressComponents[]

object (AddressComponent)

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

I componenti degli indirizzi non sono ordinati in un modo particolare. Non fare ipotesi sull'ordine dei componenti degli indirizzi nell'elenco.

missingComponentTypes[]

string

I tipi di componenti che si prevedeva fossero presenti in un indirizzo di posta formattato correttamente, ma che non sono stati trovati nell'input E non sono stati dedotti. I componenti di questo tipo non sono presenti in formattedAddress, postalAddress o addressComponents. Un esempio potrebbe essere ['street_number', 'route'] per un input come "Boulder, Colorado, 80301, USA". L'elenco dei tipi possibili è disponibile qui.

unconfirmedComponentTypes[]

string

I tipi di componenti che sono presenti in addressComponents, ma non è stato possibile confermarne l'esattezza. Questo campo viene fornito per praticità: i suoi contenuti corrispondono all'iterazione tramite addressComponents per trovare i tipi di tutti i componenti in cui confirmationLevel non è CONFIRMED o il flag inferred non è impostato su true. L'elenco dei tipi possibili è disponibile qui.

unresolvedTokens[]

string

Eventuali token nell'input che non è stato possibile risolvere. Potrebbe essere un input che non è stato 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 il seguente aspetto ["123235253253"] perché non ha un numero civico valido.

AddressComponent

Rappresenta un componente dell'indirizzo, come una via, una città o uno stato.

Rappresentazione JSON
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Campi
componentName

object (ComponentName)

Il nome di questo componente.

componentType

string

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

confirmationLevel

enum (ConfirmationLevel)

Indica il livello di certezza che il componente è corretto.

inferred

boolean

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

spellCorrected

boolean

Indica una correzione di un errore di ortografia nel nome del componente. L'API non sempre contrassegna le modifiche da una variante ortografica a un'altra, ad esempio quando si cambia la posizione "centrale" al centro. Inoltre, non sempre segnala gli errori ortografici più comuni, come quando cambi "Anfiteatro Pkwy" in "Amphitheatre Pkwy".

replaced

boolean

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

unexpected

boolean

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

ComponentName

Un wrapper per il nome del componente.

Rappresentazione JSON
{
  "text": string,
  "languageCode": string
}
Campi
text

string

Il testo del nome. Ad esempio, "5th Avenue" il nome di una via o "1253" per il numero civico.

languageCode

string

Il codice lingua BCP-47. Non è presente se il nome del componente non è associato a una lingua, come un numero civico.

ConfirmationLevel

I diversi valori possibili per i livelli di conferma.

Enum
CONFIRMATION_LEVEL_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
CONFIRMED Siamo riusciti a verificare che questo componente esista e abbia senso nel contesto del resto dell'indirizzo.
UNCONFIRMED_BUT_PLAUSIBLE Non è stato possibile confermare questo componente, ma è plausibile che esista. Ad esempio, un numero civico all'interno di un intervallo noto e valido di una via in cui non sono noti numeri civici specifici.
UNCONFIRMED_AND_SUSPICIOUS Questo componente non è stato confermato ed è probabile che si tratti di un errore. ad esempio un quartiere che non corrisponde al resto dell'indirizzo.

Geocodifica

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

Rappresentazione JSON
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Campi
location

object (LatLng)

La posizione geocodificata dell'input.

È preferibile utilizzare gli ID luogo rispetto all'utilizzo di indirizzi, coordinate di latitudine/longitudine o plus code. Se utilizzi le coordinate durante i percorsi o il calcolo delle indicazioni stradali, il punto viene sempre agganciato alla strada più vicina a tali coordinate. Potrebbe non essere una strada che porterà alla destinazione in modo rapido o sicuro e potrebbe non essere vicina a un punto di accesso alla proprietà. Inoltre, quando una località è geocodificata invertita, non vi è alcuna garanzia che l'indirizzo restituito corrisponda all'indirizzo originale.

plusCode

object (PlusCode)

Il Plus Code corrispondente a location.

bounds

object (Viewport)

I limiti del luogo geocodificato.

featureSizeMeters

number

Le dimensioni del luogo geocodificato, in metri. Questa è un'altra misura della grossa percentuale della posizione geocodificata, ma nelle dimensioni fisiche piuttosto che nel significato semantico.

placeId

string

Il PlaceID del luogo in cui viene geocodificato questo input.

Per ulteriori informazioni sugli ID luogo, visita questa pagina.

placeTypes[]

string

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

LatLng

Un oggetto che rappresenta una coppia latitudine/longitudine. Questo valore è espresso come coppia di doppi per rappresentare i gradi di latitudine e i gradi di longitudine. Se non diversamente specificato, questo oggetto deve essere conforme allo standard WGS84. I valori devono essere compresi negli intervalli normalizzati.

Rappresentazione JSON
{
  "latitude": number,
  "longitude": number
}
Campi
latitude

number

La latitudine in gradi. Deve essere compreso nell'intervallo [-90,0, +90,0].

longitude

number

Longitudine in gradi. Deve essere compreso nell'intervallo [-180,0, +180,0].

PlusCode

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

Rappresentazione JSON
{
  "globalCode": string,
  "compoundCode": string
}
Campi
globalCode

string

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

compoundCode

string

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

Area visibile

Un'area visibile di latitudine e longitudine, rappresentata da due punti diagonalmente opposti a low e high. Un'area visibile è considerata un'area chiusa, ovvero include il proprio confine. I limiti di latitudine devono essere compresi tra -90 e 90 gradi inclusi, mentre quelli di longitudine devono essere compresi tra -180 e 180 gradi inclusi. I vari casi includono:

  • Se low = high, l'area visibile è composta da quel singolo punto.

  • Se low.longitude > high.longitude, l'intervallo di longitudine è invertito (l'area visibile supera la linea di longitudine di 180 gradi).

  • Se low.longitude = -180 gradi e high.longitude = 180 gradi, l'area visibile include tutte le longitudini.

  • Se low.longitude = 180 gradi e high.longitude = -180 gradi, l'intervallo di longitudine è vuoto.

  • Se low.latitude > high.latitude, l'intervallo di latitudine è vuoto.

È necessario compilare entrambi i campi low e high e la casella rappresentata non può essere vuota (come specificato dalle definizioni precedenti). Un'area visibile vuota genererà un errore.

Ad esempio, questa area visibile racchiude completamente New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Rappresentazione JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campi
low

object (LatLng)

Obbligatorio. Il punto inferiore dell'area visibile.

high

object (LatLng)

Obbligatorio. Il punto più alto dell'area visibile.

AddressMetadata

I metadati per l'indirizzo. Non è garantito che il campo metadata sia completamente compilato per ogni indirizzo inviato all'API Address Validation.

Rappresentazione JSON
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Campi
business

boolean

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

poBox

boolean

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

residential

boolean

Indica che questo è l'indirizzo di una residenza. Se non viene configurato, indica che il valore è sconosciuto.

UspsData

I dati USPS per l'indirizzo. Non è garantito che il campo uspsData sia completamente compilato per ogni indirizzo USA 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.

Rappresentazione JSON
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
Campi
standardizedAddress

object (UspsAddress)

Indirizzo standardizzato USPS.

deliveryPointCode

string

Codice punto di consegna a 2 cifre

deliveryPointCheckDigit

string

La cifra di controllo del punto di consegna. Questo numero viene aggiunto alla fine del codice a barre delivery_point_barcode per la posta sottoposta a scansione meccanica. Sommando tutte le cifre di delivery_point_barcode, deliveryPointCheckDigit, codice postale e ZIP+4 dovresti ottenere un numero divisibile per 10.

dpvConfirmation

string

I valori possibili per la conferma della data di destinazione. Restituisce un singolo carattere o nessun valore.

  • N: impossibile confermare le informazioni sul numero principale e su eventuali numeri secondari.
  • D: l'indirizzo è stato confermato solo per il numero principale e le informazioni sul numero secondario erano mancanti.
  • S: l'indirizzo è stato confermato solo per il numero principale e le informazioni sul numero secondario erano presenti, ma non confermate.
  • Y: l'indirizzo è stato confermato dalla data di destinazione per il numero principale e per eventuali numeri secondari.
  • Vuoto: se la risposta non contiene un valore dpvConfirmation, l'indirizzo non è stato inviato per la conferma DPV.
dpvFootnote

string

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

  • AA: indirizzo di input corrispondente al file ZIP+4
  • A1: l'indirizzo di input non corrisponde al file ZIP+4
  • BB: abbinato alla data center di servizio (tutti i componenti)
  • CC: numero secondario non corrispondente e non obbligatorio
  • C1: numero secondario non corrispondente, ma obbligatorio
  • N1: indirizzo di un grattacielo senza numero secondario
  • M1: numero principale mancante
  • M3: numero principale non valido
  • P1: numero di casella PO, RR o HC indirizzo di input mancante
  • P3: indirizzo inserito PO, RR o numero casella HC non valido
  • F1: indirizzo di input corrispondente a un indirizzo militare
  • G1: inserisci l'indirizzo corrispondente a un indirizzo di consegna generico
  • U1: indirizzo di input corrispondente a un codice postale univoco
  • PB: indirizzo di input corrispondente al record PBSA
  • RR: indirizzo confermato dal responsabile della protezione dei dati con informazioni sul PMB
  • R1: indirizzo confermato dal responsabile della protezione dei dati senza informazioni sul PMB
  • R7: record R777 o R779 del vettore
  • IA: indirizzo informato identificato
  • TA: numero principale trovato dopo aver eliminato un alpha finale
dpvCmra

string

Indica se l'indirizzo è un'agenzia per la ricezione di posta commerciale (CMRA), un'azienda privata che riceve posta per i clienti. Restituisce un singolo carattere.

  • Y: l'indirizzo è una CMRA
  • N: l'indirizzo non è una CMRA
dpvVacant

string

Questo luogo è libero? Restituisce un singolo carattere.

  • Y: l'indirizzo è vuoto
  • N: l'indirizzo non è vuoto
dpvNoStat

string

È un indirizzo senza statistiche o un indirizzo attivo? Nessun indirizzo delle statistiche è costituito da indirizzi non occupati in modo continuo o da indirizzi non serviti dall'USPS. Restituisce un singolo carattere.

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

integer

Indica il tipo di NoStat. Restituisce un codice motivo come int.

  • 1: IDA (Internal Drop Address) – Indirizzi che non ricevono posta direttamente dall'USPS, ma sono consegnati a un indirizzo di destinazione che li fornisce.
  • 2: CDS: indirizzi non ancora idonei alla pubblicazione. Ad esempio, una nuova suddivisione in cui sono stati determinati lotti e i numeri principali, ma non esiste ancora una struttura per il numero di persone.
  • 3: collisione - indirizzi che non vengono effettivamente confermati dal data center di destinazione.
  • 4: CMZ (College, Military e altri tipi). Il codice ZIP + 4 registra che USPS ha incorporato nei dati.
  • 5: Normale: indica gli indirizzi che non ricevono la consegna e che non vengono conteggiati come possibili consegne.
  • 6: secondario obbligatorio. L'indirizzo richiede informazioni secondarie.
dpvDrop

string

Il flag indica che la posta viene recapitata a un singolo destinatario in un sito. Restituisce un singolo carattere.

  • Y: la posta viene recapitata a un unico destinatario in un sito.
  • N: la posta non viene recapitata a un singolo destinatario in un sito.
dpvThrowback

string

Indica che la posta non è stata recapitata all'indirizzo stradale. Restituisce un singolo carattere.

  • Y: la posta non viene recapitata all'indirizzo.
  • N: la posta viene recapitata all'indirizzo.
dpvNonDeliveryDays

string

Il flag indica che la consegna della posta non viene eseguita tutti i giorni della settimana. Restituisce un singolo carattere.

  • Y: la consegna per posta non viene eseguita ogni giorno della settimana.
  • N: nessuna indicazione che la consegna della posta non viene eseguita ogni giorno della settimana.
dpvNonDeliveryDaysValues

integer

Numero intero che identifica i giorni di mancata consegna. Può essere interrogato utilizzando flag di bit: 0x40 – Domenica è un giorno di mancato recapito 0x20 – Lunedì è un giorno di mancato recapito 0x10 – Martedì è un giorno di mancato recapito 0x08 – Mercoledì è un giorno di mancato recapito 0x04 – Giovedì è un giorno di mancato recapito 0x02 – Venerdì è un giorno di mancato recapito 0x01

dpvNoSecureLocation

string

Il flag indica che la porta è accessibile, ma il pacco non verrà lasciato a causa di problemi di sicurezza. Restituisce un singolo carattere.

  • Y: il pacco non verrà lasciato a causa di problemi di sicurezza.
  • N: nessuna indicazione che il pacco non verrà lasciato a causa di problemi di sicurezza.
dpvPbsa

string

Indica che l'indirizzo è associato al record PBSA. Restituisce un singolo carattere.

  • Y: l'indirizzo è stato abbinato al record PBSA.
  • N: l'indirizzo non è stato abbinato al record PBSA.
dpvDoorNotAccessible

string

Il flag indica gli indirizzi in cui USPS non può bussare a una porta per consegnare la posta. Restituisce un singolo carattere.

  • Y: la porta non è accessibile.
  • N: nessuna indicazione che la porta non è accessibile.
dpvEnhancedDeliveryCode

string

Indica che più di un codice restituito DPV è valido per l'indirizzo. Restituisce un singolo carattere.

  • Y: l'indirizzo è stato confermato dalla data di destinazione per il numero principale e per eventuali numeri secondari.
  • N: impossibile confermare le informazioni sul numero principale e su eventuali numeri secondari.
  • S: l'indirizzo è stato confermato solo per il numero principale e le informazioni sul numero secondario erano presenti, ma non confermate oppure è stato eliminato un singolo alpha finale su un numero principale per creare una corrispondenza con il data warehouse secondario e sono state richieste informazioni secondarie.
  • D: l'indirizzo è stato confermato solo per il numero principale e le informazioni sul numero secondario erano mancanti.
  • R: l'indirizzo è stato confermato, ma assegnato ai percorsi fantasma R777 e R779 e la consegna con USPS non è stata fornita.
carrierRoute

string

Il codice di percorso del corriere. Un codice di quattro caratteri composto da un prefisso di una lettera e un indicatore di percorso a tre cifre.

Prefissi:

  • C: percorso dell'operatore (o rotta urbana)
  • R: strada rurale
  • H: percorso contrattuale autostradale
  • B: sezione casella postale
  • G: unità di consegna generale
carrierRouteIndicator

string

Indicatore di ordinamento tariffa itinerario operatore.

ewsNoMatch

boolean

È possibile trovare una corrispondenza con l'indirizzo di consegna, ma il file EWS indica che a breve sarà disponibile una corrispondenza esatta.

postOfficeCity

string

Città dell'ufficio postale principale.

postOfficeState

string

Stato dell'ufficio postale principale.

abbreviatedCity

string

Città abbreviata.

fipsCountyCode

string

Codice contea FIPS.

county

string

Nome della contea.

elotNumber

string

Numero eLOT (Advanced Line of Travel).

elotFlag

string

Flag crescente/decrescente di eLOT (A/D).

poBoxOnlyPostalCode

boolean

Solo casella postale.

pmbDesignator

string

indicatore di unità PMB (Private Mail Box).

pmbNumber

string

numero PMB (Private Mail Box);

addressRecordType

string

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

  • F: FIRM. Si tratta di una corrispondenza con un record dell'azienda, ovvero il miglior livello di corrispondenza disponibile per un indirizzo.
  • G: CONSEGNA GENERALE. Si tratta di una corrispondenza con un record di consegna generale.
  • H: COSTRUIRE / APPARTAMENTO. Corrisponde a un record di edificio o appartamento.
  • P: Casella postale. Questa è una corrispondenza con una casella postale.
  • R: PERCORSO RURALE o CONTRATTO AUTOMATICO: si tratta di una corrispondenza con il record di una strada rurale o di un contratto autostradale, entrambi i quali possono avere intervalli di numeri di riquadri associati.
  • S: STREET RECORD: corrisponde a un record di una strada contenente un intervallo di numeri principali valido.
defaultAddress

boolean

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

errorMessage

string

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

I campi dei dati USPS potrebbero non essere compilati se si verifica questo errore.

cassProcessed

boolean

Indicatore che la richiesta è stata elaborata dal CASS.

UspsAddress

Rappresentazione USPS di un indirizzo statunitense.

Rappresentazione JSON
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Campi
firstAddressLine

string

Prima riga indirizzo.

firm

string

Nome dell'azienda.

secondAddressLine

string

Seconda riga indirizzo.

urbanization

string

Nome dell'urbanizzazione portoricana.

cityStateZipAddressLine

string

Città + stato + codice postale.

city

string

Nome della città.

state

string

Codice dello stato di 2 lettere.

zipCode

string

Codice postale, ad es. 10009.

zipCodeExtension

string

Estensione codice postale a 4 cifre, ad es. 5023.