GoogleMapsAddressvalidationV1Verdict

import type { GoogleMapsAddressvalidationV1Verdict } from "https://googleapis.deno.dev/v1/addressvalidation:v1.ts";

High level overview of the address validation result and geocode.

interface GoogleMapsAddressvalidationV1Verdict {

addressComplete?: boolean;

geocodeGranularity?:

| "GRANULARITY_UNSPECIFIED"

| "SUB_PREMISE"

| "PREMISE"

| "PREMISE_PROXIMITY"

| "BLOCK"

| "ROUTE"

| "OTHER";

hasInferredComponents?: boolean;

hasReplacedComponents?: boolean;

hasUnconfirmedComponents?: boolean;

inputGranularity?:

| "GRANULARITY_UNSPECIFIED"

| "SUB_PREMISE"

| "PREMISE"

| "PREMISE_PROXIMITY"

| "BLOCK"

| "ROUTE"

| "OTHER";

validationGranularity?:

| "GRANULARITY_UNSPECIFIED"

| "SUB_PREMISE"

| "PREMISE"

| "PREMISE_PROXIMITY"

| "BLOCK"

| "ROUTE"

| "OTHER";

}

§Properties

addressComplete?: boolean

[src]

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.

[src]

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.

hasInferredComponents?: boolean

[src]

At least one address component was inferred (added) that wasn't in the input, see [google.maps.addressvalidation.v1.Address.address_components] for details.

hasReplacedComponents?: boolean

[src]

At least one address component was replaced, see [google.maps.addressvalidation.v1.Address.address_components] for details.

hasUnconfirmedComponents?: boolean

[src]

At least one address component cannot be categorized or validated, see [google.maps.addressvalidation.v1.Address.address_components] for details.

[src]

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.

[src]

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].