View Source GoogleApi.People.V1.Model.Address (google_api_people v0.40.3)

A person's physical address. May be a P.O. box or street address. All fields are optional.


  • city (type: String.t, default: nil) - The city of the address.
  • country (type: String.t, default: nil) - The country of the address.
  • countryCode (type: String.t, default: nil) - The ISO 3166-1 alpha-2 country code of the address.
  • extendedAddress (type: String.t, default: nil) - The extended address of the address; for example, the apartment number.
  • formattedType (type: String.t, default: nil) - Output only. The type of the address translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale.
  • formattedValue (type: String.t, default: nil) - The unstructured value of the address. If this is not set by the user it will be automatically constructed from structured values.
  • metadata (type: GoogleApi.People.V1.Model.FieldMetadata.t, default: nil) - Metadata about the address.
  • poBox (type: String.t, default: nil) - The P.O. box of the address.
  • postalCode (type: String.t, default: nil) - The postal code of the address.
  • region (type: String.t, default: nil) - The region of the address; for example, the state or province.
  • streetAddress (type: String.t, default: nil) - The street address.
  • type (type: String.t, default: nil) - The type of the address. The type can be custom or one of these predefined values: home work * other

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.People.V1.Model.Address{
  city: String.t() | nil,
  country: String.t() | nil,
  countryCode: String.t() | nil,
  extendedAddress: String.t() | nil,
  formattedType: String.t() | nil,
  formattedValue: String.t() | nil,
  metadata: GoogleApi.People.V1.Model.FieldMetadata.t() | nil,
  poBox: String.t() | nil,
  postalCode: String.t() | nil,
  region: String.t() | nil,
  streetAddress: String.t() | nil,
  type: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.