PostalAddress
class PostalAddress extends Message
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/googlei18n/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
Generated from protobuf message google.type.PostalAddress
Methods
No description
The schema revision of the PostalAddress
.
The schema revision of the PostalAddress
.
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.
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.
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.
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.
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.).
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.).
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).
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).
Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
Optional. Generally refers to the city/town portion of the address.
Optional. Generally refers to the city/town portion of the address.
Optional. Sublocality of the address.
Optional. Sublocality of the address.
Unstructured address lines describing the lower levels of an address.
Unstructured address lines describing the lower levels of an address.
Optional. The recipient at the address.
Optional. The recipient at the address.
Optional. The name of the organization at the address.
Optional. The name of the organization at the address.
Details
at line 149
__construct()
at line 161
int
getRevision()
The schema revision of the PostalAddress
.
All new revisions must be backward compatible with old revisions.
Generated from protobuf field int32 revision = 1;
at line 174
$this
setRevision(int $var)
The schema revision of the PostalAddress
.
All new revisions must be backward compatible with old revisions.
Generated from protobuf field int32 revision = 1;
at line 192
string
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 http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
Generated from protobuf field string region_code = 2;
at line 208
$this
setRegionCode(string $var)
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.
Generated from protobuf field string region_code = 2;
at line 231
string
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".
Generated from protobuf field string language_code = 3;
at line 252
$this
setLanguageCode(string $var)
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".
Generated from protobuf field string language_code = 3;
at line 269
string
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 (e.g. state/zip validation in the U.S.A.).
Generated from protobuf field string postal_code = 4;
at line 284
$this
setPostalCode(string $var)
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.).
Generated from protobuf field string postal_code = 4;
at line 302
string
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 (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).
Generated from protobuf field string sorting_code = 5;
at line 318
$this
setSortingCode(string $var)
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).
Generated from protobuf field string sorting_code = 5;
at line 338
string
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. 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.
Generated from protobuf field string administrative_area = 6;
at line 356
$this
setAdministrativeArea(string $var)
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.
Generated from protobuf field string administrative_area = 6;
at line 373
string
getLocality()
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.
Generated from protobuf field string locality = 7;
at line 388
$this
setLocality(string $var)
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.
Generated from protobuf field string locality = 7;
at line 403
string
getSublocality()
Optional. Sublocality of the address.
For example, this can be neighborhoods, boroughs, districts.
Generated from protobuf field string sublocality = 8;
at line 416
$this
setSublocality(string $var)
Optional. Sublocality of the address.
For example, this can be neighborhoods, boroughs, districts.
Generated from protobuf field string sublocality = 8;
at line 448
RepeatedField
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 (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).
Generated from protobuf field repeated string address_lines = 9;
at line 478
$this
setAddressLines(string[]|RepeatedField $var)
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).
Generated from protobuf field repeated string address_lines = 9;
at line 494
RepeatedField
getRecipients()
Optional. The recipient at the address.
This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
Generated from protobuf field repeated string recipients = 10;
at line 508
$this
setRecipients(string[]|RepeatedField $var)
Optional. The recipient at the address.
This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
Generated from protobuf field repeated string recipients = 10;
at line 522
string
getOrganization()
Optional. The name of the organization at the address.
Generated from protobuf field string organization = 11;
at line 534
$this
setOrganization(string $var)
Optional. The name of the organization at the address.
Generated from protobuf field string organization = 11;