Show / Hide Table of Contents

Class Address

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

Inheritance
object
Address
Implements
IMessage<Address>
IEquatable<Address>
IDeepCloneable<Address>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Maps.AddressValidation.V1
Assembly: Google.Maps.AddressValidation.V1.dll
Syntax
public sealed class Address : IMessage<Address>, IEquatable<Address>, IDeepCloneable<Address>, IBufferMessage, IMessage

Constructors

Address()

Declaration
public Address()

Address(Address)

Declaration
public Address(Address other)
Parameters
Type Name Description
Address other

Properties

AddressComponents

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.

Declaration
public RepeatedField<AddressComponent> AddressComponents { get; }
Property Value
Type Description
RepeatedField<AddressComponent>

FormattedAddress

The post-processed address, formatted as a single-line address following the address formatting rules of the region where the address is located.

Note: the format of this address may not match the format of the address in the postal_address field. For example, the postal_address always represents the country as a 2 letter region_code, such as "US" or "NZ". By contrast, this field uses a longer form of the country name, such as "USA" or "New Zealand".

Declaration
public string FormattedAddress { get; set; }
Property Value
Type Description
string

MissingComponentTypes

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. An example might be ['street_number', 'route'] for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found here.

Note: you might see a missing component type when you think you've already supplied the missing component. For example, this can happen when the input address contains the building name, but not the premise number. In the address "渋谷区渋谷3丁目 Shibuya Stream", the building name "Shibuya Stream" has the component type premise, but the premise number is missing, so missing_component_types will contain premise.

Declaration
public RepeatedField<string> MissingComponentTypes { get; }
Property Value
Type Description
RepeatedField<string>

PostalAddress

The post-processed address represented as a postal address.

Declaration
public PostalAddress PostalAddress { get; set; }
Property Value
Type Description
PostalAddress

UnconfirmedComponentTypes

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][google.maps.addressvalidation.v1.AddressComponent.confirmation_level] is not [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED] or the [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred] flag is not set to true. The list of possible types can be found here.

Declaration
public RepeatedField<string> UnconfirmedComponentTypes { get; }
Property Value
Type Description
RepeatedField<string>

UnresolvedTokens

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, for an input such as "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", the unresolved tokens might look like ["Parcel", "0000123123", "&", "0000456456"].

Declaration
public RepeatedField<string> UnresolvedTokens { get; }
Property Value
Type Description
RepeatedField<string>
In this article
Back to top Generated by DocFX