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

View Source

The average rating based on multiple ratings or reviews.

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

Summary

Types

attrs()
t()

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

Types

attrs()

@type attrs() ::
  %{
    optional(:item_reviewed) => SEO.JSONLD.Thing.t() | map(),
    optional(:rating_count) => integer(),
    optional(:review_count) => integer(),
    optional(:author) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:best_rating) => String.t() | number(),
    optional(:rating_explanation) => String.t(),
    optional(:rating_value) => String.t() | number(),
    optional(:review_aspect) =>
      SEO.JSONLD.StructuredValue.t() | map() | String.t(),
    optional(:worst_rating) => String.t() | number(),
    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()
  }
  | [
      item_reviewed: SEO.JSONLD.Thing.t() | map(),
      rating_count: integer(),
      review_count: integer(),
      author: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      best_rating: String.t() | number(),
      rating_explanation: String.t(),
      rating_value: String.t() | number(),
      review_aspect: SEO.JSONLD.StructuredValue.t() | map() | String.t(),
      worst_rating: String.t() | number(),
      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 "AggregateRating", 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 AggregateRating JSON-LD map.

Fields

  • :item_reviewed - The item that is being reviewed/rated.
  • :rating_count - The count of total number of ratings.
  • :review_count - The count of total number of reviews.

Inherited properties

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