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

View Source

A set of characteristics belonging to businesses, e.g. who compose an item's target audience.

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

Summary

Types

attrs()
t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "BusinessAudience", 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 BusinessAudience JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:number_of_employees) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:yearly_revenue) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:years_in_operation) => SEO.JSONLD.QuantitativeValue.t() | map(),
    optional(:audience_type) => String.t(),
    optional(:geographic_area) => SEO.JSONLD.AdministrativeArea.t() | map(),
    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()
  }
  | [
      number_of_employees: SEO.JSONLD.QuantitativeValue.t() | map(),
      yearly_revenue: SEO.JSONLD.QuantitativeValue.t() | map(),
      years_in_operation: SEO.JSONLD.QuantitativeValue.t() | map(),
      audience_type: String.t(),
      geographic_area: SEO.JSONLD.AdministrativeArea.t() | map(),
      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 "BusinessAudience", 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 BusinessAudience JSON-LD map.

Fields

  • :number_of_employees - The number of employees in an organization, e.g. business.
  • :yearly_revenue - The size of the business in annual revenue.
  • :years_in_operation - The age of the business.

Inherited properties

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