AddressValidationclass

google.maps.addressValidation.AddressValidationclass

Notice: Available only in thev=beta channel.

Static class for accessing the AddressValidation APIs.

Access by callingconst {AddressValidation} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Static Methods
fetchAddressValidation	Notice: Available only in thev=beta channel. fetchAddressValidation(request) Parameters:  request: AddressValidationRequest Return Value: Promise<AddressValidation> Validates an address. Seehttps://developers.google.com/maps/documentation/javascript/address-validation/validate-address.

Properties
address	Notice: Available only in thev=beta channel. Type: Addressoptional Information about the address itself as opposed to the geocode.
geocode	Notice: Available only in thev=beta channel. Type: Geocodeoptional Information about the location and place that the address geocoded to.
metadata	Notice: Available only in thev=beta channel. Type: AddressMetadataoptional Other information relevant to deliverability.metadata is not guaranteed to be fully populated for every address sent to the Address Validation API.
responseId	Notice: Available only in thev=beta channel. Type: stringoptional The UUID that identifies this response. If the address needs to be re-validated, this UUIDmust accompany the new request.
uspsData	Notice: Available only in thev=beta channel. Type: USPSDataoptional Extra deliverability flags provided by USPS. Only provided in regionUS andPR.
verdict	Notice: Available only in thev=beta channel. Type: Verdictoptional Overall verdict flags

Methods
toJSON	Notice: Available only in thev=beta channel. toJSON() Parameters:  None Return Value: Object Converts the AddressValidation class to a JSON object with the same properties.

AddressValidationRequestinterface

google.maps.addressValidation.AddressValidationRequestinterface

Notice: Available only in thev=beta channel.

Request interface forAddressValidation.fetchAddressValidation.

Properties
address	Notice: Available only in thev=beta channel. Type: PostalAddressLiteral The address being validated. Unformatted addresses should be submitted viaPostalAddress.addressLines.
previousResponseIdoptional	Notice: Available only in thev=beta channel. Type: stringoptional This field must not be set for the first address validation request. If more requests are necessary to fully validate a single address (for example if the changes the user makes after the initial validation need to be re-validated), then each followup request must populate this field with theAddressValidation.responseId from the very first response in the validation sequence.
uspsCASSEnabledoptional	Notice: Available only in thev=beta channel. Type: booleanoptional Enables USPS CASS compatible mode. This affectsonly theAddressValidation.uspsData field ofAddressValidation. Note: for USPS CASS enabled requests for addresses in Puerto Rico, aPostalAddress.regionCode of theaddress must be provided as "PR", or anPostalAddress.administrativeArea of theaddress must be provided as "Puerto Rico" (case-insensitive) or "PR".

Addressclass

google.maps.addressValidation.Addressclass

Notice: Available only in thev=beta channel.

Details of the post-processed address. Post-processing includes correcting misspelled parts of the address, replacing incorrect parts, and inferring missing parts.

Access by callingconst {Address} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Properties
components	Notice: Available only in thev=beta channel. Type: Array<AddressComponent> The individual address components of the formatted and corrected address, along with validation information. This provides information on the validation status of the individual components.
formattedAddress	Notice: Available only in thev=beta channel. Type: stringoptional The post-processed address, formatted as a single-line address following the address-formatting rules of the region where the address is located.
missingComponentTypes	Notice: Available only in thev=beta channel. Type: Array<string> The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. Components of this type are not present informatted_address,postal_address, oraddress_components. An example might be['street_number', 'route'] for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be foundhere.
postalAddress	Notice: Available only in thev=beta channel. Type: PostalAddressoptional The post-processed address represented as a postal address.
unconfirmedComponentTypes	Notice: Available only in thev=beta channel. Type: Array<string> The types of the components that are present in theaddress_components but could not be confirmed to be correct. This field is provided for the sake of convenience: its contents are equivalent to iterating through theaddress_components to find the types of all the components where theAddressComponent.confirmationLevel is notConfirmationLevel.CONFIRMED or theAddressComponent.inferred flag is not set totrue. The list of possible types can be foundhere.
unresolvedTokens	Notice: Available only in thev=beta channel. Type: Array<string> Any tokens in the input that could not be resolved. This might be an input that was not recognized as a valid part of an address (for example in an input like "123235253253 Main St, San Francisco, CA, 94105", the unresolved tokens may look like["123235253253"] since that does not look like a valid street number.

AddressComponentclass

google.maps.addressValidation.AddressComponentclass

Notice: Available only in thev=beta channel.

Represents a single component of an address (ex. street name, city).

Access by callingconst {AddressComponent} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Properties
componentName	Notice: Available only in thev=beta channel. Type: stringoptional The component name text. For example, "5th Avenue" for a street name or "1253" for a street number,
componentNameLanguageCode	Notice: Available only in thev=beta channel. Type: stringoptional The BCP-47 language code. This will not be present if the component name is not associated with a language, such as a street number.
componentType	Notice: Available only in thev=beta channel. Type: stringoptional The type of the address component. SeeTable 2: Additional types returned by the Places service for a list of possible types.
confirmationLevel	Notice: Available only in thev=beta channel. Type: ConfirmationLeveloptional Indicates the level of certainty that the component is correct.
inferred	Notice: Available only in thev=beta channel. Type: boolean If true, this component was not part of the input, but was inferred for the address location. Including this component is recommended for a complete address.
replaced	Notice: Available only in thev=beta channel. Type: boolean Indicates the name of the component was replaced with a completely different one. For example, replacing a wrong postal code being with one that is correct for the address. This is not a cosmetic change; the input component has been changed to a different one.
spellCorrected	Notice: Available only in thev=beta channel. Type: boolean Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as "centre" to "center".
unexpected	Notice: Available only in thev=beta channel. Type: boolean If true, this component is not expected to be present in a postal address for the given region. It has been retained only because it was part of the input.

AddressMetadataclass

google.maps.addressValidation.AddressMetadataclass

Notice: Available only in thev=beta channel.

The metadata for the address. AddressMetadata is not guaranteed to be fully populated for every address sent to the Address Validation API.

Access by callingconst {AddressMetadata} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Properties
business	Notice: Available only in thev=beta channel. Type: boolean
poBox	Notice: Available only in thev=beta channel. Type: boolean
residential	Notice: Available only in thev=beta channel. Type: boolean

ConfirmationLevelconstants

google.maps.addressValidation.ConfirmationLevelconstants

Notice: Available only in thev=beta channel.

The different possible values indicating the level of certainty that the component is correct.

Access by callingconst {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Constants
CONFIRMED	Notice: Available only in thev=beta channel.
UNCONFIRMED_AND_SUSPICIOUS	Notice: Available only in thev=beta channel.
UNCONFIRMED_BUT_PLAUSIBLE	Notice: Available only in thev=beta channel.

Geocodeclass

google.maps.addressValidation.Geocodeclass

Notice: Available only in thev=beta channel.

Contains information about the place the input was geocoded to.

Access by callingconst {Geocode} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Properties
bounds	Notice: Available only in thev=beta channel. Type: LatLngBoundsoptional The bounds of the geocoded place.
featureSizeMeters	Notice: Available only in thev=beta channel. Type: numberoptional The size of the geocoded place, in meters. This is another measure of the coarseness of the geocoded location, but in physical size rather than in semantic meaning.
location	Notice: Available only in thev=beta channel. Type: LatLngAltitudeoptional The geocoded location of the input.
placeId	Notice: Available only in thev=beta channel. Type: stringoptional The Place ID of the geocoded place. Using Place is preferred over using addresses, latitude/longitude coordinates, or plus codes. Using coordinates for routing or calculating driving directions will always result in the point being snapped to the road nearest to those coordinates. This may not be a road that will quickly or safely lead to the destination and may not be near an access point to the property. Additionally, when a location is reverse geocoded, there is no guarantee that the returned address will match the original.
placeTypes	Notice: Available only in thev=beta channel. Type: Array<string> The type(s) of place that the input geocoded to. For example,['locality', 'political']. The full list of types can be found in theGeocoding API documentation.
plusCode	Notice: Available only in thev=beta channel. Type: PlusCodeoptional The plus code corresponding to thelocation.

Methods
fetchPlace	Notice: Available only in thev=beta channel. fetchPlace() Parameters:  None Return Value:  None Returns a Place representation of this Geocode. To get full place details, a call to place.fetchFields() should be made.

Granularityconstants

google.maps.addressValidation.Granularityconstants

Notice: Available only in thev=beta channel.

The various granularities that an address or a geocode can have. When used to indicate granularity for anaddress, these values indicate with how fine a granularity the address identifies a mailing destination. For example, an address such as "123 Main Street, Redwood City, CA, 94061" identifies aPREMISE while something like "Redwood City, CA, 94061" identifies aLOCALITY. However, if we are unable to find a geocode for "123 Main Street" in Redwood City, the geocode returned might be ofLOCALITY granularity even though the address is more granular.

Access by callingconst {Granularity} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Constants
BLOCK	Notice: Available only in thev=beta channel. The address or geocode indicates a block. Only used in regions which have block-level addressing, such as Japan.
OTHER	Notice: Available only in thev=beta channel. All other granularities, which are bucketed together since they are not deliverable.
PREMISE	Notice: Available only in thev=beta channel. Building-level result.
PREMISE_PROXIMITY	Notice: Available only in thev=beta channel. A geocode that approximates the building-level location of the address.
ROUTE	Notice: Available only in thev=beta channel. The geocode or address is granular to route, such as a street, road, or highway.
SUB_PREMISE	Notice: Available only in thev=beta channel. Below-building level result, such as an apartment.

USPSAddressclass

google.maps.addressValidation.USPSAddressclass

Notice: Available only in thev=beta channel.

USPS representation of a US address.

Access by callingconst {USPSAddress} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Properties
city	Notice: Available only in thev=beta channel. Type: stringoptional The city name.
cityStateZipAddressLine	Notice: Available only in thev=beta channel. Type: stringoptional The address line containing the city, state, and zip code.
firm	Notice: Available only in thev=beta channel. Type: stringoptional The name of the firm.
firstAddressLine	Notice: Available only in thev=beta channel. Type: stringoptional The first line of the address.
secondAddressLine	Notice: Available only in thev=beta channel. Type: stringoptional The second line of the address.
state	Notice: Available only in thev=beta channel. Type: stringoptional The 2-letter state code.
urbanization	Notice: Available only in thev=beta channel. Type: stringoptional The Puerto Rican urbanization name.
zipCode	Notice: Available only in thev=beta channel. Type: stringoptional The Postal code, e.g. "10009".
zipCodeExtension	Notice: Available only in thev=beta channel. Type: stringoptional The 4-digit postal code extension, e.g. "5023".

USPSDataclass

google.maps.addressValidation.USPSDataclass

Notice: Available only in thev=beta channel.

The USPS data for the address. USPSData is not guaranteed to be fully populated for every US or PR address sent to the Address Validation API. It's recommended to integrate the backup address fields in the response if you utilize uspsData as the primary part of the response.

Access by callingconst {USPSData} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Properties
abbreviatedCity	Notice: Available only in thev=beta channel. Type: stringoptional Abbreviated city.
addressRecordType	Notice: Available only in thev=beta channel. Type: stringoptional Type of the address record that matches the input address.
carrierRoute	Notice: Available only in thev=beta channel. Type: stringoptional The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator.
carrierRouteIndicator	Notice: Available only in thev=beta channel. Type: stringoptional Carrier route rate sort indicator.
cassProcessed	Notice: Available only in thev=beta channel. Type: boolean Indicator that the request has been CASS processed.
county	Notice: Available only in thev=beta channel. Type: stringoptional County name.
deliveryPointCheckDigit	Notice: Available only in thev=beta channel. Type: stringoptional The delivery point check digit. This number is added to the end of the delivery_point_barcode for mechanically scanned mail. Adding all the digits of the delivery_point_barcode, delivery_point_check_digit, postal code, and ZIP+4 together should yield a number divisible by 10.
deliveryPointCode	Notice: Available only in thev=beta channel. Type: stringoptional The 2-digit delivery point code.
dpvCMRA	Notice: Available only in thev=beta channel. Type: stringoptional Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients. Returns a single character.
dpvConfirmation	Notice: Available only in thev=beta channel. Type: stringoptional The possible values for DPV confirmation. Returns a single character or returns no value.
dpvDoorNotAccessible	Notice: Available only in thev=beta channel. Type: stringoptional Flag indicates addresses where USPS cannot knock on a door to deliver mail. Returns a single character.
dpvDrop	Notice: Available only in thev=beta channel. Type: stringoptional Flag indicates mail is delivered to a single receptable at a site. Returns a single character.
dpvEnhancedDeliveryCode	Notice: Available only in thev=beta channel. Type: stringoptional Indicates that more than one DPV return code is valid for the address. Returns a single character.
dpvFootnote	Notice: Available only in thev=beta channel. Type: stringoptional The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string.
dpvNonDeliveryDays	Notice: Available only in thev=beta channel. Type: stringoptional Flag indicates mail delivery is not performed every day of the week. Returns a single character.
dpvNonDeliveryDaysValues	Notice: Available only in thev=beta channel. Type: numberoptional Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a non-delivery day
dpvNoSecureLocation	Notice: Available only in thev=beta channel. Type: stringoptional Flag indicates door is accessible, but package will not be left due to security concerns. Returns a single character.
dpvNoStat	Notice: Available only in thev=beta channel. Type: stringoptional Indicates whether the address is a no stat address or an active address. No stat addresses are ones which are not continuously occupied or addresses that the USPS does not service. Returns a single character.
dpvNoStatReasonCode	Notice: Available only in thev=beta channel. Type: numberoptional Indicates the NoStat type. Returns a reason code as int.
dpvPBSA	Notice: Available only in thev=beta channel. Type: stringoptional Indicates the address was matched to PBSA record. Returns a single character.
dpvThrowback	Notice: Available only in thev=beta channel. Type: stringoptional Indicates that mail is not delivered to the street address. Returns a single character.
dpvVacant	Notice: Available only in thev=beta channel. Type: stringoptional Indicates whether the address is vacant. Returns a single character.
elotFlag	Notice: Available only in thev=beta channel. Type: stringoptional eLOT Ascending/Descending Flag (A/D).
elotNumber	Notice: Available only in thev=beta channel. Type: stringoptional Enhanced Line of Travel (eLOT) number.
errorMessage	Notice: Available only in thev=beta channel. Type: stringoptional Error message for USPS data retrieval. This is populated when USPS processing is suspended because of the detection of artificially created addresses.
fipsCountyCode	Notice: Available only in thev=beta channel. Type: stringoptional FIPS county code.
hasDefaultAddress	Notice: Available only in thev=beta channel. Type: boolean Indicator that a default address was found, but more specific addresses exist.
hasNoEWSMatch	Notice: Available only in thev=beta channel. Type: boolean The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.
lacsLinkIndicator	Notice: Available only in thev=beta channel. Type: stringoptional LACSLink indicator.
lacsLinkReturnCode	Notice: Available only in thev=beta channel. Type: stringoptional LACSLink return code.
pmbDesignator	Notice: Available only in thev=beta channel. Type: stringoptional PMB (Private Mail Box) unit designator.
pmbNumber	Notice: Available only in thev=beta channel. Type: stringoptional PMB (Private Mail Box) number.
poBoxOnlyPostalCode	Notice: Available only in thev=beta channel. Type: boolean PO Box only postal code.
postOfficeCity	Notice: Available only in thev=beta channel. Type: stringoptional Main post office city.
postOfficeState	Notice: Available only in thev=beta channel. Type: stringoptional Main post office state.
standardizedAddress	Notice: Available only in thev=beta channel. Type: USPSAddressoptional USPS standardized address.
suiteLinkFootnote	Notice: Available only in thev=beta channel. Type: stringoptional Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned.

Verdictclass

google.maps.addressValidation.Verdictclass

Notice: Available only in thev=beta channel.

Represents the post-processed address for the supplied address.

Access by callingconst {Verdict} = await google.maps.importLibrary("addressValidation").
SeeLibraries in the Maps JavaScript API.

Properties
addressComplete	Notice: Available only in thev=beta channel. Type: boolean The address is considered complete if there are no unresolved tokens, no unexpected or missing address components. If unset, indicates that the value isfalse. SeeAddress.missingComponentTypes,Address.unresolvedTokens orAddressComponent.unexpected fields for more details.
geocodeGranularity	Notice: Available only in thev=beta channel. Type: Granularityoptional Information about the granularity of theGeocode. This can be understood as the semantic meaning of how coarse or fine the geocoded location is.
hasInferredComponents	Notice: Available only in thev=beta channel. Type: boolean At least one address component was inferred (i.e. added) that wasn't in the input, seeAddressComponent for details.
hasReplacedComponents	Notice: Available only in thev=beta channel. Type: booleanoptional At least one address component was replaced - seeAddressComponent for details.
hasUnconfirmedComponents	Notice: Available only in thev=beta channel. Type: boolean At least one address component cannot be categorized or validated, seeAddressComponent for details.
inputGranularity	Notice: Available only in thev=beta channel. Type: Granularityoptional The granularity of theinput address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer tovalidationGranularity.
validationGranularity	Notice: Available only in thev=beta channel. Type: Granularityoptional The granularity level that the API can fullyvalidate the address to. For example, avalidationGranularity ofPREMISE indicates all address components at the level ofPREMISE and broader can be validated.