Documentation

PostalAddress extends Message
in package

Application

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

Generated from protobuf message google.type.PostalAddress

Properties

$administrative_area : mixed: Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
$language_code : mixed: 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.
$locality : mixed: Optional. Generally refers to the city/town portion of the address.
$organization : mixed: Optional. The name of the organization at the address.
$postal_code : mixed: 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.).
$region_code : mixed: 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.
$revision : mixed: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision.
$sorting_code : mixed: 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).
$sublocality : mixed: Optional. Sublocality of the address.
$address_lines : mixed: Unstructured address lines describing the lower levels of an address.
$recipients : mixed: Optional. The recipient at the address.

Methods

__construct() : mixed: Constructor.
getAddressLines() : RepeatedField: Unstructured address lines describing the lower levels of an address.
getAdministrativeArea() : string: Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
getLanguageCode() : 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.
getLocality() : string: Optional. Generally refers to the city/town portion of the address.
getOrganization() : string: Optional. The name of the organization at the address.
getPostalCode() : 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 (e.g. state/zip validation in the U.S.A.).
getRecipients() : RepeatedField: Optional. The recipient at the address.
getRegionCode() : 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 http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
getRevision() : int: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision.
getSortingCode() : 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 (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).
getSublocality() : string: Optional. Sublocality of the address.
setAddressLines() : $this: Unstructured address lines describing the lower levels of an address.
setAdministrativeArea() : $this: Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
setLanguageCode() : $this: 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.
setLocality() : $this: Optional. Generally refers to the city/town portion of the address.
setOrganization() : $this: Optional. The name of the organization at the address.
setPostalCode() : $this: 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.).
setRecipients() : $this: Optional. The recipient at the address.
setRegionCode() : $this: 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.
setRevision() : $this: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision.
setSortingCode() : $this: 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).
setSublocality() : $this: Optional. Sublocality of the address.

$administrative_area

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


    protected
        mixed
    $administrative_area
     = ''

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 [json_name = "administrativeArea"];

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


    protected
        mixed
    $language_code
     = ''

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 [json_name = "languageCode"];

$locality

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


    protected
        mixed
    $locality
     = ''

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 [json_name = "locality"];

$organization

Optional. The name of the organization at the address.


    protected
        mixed
    $organization
     = ''

Generated from protobuf field string organization = 11 [json_name = "organization"];

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


    protected
        mixed
    $postal_code
     = ''

Generated from protobuf field string postal_code = 4 [json_name = "postalCode"];

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


    protected
        mixed
    $region_code
     = ''

Generated from protobuf field string region_code = 2 [json_name = "regionCode"];

$revision

The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision.


    protected
        mixed
    $revision
     = 0

All new revisions must be backward compatible with old revisions.

Generated from protobuf field int32 revision = 1 [json_name = "revision"];

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


    protected
        mixed
    $sorting_code
     = ''

Generated from protobuf field string sorting_code = 5 [json_name = "sortingCode"];

$sublocality

Optional. Sublocality of the address.


    protected
        mixed
    $sublocality
     = ''

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

Generated from protobuf field string sublocality = 8 [json_name = "sublocality"];

$address_lines

Unstructured address lines describing the lower levels of an address.


    private
        mixed
    $address_lines

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 [json_name = "addressLines"];

$recipients

Optional. The recipient at the address.


    private
        mixed
    $recipients

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 [json_name = "recipients"];

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $data = NULL ]) : mixed

Parameters

$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type int $revision
      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.
@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 array<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 array<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.

}

getAddressLines()

Unstructured address lines describing the lower levels of an address.


    public
                    getAddressLines() : RepeatedField

Generated from protobuf field repeated string address_lines = 9 [json_name = "addressLines"];

Return values

RepeatedField

getAdministrativeArea()

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


    public
                    getAdministrativeArea() : string

Generated from protobuf field string administrative_area = 6 [json_name = "administrativeArea"];

Return values

string

getLanguageCode()


    public
                    getLanguageCode() : string

Generated from protobuf field string language_code = 3 [json_name = "languageCode"];

Return values

string

getLocality()

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


    public
                    getLocality() : string

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 [json_name = "locality"];

Return values

string

getOrganization()

Optional. The name of the organization at the address.


    public
                    getOrganization() : string

Generated from protobuf field string organization = 11 [json_name = "organization"];

Return values

string

getPostalCode()


    public
                    getPostalCode() : string

