final case class PostalAddress(revision: Int = 0, regionCode: String = "", languageCode: String = "", postalCode: String = "", sortingCode: String = "", administrativeArea: String = "", locality: String = "", sublocality: String = "", addressLines: Seq[String] = _root_.scala.Seq.empty, recipients: Seq[String] = _root_.scala.Seq.empty, organization: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PostalAddress] with Product with Serializable

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

revision

The schema revision of the PostalAddress. All new revisions **must** be backward compatible with old revisions.

regionCode

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.

languageCode

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

postalCode

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

sortingCode

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

administrativeArea

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.

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.

sublocality

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

addressLines

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

recipients

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

organization

Optional. The name of the organization at the address.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[PostalAddress], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PostalAddress
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PostalAddress(revision: Int = 0, regionCode: String = "", languageCode: String = "", postalCode: String = "", sortingCode: String = "", administrativeArea: String = "", locality: String = "", sublocality: String = "", addressLines: Seq[String] = _root_.scala.Seq.empty, recipients: Seq[String] = _root_.scala.Seq.empty, organization: String = "", unknownFields: UnknownFieldSet = ...)

    revision

    The schema revision of the PostalAddress. All new revisions **must** be backward compatible with old revisions.

    regionCode

    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.

    languageCode

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

    postalCode

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

    sortingCode

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

    administrativeArea

    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.

    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.

    sublocality

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

    addressLines

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

    recipients

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

    organization

    Optional. The name of the organization at the address.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAddressLines(__vs: String*): PostalAddress
  5. def addAllAddressLines(__vs: Iterable[String]): PostalAddress
  6. def addAllRecipients(__vs: Iterable[String]): PostalAddress
  7. def addRecipients(__vs: String*): PostalAddress
  8. val addressLines: Seq[String]
  9. val administrativeArea: String
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clearAddressLines: PostalAddress
  12. def clearRecipients: PostalAddress
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. def companion: PostalAddress.type
    Definition Classes
    PostalAddress → GeneratedMessage
  15. def discardUnknownFields: PostalAddress
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PostalAddress → GeneratedMessage
  20. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PostalAddress → GeneratedMessage
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val languageCode: String
  23. val locality: String
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val organization: String
  28. val postalCode: String
  29. val recipients: Seq[String]
  30. val regionCode: String
  31. val revision: Int
  32. def serializedSize: Int
    Definition Classes
    PostalAddress → GeneratedMessage
  33. val sortingCode: String
  34. val sublocality: String
  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  37. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  38. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  39. def toProtoString: String
    Definition Classes
    PostalAddress → GeneratedMessage
  40. val unknownFields: UnknownFieldSet
  41. def update(ms: (Lens[PostalAddress, PostalAddress]) ⇒ Mutation[PostalAddress]*): PostalAddress
    Definition Classes
    Updatable
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  45. def withAddressLines(__v: Seq[String]): PostalAddress
  46. def withAdministrativeArea(__v: String): PostalAddress
  47. def withLanguageCode(__v: String): PostalAddress
  48. def withLocality(__v: String): PostalAddress
  49. def withOrganization(__v: String): PostalAddress
  50. def withPostalCode(__v: String): PostalAddress
  51. def withRecipients(__v: Seq[String]): PostalAddress
  52. def withRegionCode(__v: String): PostalAddress
  53. def withRevision(__v: Int): PostalAddress
  54. def withSortingCode(__v: String): PostalAddress
  55. def withSublocality(__v: String): PostalAddress
  56. def withUnknownFields(__v: UnknownFieldSet): PostalAddress
  57. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  58. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PostalAddress → GeneratedMessage
  59. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[PostalAddress]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped