repos/googleapis-google-api-python-client-a9c62ce/googleapiclient/discovery_cache/documents/addressvalidation.v1.json

{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/maps-platform.addressvalidation": {
"description": "Private Service: https://www.googleapis.com/auth/maps-platform.addressvalidation"
}
}
}
},
"basePath": "",
"baseUrl": "https://addressvalidation.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Address Validation",
"description": "The Address Validation API allows developers to verify the accuracy of addresses. Given an address, it returns information about the correctness of the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/maps/documentation/addressvalidation",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "addressvalidation:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://addressvalidation.mtls.googleapis.com/",
"name": "addressvalidation",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"v1": {
"methods": {
"provideValidationFeedback": {
"description": "Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of `ValidateAddress` requests needed to validate an address fully.",
"flatPath": "v1:provideValidationFeedback",
"httpMethod": "POST",
"id": "addressvalidation.provideValidationFeedback",
"parameterOrder": [],
"parameters": {},
"path": "v1:provideValidationFeedback",
"request": {
"$ref": "GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest"
},
"response": {
"$ref": "GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/maps-platform.addressvalidation"
]
},
"validateAddress": {
"description": "Validates an address.",
"flatPath": "v1:validateAddress",
"httpMethod": "POST",
"id": "addressvalidation.validateAddress",
"parameterOrder": [],
"parameters": {},
"path": "v1:validateAddress",
"request": {
"$ref": "GoogleMapsAddressvalidationV1ValidateAddressRequest"
},
"response": {
"$ref": "GoogleMapsAddressvalidationV1ValidateAddressResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/maps-platform.addressvalidation"
]
}
}
}
},
"revision": "20240707",
"rootUrl": "https://addressvalidation.googleapis.com/",
"schemas": {
"GoogleGeoTypeViewport": {
"description": "A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { \"low\": { \"latitude\": 40.477398, \"longitude\": -74.259087 }, \"high\": { \"latitude\": 40.91618, \"longitude\": -73.70018 } }",
"id": "GoogleGeoTypeViewport",
"properties": {
"high": {
"$ref": "GoogleTypeLatLng",
"description": "Required. The high point of the viewport."
},
"low": {
"$ref": "GoogleTypeLatLng",
"description": "Required. The low point of the viewport."
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1Address": {
"description": "Details of the post-processed address. Post-processing includes correcting misspelled parts of the address, replacing incorrect parts, and inferring missing parts.",
"id": "GoogleMapsAddressvalidationV1Address",
"properties": {
"addressComponents": {
"description": "Unordered list. 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. Address components are not ordered in a particular way. Do not make any assumptions on the ordering of the address components in the list.",
"items": {
"$ref": "GoogleMapsAddressvalidationV1AddressComponent"
},
"type": "array"
},
"formattedAddress": {
"description": "The post-processed address, formatted as a single-line address following the address formatting rules of the region where the address is located.",
"type": "string"
},
"missingComponentTypes": {
"description": "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 in `formatted_address`, `postal_address`, or `address_components`. An example might be `['street_number', 'route']` for an input like \"Boulder, Colorado, 80301, USA\". The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).",
"items": {
"type": "string"
},
"type": "array"
},
"postalAddress": {
"$ref": "GoogleTypePostalAddress",
"description": "The post-processed address represented as a postal address."
},
"unconfirmedComponentTypes": {
"description": "The types of the components that are present in the `address_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 the `address_components` to find the types of all the components where the confirmation_level is not CONFIRMED or the inferred flag is not set to `true`. The list of possible types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).",
"items": {
"type": "string"
},
"type": "array"
},
"unresolvedTokens": {
"description": "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.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1AddressComponent": {
"description": "Represents an address component, such as a street, city, or state.",
"id": "GoogleMapsAddressvalidationV1AddressComponent",
"properties": {
"componentName": {
"$ref": "GoogleMapsAddressvalidationV1ComponentName",
"description": "The name for this component."
},
"componentType": {
"description": "The type of the address component. See [Table 2: Additional types returned by the Places service](https://developers.google.com/places/web-service/supported_types#table2) for a list of possible types.",
"type": "string"
},
"confirmationLevel": {
"description": "Indicates the level of certainty that we have that the component is correct.",
"enum": [
"CONFIRMATION_LEVEL_UNSPECIFIED",
"CONFIRMED",
"UNCONFIRMED_BUT_PLAUSIBLE",
"UNCONFIRMED_AND_SUSPICIOUS"
],
"enumDescriptions": [
"Default value. This value is unused.",
"We were able to verify that this component exists and makes sense in the context of the rest of the address.",
"This component could not be confirmed, but it is plausible that it exists. For example, a street number within a known valid range of numbers on a street where specific house numbers are not known.",
"This component was not confirmed and is likely to be wrong. For example, a neighborhood that does not fit the rest of the address."
],
"type": "string"
},
"inferred": {
"description": "Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.",
"type": "boolean"
},
"replaced": {
"description": "Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.",
"type": "boolean"
},
"spellCorrected": {
"description": "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 when changing \"centre\" to \"center\". It also does not always flag common misspellings, such as when changing \"Amphitheater Pkwy\" to \"Amphitheatre Pkwy\".",
"type": "boolean"
},
"unexpected": {
"description": "Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1AddressMetadata": {
"description": "The metadata for the address. `metadata` is not guaranteed to be fully populated for every address sent to the Address Validation API.",
"id": "GoogleMapsAddressvalidationV1AddressMetadata",
"properties": {
"business": {
"description": "Indicates that this is the address of a business. If unset, indicates that the value is unknown.",
"type": "boolean"
},
"poBox": {
"description": "Indicates that the address of a PO box. If unset, indicates that the value is unknown.",
"type": "boolean"
},
"residential": {
"description": "Indicates that this is the address of a residence. If unset, indicates that the value is unknown.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1ComponentName": {
"description": "A wrapper for the name of the component.",
"id": "GoogleMapsAddressvalidationV1ComponentName",
"properties": {
"languageCode": {
"description": "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.",
"type": "string"
},
"text": {
"description": "The name text. For example, \"5th Avenue\" for a street name or \"1253\" for a street number.",
"type": "string"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1Geocode": {
"description": "Contains information about the place the input was geocoded to.",
"id": "GoogleMapsAddressvalidationV1Geocode",
"properties": {
"bounds": {
"$ref": "GoogleGeoTypeViewport",
"description": "The bounds of the geocoded place."
},
"featureSizeMeters": {
"description": "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.",
"format": "float",
"type": "number"
},
"location": {
"$ref": "GoogleTypeLatLng",
"description": "The geocoded location of the input. Using place IDs is preferred over using addresses, latitude/longitude coordinates, or plus codes. Using coordinates when 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."
},
"placeId": {
"description": "The PlaceID of the place this input geocodes to. For more information about Place IDs see [here](https://developers.google.com/maps/documentation/places/web-service/place-id).",
"type": "string"
},
"placeTypes": {
"description": "The type(s) of place that the input geocoded to. For example, `['locality', 'political']`. The full list of types can be found [here](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).",
"items": {
"type": "string"
},
"type": "array"
},
"plusCode": {
"$ref": "GoogleMapsAddressvalidationV1PlusCode",
"description": "The plus code corresponding to the `location`."
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1LanguageOptions": {
"description": "Preview: This feature is in Preview (pre-GA). Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. Pre-GA Offerings are covered by the [Google Maps Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). For more information, see the [launch stage descriptions](https://developers.google.com/maps/launch-stages). Enables the Address Validation API to include additional information in the response.",
"id": "GoogleMapsAddressvalidationV1LanguageOptions",
"properties": {
"returnEnglishLatinAddress": {
"description": "Preview: Return a [google.maps.addressvalidation.v1.Address] in English. See [google.maps.addressvalidation.v1.ValidationResult.english_latin_address] for details.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1PlusCode": {
"description": "Plus code (http://plus.codes) is a location reference with two formats: global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle, and compound code, replacing the prefix with a reference location.",
"id": "GoogleMapsAddressvalidationV1PlusCode",
"properties": {
"compoundCode": {
"description": "Place's compound code, such as \"33GV+HQ, Ramberg, Norway\", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity.",
"type": "string"
},
"globalCode": {
"description": "Place's global (full) code, such as \"9FWM33GV+HQ\", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).",
"type": "string"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest": {
"description": "The request for sending validation feedback.",
"id": "GoogleMapsAddressvalidationV1ProvideValidationFeedbackRequest",
"properties": {
"conclusion": {
"description": "Required. The outcome of the sequence of validation attempts. If this field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error will be returned.",
"enum": [
"VALIDATION_CONCLUSION_UNSPECIFIED",
"VALIDATED_VERSION_USED",
"USER_VERSION_USED",
"UNVALIDATED_VERSION_USED",
"UNUSED"
],
"enumDescriptions": [
"This value is unused. If the `ProvideValidationFeedbackRequest.conclusion` field is set to `VALIDATION_CONCLUSION_UNSPECIFIED`, an `INVALID_ARGUMENT` error will be returned.",
"The version of the address returned by the Address Validation API was used for the transaction.",
"The version of the address provided by the user was used for the transaction",
"A version of the address that was entered after the last validation attempt but that was not re-validated was used for the transaction.",
"The transaction was abandoned and the address was not used."
],
"type": "string"
},
"responseId": {
"description": "Required. The ID of the response that this feedback is for. This should be the response_id from the first response in a series of address validation attempts.",
"type": "string"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse": {
"description": "The response for validation feedback. The response is empty if the feedback is sent successfully.",
"id": "GoogleMapsAddressvalidationV1ProvideValidationFeedbackResponse",
"properties": {},
"type": "object"
},
"GoogleMapsAddressvalidationV1UspsAddress": {
"description": "USPS representation of a US address.",
"id": "GoogleMapsAddressvalidationV1UspsAddress",
"properties": {
"city": {
"description": "City name.",
"type": "string"
},
"cityStateZipAddressLine": {
"description": "City + state + postal code.",
"type": "string"
},
"firm": {
"description": "Firm name.",
"type": "string"
},
"firstAddressLine": {
"description": "First address line.",
"type": "string"
},
"secondAddressLine": {
"description": "Second address line.",
"type": "string"
},
"state": {
"description": "2 letter state code.",
"type": "string"
},
"urbanization": {
"description": "Puerto Rican urbanization name.",
"type": "string"
},
"zipCode": {
"description": "Postal code e.g. 10009.",
"type": "string"
},
"zipCodeExtension": {
"description": "4-digit postal code extension e.g. 5023.",
"type": "string"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1UspsData": {
"description": "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.",
"id": "GoogleMapsAddressvalidationV1UspsData",
"properties": {
"abbreviatedCity": {
"description": "Abbreviated city.",
"type": "string"
},
"addressRecordType": {
"description": "Type of the address record that matches the input address. * `F`: FIRM. This is a match to a Firm Record, which is the finest level of match available for an address. * `G`: GENERAL DELIVERY. This is a match to a General Delivery record. * `H`: BUILDING / APARTMENT. This is a match to a Building or Apartment record. * `P`: POST OFFICE BOX. This is a match to a Post Office Box. * `R`: RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural Route or a Highway Contract record, both of which may have associated Box Number ranges. * `S`: STREET RECORD: This is a match to a Street record containing a valid primary number range.",
"type": "string"
},
"carrierRoute": {
"description": "The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator. Prefixes: * `C`: Carrier route (or city route) * `R`: Rural route * `H`: Highway Contract Route * `B`: Post Office Box Section * `G`: General delivery unit",
"type": "string"
},
"carrierRouteIndicator": {
"description": "Carrier route rate sort indicator.",
"type": "string"
},
"cassProcessed": {
"description": "Indicator that the request has been CASS processed.",
"type": "boolean"
},
"county": {
"description": "County name.",
"type": "string"
},
"defaultAddress": {
"description": "Indicator that a default address was found, but more specific addresses exists.",
"type": "boolean"
},
"deliveryPointCheckDigit": {
"description": "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.",
"type": "string"
},
"deliveryPointCode": {
"description": "2 digit delivery point code",
"type": "string"
},
"dpvCmra": {
"description": "Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients. Returns a single character. * `Y`: The address is a CMRA * `N`: The address is not a CMRA",
"type": "string"
},
"dpvConfirmation": {
"description": "The possible values for DPV confirmation. Returns a single character or returns no value. * `N`: Primary and any secondary number information failed to DPV confirm. * `D`: Address was DPV confirmed for the primary number only, and the secondary number information was missing. * `S`: Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed. * `Y`: Address was DPV confirmed for primary and any secondary numbers. * Empty: If the response does not contain a `dpv_confirmation` value, the address was not submitted for DPV confirmation.",
"type": "string"
},
"dpvDoorNotAccessible": {
"description": "Flag indicates addresses where USPS cannot knock on a door to deliver mail. Returns a single character. * `Y`: The door is not accessible. * `N`: No indication the door is not accessible.",
"type": "string"
},
"dpvDrop": {
"description": "Flag indicates mail is delivered to a single receptable at a site. Returns a single character. * `Y`: The mail is delivered to a single receptable at a site. * `N`: The mail is not delivered to a single receptable at a site.",
"type": "string"
},
"dpvEnhancedDeliveryCode": {
"description": "Indicates that more than one DPV return code is valid for the address. Returns a single character. * `Y`: Address was DPV confirmed for primary and any secondary numbers. * `N`: Primary and any secondary number information failed to DPV confirm. * `S`: Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required. * `D`: Address was DPV confirmed for the primary number only, and the secondary number information was missing. * `R`: Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.",
"type": "string"
},
"dpvFootnote": {
"description": "The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string. * `AA`: Input address matched to the ZIP+4 file * `A1`: Input address was not matched to the ZIP+4 file * `BB`: Matched to DPV (all components) * `CC`: Secondary number not matched and not required * `C1`: Secondary number not matched but required * `N1`: High-rise address missing secondary number * `M1`: Primary number missing * `M3`: Primary number invalid * `P1`: Input address PO, RR or HC box number missing * `P3`: Input address PO, RR, or HC Box number invalid * `F1`: Input address matched to a military address * `G1`: Input address matched to a general delivery address * `U1`: Input address matched to a unique ZIP code * `PB`: Input address matched to PBSA record * `RR`: DPV confirmed address with PMB information * `R1`: DPV confirmed address without PMB information * `R7`: Carrier Route R777 or R779 record * `IA`: Informed Address identified * `TA`: Primary number matched by dropping a trailing alpha",
"type": "string"
},
"dpvNoSecureLocation": {
"description": "Flag indicates door is accessible, but package will not be left due to security concerns. Returns a single character. * `Y`: The package will not be left due to security concerns. * `N`: No indication the package will not be left due to security concerns.",
"type": "string"
},
"dpvNoStat": {
"description": "Is this 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. * `Y`: The address is not active * `N`: The address is active",
"type": "string"
},
"dpvNoStatReasonCode": {
"description": "Indicates the NoStat type. Returns a reason code as int. * `1`: IDA (Internal Drop Address) \u2013 Addresses that do not receive mail directly from the USPS but are delivered to a drop address that services them. * `2`: CDS - Addresses that have not yet become deliverable. For example, a new subdivision where lots and primary numbers have been determined, but no structure exists yet for occupancy. * `3`: Collision - Addresses that do not actually DPV confirm. * `4`: CMZ (College, Military and Other Types) - ZIP + 4 records USPS has incorporated into the data. * `5`: Regular - Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries. * `6`: Secondary Required - The address requires secondary information.",
"format": "int32",
"type": "integer"
},
"dpvNonDeliveryDays": {
"description": "Flag indicates mail delivery is not performed every day of the week. Returns a single character. * `Y`: The mail delivery is not performed every day of the week. * `N`: No indication the mail delivery is not performed every day of the week.",
"type": "string"
},
"dpvNonDeliveryDaysValues": {
"description": "Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 \u2013 Sunday is a non-delivery day 0x20 \u2013 Monday is a non-delivery day 0x10 \u2013 Tuesday is a non-delivery day 0x08 \u2013 Wednesday is a non-delivery day 0x04 \u2013 Thursday is a non-delivery day 0x02 \u2013 Friday is a non-delivery day 0x01 \u2013 Saturday is a non-delivery day",
"format": "int32",
"type": "integer"
},
"dpvPbsa": {
"description": "Indicates the address was matched to PBSA record. Returns a single character. * `Y`: The address was matched to PBSA record. * `N`: The address was not matched to PBSA record.",
"type": "string"
},
"dpvThrowback": {
"description": "Indicates that mail is not delivered to the street address. Returns a single character. * `Y`: The mail is not delivered to the street address. * `N`: The mail is delivered to the street address.",
"type": "string"
},
"dpvVacant": {
"description": "Is this place vacant? Returns a single character. * `Y`: The address is vacant * `N`: The address is not vacant",
"type": "string"
},
"elotFlag": {
"description": "eLOT Ascending/Descending Flag (A/D).",
"type": "string"
},
"elotNumber": {
"description": "Enhanced Line of Travel (eLOT) number.",
"type": "string"
},
"errorMessage": {
"description": "Error message for USPS data retrieval. This is populated when USPS processing is suspended because of the detection of artificially created addresses. The USPS data fields might not be populated when this error is present.",
"type": "string"
},
"ewsNoMatch": {
"description": "The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.",
"type": "boolean"
},
"fipsCountyCode": {
"description": "FIPS county code.",
"type": "string"
},
"lacsLinkIndicator": {
"description": "LACSLink indicator.",
"type": "string"
},
"lacsLinkReturnCode": {
"description": "LACSLink return code.",
"type": "string"
},
"pmbDesignator": {
"description": "PMB (Private Mail Box) unit designator.",
"type": "string"
},
"pmbNumber": {
"description": "PMB (Private Mail Box) number;",
"type": "string"
},
"poBoxOnlyPostalCode": {
"description": "PO Box only postal code.",
"type": "boolean"
},
"postOfficeCity": {
"description": "Main post office city.",
"type": "string"
},
"postOfficeState": {
"description": "Main post office state.",
"type": "string"
},
"standardizedAddress": {
"$ref": "GoogleMapsAddressvalidationV1UspsAddress",
"description": "USPS standardized address."
},
"suitelinkFootnote": {
"description": "Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned. * `A`: SuiteLink record match, business address improved. * `00`: No match, business address is not improved.",
"type": "string"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1ValidateAddressRequest": {
"description": "The request for validating an address.",
"id": "GoogleMapsAddressvalidationV1ValidateAddressRequest",
"properties": {
"address": {
"$ref": "GoogleTypePostalAddress",
"description": "Required. The address being validated. Unformatted addresses should be submitted via `address_lines`. The total length of the fields in this input must not exceed 280 characters. Supported regions can be found [here](https://developers.google.com/maps/documentation/address-validation/coverage). The language_code value in the input address is reserved for future uses and is ignored today. The validated address result will be populated based on the preferred language for the given address, as identified by the system. The Address Validation API ignores the values in recipients and organization. Any values in those fields will be discarded and not returned. Please do not set them."
},
"enableUspsCass": {
"description": "Enables USPS CASS compatible mode. This affects _only_ the [google.maps.addressvalidation.v1.ValidationResult.usps_data] field of [google.maps.addressvalidation.v1.ValidationResult]. Note: for USPS CASS enabled requests for addresses in Puerto Rico, a [google.type.PostalAddress.region_code] of the `address` must be provided as \"PR\", or an [google.type.PostalAddress.administrative_area] of the `address` must be provided as \"Puerto Rico\" (case-insensitive) or \"PR\". It's recommended to use a componentized `address`, or alternatively specify at least two [google.type.PostalAddress.address_lines] where the first line contains the street number and name and the second line contains the city, state, and zip code.",
"type": "boolean"
},
"languageOptions": {
"$ref": "GoogleMapsAddressvalidationV1LanguageOptions",
"description": "Optional. Preview: This feature is in Preview (pre-GA). Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. Pre-GA Offerings are covered by the [Google Maps Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). For more information, see the [launch stage descriptions](https://developers.google.com/maps/launch-stages). Enables the Address Validation API to include additional information in the response."
},
"previousResponseId": {
"description": "This field must be empty 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 the response_id from the very first response in the validation sequence.",
"type": "string"
},
"sessionToken": {
"description": "Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned. The session begins when the user makes an Autocomplete query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple Autocomplete queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the `sessionToken` parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately). Note: Address Validation can only be used in sessions with the Autocomplete (New) API, not the Autocomplete API. See https://developers.google.com/maps/documentation/places/web-service/session-pricing for more details.",
"type": "string"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1ValidateAddressResponse": {
"description": "The response to an address validation request.",
"id": "GoogleMapsAddressvalidationV1ValidateAddressResponse",
"properties": {
"responseId": {
"description": "The UUID that identifies this response. If the address needs to be re-validated, this UUID *must* accompany the new request.",
"type": "string"
},
"result": {
"$ref": "GoogleMapsAddressvalidationV1ValidationResult",
"description": "The result of the address validation."
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1ValidationResult": {
"description": "The result of validating an address.",
"id": "GoogleMapsAddressvalidationV1ValidationResult",
"properties": {
"address": {
"$ref": "GoogleMapsAddressvalidationV1Address",
"description": "Information about the address itself as opposed to the geocode."
},
"englishLatinAddress": {
"$ref": "GoogleMapsAddressvalidationV1Address",
"description": "Preview: This feature is in Preview (pre-GA). Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. Pre-GA Offerings are covered by the [Google Maps Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). For more information, see the [launch stage descriptions](https://developers.google.com/maps/launch-stages). The address translated to English. Translated addresses are not reusable as API input. The service provides them so that the user can use their native language to confirm or deny the validation of the originally-provided address. If part of the address doesn't have an English translation, the service returns that part in an alternate language that uses a Latin script. See [here](https://developers.google.com/maps/documentation/address-validation/convert-addresses-english) for an explanation of how the alternate language is selected. If part of the address doesn't have any translations or transliterations in a language that uses a Latin script, the service returns that part in the local language associated with the address. Enable this output by using the [google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address] flag. Note: the [google.maps.addressvalidation.v1.Address.unconfirmed_component_types] field in the `english_latin_address` and the [google.maps.addressvalidation.v1.AddressComponent.confirmation_level] fields in `english_latin_address.address_components` are not populated."
},
"geocode": {
"$ref": "GoogleMapsAddressvalidationV1Geocode",
"description": "Information about the location and place that the address geocoded to."
},
"metadata": {
"$ref": "GoogleMapsAddressvalidationV1AddressMetadata",
"description": "Other information relevant to deliverability. `metadata` is not guaranteed to be fully populated for every address sent to the Address Validation API."
},
"uspsData": {
"$ref": "GoogleMapsAddressvalidationV1UspsData",
"description": "Extra deliverability flags provided by USPS. Only provided in region `US` and `PR`."
},
"verdict": {
"$ref": "GoogleMapsAddressvalidationV1Verdict",
"description": "Overall verdict flags"
}
},
"type": "object"
},
"GoogleMapsAddressvalidationV1Verdict": {
"description": "High level overview of the address validation result and geocode.",
"id": "GoogleMapsAddressvalidationV1Verdict",
"properties": {
"addressComplete": {
"description": "The address is considered complete if there are no unresolved tokens, no unexpected or missing address components. If unset, indicates that the value is `false`. See `missing_component_types`, `unresolved_tokens` or `unexpected` fields for more details.",
"type": "boolean"
},
"geocodeGranularity": {
"description": "Information about the granularity of the `geocode`. This can be understood as the semantic meaning of how coarse or fine the geocoded location is. This can differ from the `validation_granularity` above occasionally. For example, our database might record the existence of an apartment number but do not have a precise location for the apartment within a big apartment complex. In that case, the `validation_granularity` will be `SUB_PREMISE` but the `geocode_granularity` will be `PREMISE`.",
"enum": [
"GRANULARITY_UNSPECIFIED",
"SUB_PREMISE",
"PREMISE",
"PREMISE_PROXIMITY",
"BLOCK",
"ROUTE",
"OTHER"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Below-building level result, such as an apartment.",
"Building-level result.",
"A geocode that approximates the building-level location of the address.",
"The address or geocode indicates a block. Only used in regions which have block-level addressing, such as Japan.",
"The geocode or address is granular to route, such as a street, road, or highway.",
"All other granularities, which are bucketed together since they are not deliverable."
],
"type": "string"
},
"hasInferredComponents": {
"description": "At least one address component was inferred (added) that wasn't in the input, see [google.maps.addressvalidation.v1.Address.address_components] for details.",
"type": "boolean"
},
"hasReplacedComponents": {
"description": "At least one address component was replaced, see [google.maps.addressvalidation.v1.Address.address_components] for details.",
"type": "boolean"
},
"hasUnconfirmedComponents": {
"description": "At least one address component cannot be categorized or validated, see [google.maps.addressvalidation.v1.Address.address_components] for details.",
"type": "boolean"
},
"inputGranularity": {
"description": "The granularity of the **input** address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to `validation_granularity` below. For example, if the input address includes a specific apartment number, then the `input_granularity` here will be `SUB_PREMISE`. If we cannot match the apartment number in the databases or the apartment number is invalid, the `validation_granularity` will likely be `PREMISE` or below.",
"enum": [
"GRANULARITY_UNSPECIFIED",
"SUB_PREMISE",
"PREMISE",
"PREMISE_PROXIMITY",
"BLOCK",
"ROUTE",
"OTHER"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Below-building level result, such as an apartment.",
"Building-level result.",
"A geocode that approximates the building-level location of the address.",
"The address or geocode indicates a block. Only used in regions which have block-level addressing, such as Japan.",
"The geocode or address is granular to route, such as a street, road, or highway.",
"All other granularities, which are bucketed together since they are not deliverable."
],
"type": "string"
},
"validationGranularity": {
"description": "The granularity level that the API can fully **validate** the address to. For example, an `validation_granularity` of `PREMISE` indicates all address components at the level of `PREMISE` or more coarse can be validated. Per address component validation result can be found in [google.maps.addressvalidation.v1.Address.address_components].",
"enum": [
"GRANULARITY_UNSPECIFIED",
"SUB_PREMISE",
"PREMISE",
"PREMISE_PROXIMITY",
"BLOCK",
"ROUTE",
"OTHER"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Below-building level result, such as an apartment.",
"Building-level result.",
"A geocode that approximates the building-level location of the address.",
"The address or geocode indicates a block. Only used in regions which have block-level addressing, such as Japan.",
"The geocode or address is granular to route, such as a street, road, or highway.",
"All other granularities, which are bucketed together since they are not deliverable."
],
"type": "string"
}
},
"type": "object"
},
"GoogleTypeLatLng": {
"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.",
"id": "GoogleTypeLatLng",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"GoogleTypePostalAddress": {
"description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478",
"id": "GoogleTypePostalAddress",
"properties": {
"addressLines": {
"description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
"items": {
"type": "string"
},
"type": "array"
},
"administrativeArea": {
"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.",
"type": "string"
},
"languageCode": {
"description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".",
"type": "string"
},
"locality": {
"description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.",
"type": "string"
},
"organization": {
"description": "Optional. The name of the organization at the address.",
"type": "string"
},
"postalCode": {
"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).",
"type": "string"
},
"recipients": {
"description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.",
"items": {
"type": "string"
},
"type": "array"
},
"regionCode": {
"description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.",
"type": "string"
},
"revision": {
"description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.",
"format": "int32",
"type": "integer"
},
"sortingCode": {
"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. C\u00f4te d'Ivoire).",
"type": "string"
},
"sublocality": {
"description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Address Validation API",
"version": "v1",
"version_module": true
}