Generated from protobuf field string postal_code = 4 [json_name = "postalCode"];

Return values

string

getRecipients()

Optional. The recipient at the address.


    public
                    getRecipients() : RepeatedField

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 [json_name = "recipients"];

Return values

RepeatedField

getRegionCode()


    public
                    getRegionCode() : string

Generated from protobuf field string region_code = 2 [json_name = "regionCode"];

Return values

string

getRevision()

The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision.


    public
                    getRevision() : int

All new revisions must be backward compatible with old revisions.

Generated from protobuf field int32 revision = 1 [json_name = "revision"];

Return values

int

getSortingCode()


    public
                    getSortingCode() : string

Generated from protobuf field string sorting_code = 5 [json_name = "sortingCode"];

Return values

string

getSublocality()

Optional. Sublocality of the address.


    public
                    getSublocality() : string

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

Generated from protobuf field string sublocality = 8 [json_name = "sublocality"];

Return values

string

setAddressLines()

Unstructured address lines describing the lower levels of an address.


    public
                    setAddressLines(array<string|int, string>|RepeatedField $var) : $this

Generated from protobuf field repeated string address_lines = 9 [json_name = "addressLines"];

Parameters

$var : array<string|int, string>|RepeatedField

Return values

$this

setAdministrativeArea()

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


    public
                    setAdministrativeArea(string $var) : $this

Generated from protobuf field string administrative_area = 6 [json_name = "administrativeArea"];

Parameters

$var : string

Return values

$this

setLanguageCode()


    public
                    setLanguageCode(string $var) : $this

Generated from protobuf field string language_code = 3 [json_name = "languageCode"];

Parameters

$var : string

Return values

$this

setLocality()

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


    public
                    setLocality(string $var) : $this

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 [json_name = "locality"];

Parameters

$var : string

Return values

$this

setOrganization()

Optional. The name of the organization at the address.


    public
                    setOrganization(string $var) : $this

Generated from protobuf field string organization = 11 [json_name = "organization"];

Parameters

$var : string

Return values

$this

setPostalCode()


    public
                    setPostalCode(string $var) : $this

Generated from protobuf field string postal_code = 4 [json_name = "postalCode"];

Parameters

$var : string

Return values

$this

setRecipients()

Optional. The recipient at the address.


    public
                    setRecipients(array<string|int, string>|RepeatedField $var) : $this

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 [json_name = "recipients"];

Parameters

$var : array<string|int, string>|RepeatedField

Return values

$this

setRegionCode()


    public
                    setRegionCode(string $var) : $this

Generated from protobuf field string region_code = 2 [json_name = "regionCode"];

Parameters

$var : string

Return values

$this

setRevision()

The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision.


    public
                    setRevision(int $var) : $this

All new revisions must be backward compatible with old revisions.

Generated from protobuf field int32 revision = 1 [json_name = "revision"];

Parameters

$var : int

Return values

$this

setSortingCode()


    public
                    setSortingCode(string $var) : $this

Generated from protobuf field string sorting_code = 5 [json_name = "sortingCode"];

Parameters

$var : string

Return values

$this

setSublocality()

Optional. Sublocality of the address.


    public
                    setSublocality(string $var) : $this

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

Generated from protobuf field string sublocality = 8 [json_name = "sublocality"];

Parameters

$var : string

Return values

$this

PostalAddress extends Message in package Application

Table of Contents

Properties

Methods

Properties

$administrative_area

$language_code

$locality

$organization

$postal_code

$region_code

$revision

$sorting_code

$sublocality

$address_lines

$recipients

Methods

__construct()

Parameters

getAddressLines()

Return values

getAdministrativeArea()

Return values

getLanguageCode()

Return values

getLocality()

Return values

getOrganization()

Return values

getPostalCode()

Return values

getRecipients()

Return values

getRegionCode()

Return values

getRevision()

Return values

getSortingCode()

Return values

getSublocality()

Return values

setAddressLines()

Parameters

Return values

setAdministrativeArea()

Parameters

Return values

setLanguageCode()

Parameters

Return values

setLocality()

Parameters

Return values

setOrganization()

Parameters

Return values

setPostalCode()

Parameters

Return values

setRecipients()

Parameters

Return values

setRegionCode()

Parameters

Return values

setRevision()

Parameters

Return values

setSortingCode()

Parameters

Return values

setSublocality()

Parameters

Return values

PostalAddress extends Message
in package

Application