SEO.JSONLD.PostalAddress (SEO v0.3.0-rc.0)

View Source

The mailing address.

Helper for building a Schema.org PostalAddress JSON-LD structure.

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "PostalAddress", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a PostalAddress JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:address_country) => SEO.JSONLD.Country.t() | map() | String.t(),
    optional(:address_locality) => String.t(),
    optional(:address_region) =>
      String.t() | SEO.JSONLD.AdministrativeArea.t() | map(),
    optional(:extended_address) => String.t(),
    optional(:post_office_box_number) => String.t(),
    optional(:postal_code) => String.t(),
    optional(:street_address) => String.t(),
    optional(:area_served) =>
      SEO.JSONLD.GeoShape.t()
      | map()
      | SEO.JSONLD.AdministrativeArea.t()
      | SEO.JSONLD.Place.t()
      | String.t(),
    optional(:available_language) =>
      String.t() | SEO.JSONLD.Language.t() | map(),
    optional(:contact_option) => :hearing_impaired_supported | :toll_free,
    optional(:contact_type) => String.t(),
    optional(:email) => String.t(),
    optional(:fax_number) => String.t(),
    optional(:hours_available) =>
      SEO.JSONLD.OpeningHoursSpecification.t() | map(),
    optional(:product_supported) => String.t() | SEO.JSONLD.Product.t() | map(),
    optional(:service_area) =>
      SEO.JSONLD.GeoShape.t()
      | map()
      | SEO.JSONLD.AdministrativeArea.t()
      | SEO.JSONLD.Place.t(),
    optional(:telephone) => String.t(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      address_country: SEO.JSONLD.Country.t() | map() | String.t(),
      address_locality: String.t(),
      address_region: String.t() | SEO.JSONLD.AdministrativeArea.t() | map(),
      extended_address: String.t(),
      post_office_box_number: String.t(),
      postal_code: String.t(),
      street_address: String.t(),
      area_served:
        SEO.JSONLD.GeoShape.t()
        | map()
        | SEO.JSONLD.AdministrativeArea.t()
        | SEO.JSONLD.Place.t()
        | String.t(),
      available_language: String.t() | SEO.JSONLD.Language.t() | map(),
      contact_option: :hearing_impaired_supported | :toll_free,
      contact_type: String.t(),
      email: String.t(),
      fax_number: String.t(),
      hours_available: SEO.JSONLD.OpeningHoursSpecification.t() | map(),
      product_supported: String.t() | SEO.JSONLD.Product.t() | map(),
      service_area:
        SEO.JSONLD.GeoShape.t()
        | map()
        | SEO.JSONLD.AdministrativeArea.t()
        | SEO.JSONLD.Place.t(),
      telephone: String.t(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "PostalAddress", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a PostalAddress JSON-LD map.

Fields

  • :address_country - The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example "US". For backward compatibility, a 3-letter ISO 3166-1 alpha-3 country code such as "SGP" or a full country name such as "Singapore" can also be used.
  • :address_locality - The locality in which the street address is, and which is in the region. For example, Mountain View.
  • :address_region - The region in which the locality is, and which is in the country. For example, California or another appropriate first-level Administrative division such as the Province in Italy or Region in Germany.
  • :extended_address - An address extension such as an apartment number, C/O or alternative name.
  • :post_office_box_number - The post office box number for PO box addresses.
  • :postal_code - The postal code. For example, 94043.
  • :street_address - The street address. For example, 1600 Amphitheatre Pkwy.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: