1. class
  2. Google
  3. \
  4. Type
  5. \
  6. PostalAddress

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

__construct(array $data = NULL)

Constructor.

int
getRevision()

The schema revision of the PostalAddress.

$this
setRevision(int $var)

The schema revision of the PostalAddress.

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.

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

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

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

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

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

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

string
getAdministrativeArea()

Optional. Highest administrative subdivision which is used for postal addresses of a country or region.

$this
setAdministrativeArea(string $var)

Optional. Highest administrative subdivision which is used for postal addresses of a country or region.

string
getLocality()

Optional. Generally refers to the city/town portion of the address.

$this
setLocality(string $var)

Optional. Generally refers to the city/town portion of the address.

string
getSublocality()

Optional. Sublocality of the address.

$this
setSublocality(string $var)

Optional. Sublocality of the address.

RepeatedField
getAddressLines()

Unstructured address lines describing the lower levels of an address.

$this
setAddressLines(string[]|RepeatedField $var)

Unstructured address lines describing the lower levels of an address.

RepeatedField
getRecipients()

Optional. The recipient at the address.

$this
setRecipients(string[]|RepeatedField $var)

Optional. The recipient at the address.

string
getOrganization()

Optional. The name of the organization at the address.

$this
setOrganization(string $var)

Optional. The name of the organization at the address.

Details

at line 230
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type int $revision
      The schema revision of the `PostalAddress`.
      All new revisions **must** be backward compatible with old revisions.
@type string $region_code
      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.
@type string $language_code
      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".
@type string $postal_code
      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.).
@type string $sorting_code
      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).
@type string $administrative_area
      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.
@type string $locality
      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.
@type string $sublocality
      Optional. Sublocality of the address.
      For example, this can be neighborhoods, boroughs, districts.
@type string[]|\Google\Protobuf\Internal\RepeatedField $address_lines
      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).
@type string[]|\Google\Protobuf\Internal\RepeatedField $recipients
      Optional. The recipient at the address.
      This field may, under certain circumstances, contain multiline information.
      For example, it might contain "care of" information.
@type string $organization
      Optional. The name of the organization at the address.

}

at line 242
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;

Return Value

int

at line 255
$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;

Parameters

int $var

Return Value

$this

at line 273
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;

Return Value

string

at line 289
$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;

Parameters

string $var

Return Value

$this

at line 312
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;

Return Value

string

at line 333
$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;

Parameters

string $var

Return Value

$this

at line 350
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;

Return Value

string

at line 365
$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;

Parameters

string $var

Return Value

$this

at line 383
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;

Return Value

string

at line 399
$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;

Parameters

string $var

Return Value

$this

at line 419
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;

Return Value

string

at line 437
$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;

Parameters

string $var

Return Value

$this

at line 454
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;

Return Value

string

at line 469
$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;

Parameters

string $var

Return Value

$this

at line 484
string getSublocality()

Optional. Sublocality of the address.

For example, this can be neighborhoods, boroughs, districts.

Generated from protobuf field string sublocality = 8;

Return Value

string

at line 497
$this setSublocality(string $var)

Optional. Sublocality of the address.

For example, this can be neighborhoods, boroughs, districts.

Generated from protobuf field string sublocality = 8;

Parameters

string $var

Return Value

$this

at line 529
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;

Return Value

RepeatedField

at line 559
$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;

Parameters

string[]|RepeatedField $var

Return Value

$this

at line 575
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;

Return Value

RepeatedField

at line 589
$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;

Parameters

string[]|RepeatedField $var

Return Value

$this

at line 603
string getOrganization()

Optional. The name of the organization at the address.

Generated from protobuf field string organization = 11;

Return Value

string

at line 615
$this setOrganization(string $var)

Optional. The name of the organization at the address.

Generated from protobuf field string organization = 11;

Parameters

string $var

Return Value

$this