Reference documentation and code samples for the Google API Common Protos Client class PostalAddress.
Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains.
In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or 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, see: https://support.google.com/business/answer/6397478 .
Generated from protobuf message google.type.PostalAddress
Namespace
Google \ TypeMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ revision
int
The schema revision of the PostalAddress
. This must be set to 0, which is the latest revision. All new revisions mustbe backward compatible with old revisions.
↳ region_code
string
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.
↳ language_code
string
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".
↳ postal_code
string
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 (for example, state or zip code validation in the United States).
↳ sorting_code
string
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 (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
↳ administrative_area
string
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. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
↳ locality
string
Optional. Generally refers to the city or 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
.
↳ sublocality
string
Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
↳ address_lines
string[]
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 (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), address_language
is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In 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).
↳ recipients
string[]
Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
↳ organization
string
Optional. The name of the organization at the address.
getRevision
The schema revision of the PostalAddress
. This must be set to 0, which is
the latest revision.
All new revisions mustbe backward compatible with old revisions.
int
setRevision
The schema revision of the PostalAddress
. This must be set to 0, which is
the latest revision.
All new revisions mustbe backward compatible with old revisions.
var
int
$this
getRegionCode
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.
string
setRegionCode
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.
var
string
$this
getLanguageCode
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".
string
setLanguageCode
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".
var
string
$this
getPostalCode
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 (for example, state or zip code validation in the United States).
string
setPostalCode
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 (for example, state or zip code validation in the United States).
var
string
$this
getSortingCode
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 (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
string
setSortingCode
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 (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
var
string
$this
getAdministrativeArea
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. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
string
setAdministrativeArea
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. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
var
string
$this
getLocality
Optional. Generally refers to the city or 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
.
string
setLocality
Optional. Generally refers to the city or 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
.
var
string
$this
getSublocality
Optional. Sublocality of the address.
For example, this can be a neighborhood, borough, or district.
string
setSublocality
Optional. Sublocality of the address.
For example, this can be a neighborhood, borough, or district.
var
string
$this
getAddressLines
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 (for example,
"Austin, TX"), it is important that the line order is clear. The order of
address lines should be "envelope order" for the country or region of the
address. In places where this can vary (for example, Japan), address_language
is used to make it explicit (for example, "ja" for
large-to-small ordering and "ja-Latn" or "en" for small-to-large). In 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).
setAddressLines
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 (for example,
"Austin, TX"), it is important that the line order is clear. The order of
address lines should be "envelope order" for the country or region of the
address. In places where this can vary (for example, Japan), address_language
is used to make it explicit (for example, "ja" for
large-to-small ordering and "ja-Latn" or "en" for small-to-large). In 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).
var
string[]
$this
getRecipients
Optional. The recipient at the address.
This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
setRecipients
Optional. The recipient at the address.
This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
var
string[]
$this
getOrganization
Optional. The name of the organization at the address.
string
setOrganization
Optional. The name of the organization at the address.
var
string
$this
