Class PostalAddress

public sealed class PostalAddress : Protobuf.IMessage<PostalAddress>, Protobuf.IBufferMessage

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 i18n-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

Inheritance

Object > PostalAddress

Namespace

Google.Type

Assembly

Google.Api.CommonProtos.dll

Constructors

PostalAddress()

public PostalAddress()

PostalAddress(PostalAddress)

public PostalAddress(PostalAddress other)
Parameter
TypeNameDescription
PostalAddressother

Fields

AddressLinesFieldNumber

public const int AddressLinesFieldNumber = 9

Field number for the "address_lines" field.

Field Value
TypeDescription
Int32

AdministrativeAreaFieldNumber

public const int AdministrativeAreaFieldNumber = 6

Field number for the "administrative_area" field.

Field Value
TypeDescription
Int32

LanguageCodeFieldNumber

public const int LanguageCodeFieldNumber = 3

Field number for the "language_code" field.

Field Value
TypeDescription
Int32

LocalityFieldNumber

public const int LocalityFieldNumber = 7

Field number for the "locality" field.

Field Value
TypeDescription
Int32

OrganizationFieldNumber

public const int OrganizationFieldNumber = 11

Field number for the "organization" field.

Field Value
TypeDescription
Int32

PostalCodeFieldNumber

public const int PostalCodeFieldNumber = 4

Field number for the "postal_code" field.

Field Value
TypeDescription
Int32

RecipientsFieldNumber

public const int RecipientsFieldNumber = 10

Field number for the "recipients" field.

Field Value
TypeDescription
Int32

RegionCodeFieldNumber

public const int RegionCodeFieldNumber = 2

Field number for the "region_code" field.

Field Value
TypeDescription
Int32

RevisionFieldNumber

public const int RevisionFieldNumber = 1

Field number for the "revision" field.

Field Value
TypeDescription
Int32

SortingCodeFieldNumber

public const int SortingCodeFieldNumber = 5

Field number for the "sorting_code" field.

Field Value
TypeDescription
Int32

SublocalityFieldNumber

public const int SublocalityFieldNumber = 8

Field number for the "sublocality" field.

Field Value
TypeDescription
Int32

Properties

AddressLines

public Protobuf.Collections.RepeatedField<string> AddressLines { get; }

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

Property Value
TypeDescription
Protobuf.Collections.RepeatedField<String>

AdministrativeArea

public string AdministrativeArea { get; set; }

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.

Property Value
TypeDescription
String

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
Protobuf.Reflection.MessageDescriptor

LanguageCode

public string LanguageCode { get; set; }

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

Property Value
TypeDescription
String

Locality

public string Locality { get; set; }

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.

Property Value
TypeDescription
String

Organization

public string Organization { get; set; }

Optional. The name of the organization at the address.

Property Value
TypeDescription
String

Parser

public static Protobuf.MessageParser<PostalAddress> Parser { get; }
Property Value
TypeDescription
Protobuf.MessageParser<PostalAddress>

PostalCode

public string PostalCode { get; set; }

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

Property Value
TypeDescription
String

Recipients

public Protobuf.Collections.RepeatedField<string> Recipients { get; }

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

Property Value
TypeDescription
Protobuf.Collections.RepeatedField<String>

RegionCode

public string RegionCode { get; set; }

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 http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

Property Value
TypeDescription
String

Revision

public int Revision { get; set; }

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.

Property Value
TypeDescription
Int32

SortingCode

public string SortingCode { get; set; }

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ôte d'Ivoire).

Property Value
TypeDescription
String

Sublocality

public string Sublocality { get; set; }

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

Property Value
TypeDescription
String

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public PostalAddress Clone()
Returns
TypeDescription
PostalAddress

Equals(PostalAddress)

public bool Equals(PostalAddress other)
Parameter
TypeNameDescription
PostalAddressother
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
TypeNameDescription
Objectother
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
TypeNameDescription
Protobuf.CodedInputStreaminput

MergeFrom(PostalAddress)

public void MergeFrom(PostalAddress other)
Parameter
TypeNameDescription
PostalAddressother

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
TypeNameDescription
Protobuf.CodedOutputStreamoutput

Implements