Module: SchemaOrg::Mixins::Product

Includes:

Thing

Included in:

DietarySupplement, Drug, IndividualProduct, ProductCollection, ProductGroup, ProductModel, SomeProducts, Vehicle, Product

Defined in:

lib/schema_org/mixins/product.rb

Class Method Summary

• .schema_property_definitions ⇒ Object

Instance Method Summary

• #additional_property ⇒ Object

  A property-value pair representing an additional characteristic of the entity, e.g.

• #additional_property=(value) ⇒ Object

  A property-value pair representing an additional characteristic of the entity, e.g.

• #aggregate_rating ⇒ Object

  The overall rating, based on a collection of reviews or ratings, of the item.

• #aggregate_rating=(value) ⇒ Object

  The overall rating, based on a collection of reviews or ratings, of the item.

• #asin ⇒ Object

  An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article).

• #asin=(value) ⇒ Object

  An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article).

• #audience ⇒ Object

  An intended audience, i.e.

• #audience=(value) ⇒ Object

  An intended audience, i.e.

• #award ⇒ Object

  An award won by or for this item.

• #award=(value) ⇒ Object

  An award won by or for this item.

• #awards ⇒ Object

  Awards won by or for this item.

• #awards=(value) ⇒ Object

  Awards won by or for this item.

• #brand ⇒ Object

  The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

• #brand=(value) ⇒ Object

  The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

• #category ⇒ Object

  A category for the item.

• #category=(value) ⇒ Object

  A category for the item.

• #color ⇒ Object

  The color of the product.

• #color=(value) ⇒ Object

  The color of the product.

• #color_swatch ⇒ Object

  A color swatch image, visualizing the color of a [[Product]].

• #color_swatch=(value) ⇒ Object

  A color swatch image, visualizing the color of a [[Product]].

• #country_of_assembly ⇒ Object

  The place where the product was assembled.

• #country_of_assembly=(value) ⇒ Object

  The place where the product was assembled.

• #country_of_last_processing ⇒ Object

  The place where the item (typically [[Product]]) was last processed and tested before importation.

• #country_of_last_processing=(value) ⇒ Object

  The place where the item (typically [[Product]]) was last processed and tested before importation.

• #country_of_origin ⇒ Object

  The country of origin of something, including products as well as creative works such as movie and TV content.

• #country_of_origin=(value) ⇒ Object

  The country of origin of something, including products as well as creative works such as movie and TV content.

• #depth ⇒ Object

  The depth of the item.

• #depth=(value) ⇒ Object

  The depth of the item.

• #display_location ⇒ Object

  The location at which an item can be viewed or experienced in-person.

• #display_location=(value) ⇒ Object

  The location at which an item can be viewed or experienced in-person.

• #funding ⇒ Object

  A [[Grant]] that directly or indirectly provide funding or sponsorship for this item.

• #funding=(value) ⇒ Object

  A [[Grant]] that directly or indirectly provide funding or sponsorship for this item.

• #gtin ⇒ Object

  A Global Trade Item Number (GTIN).

• #gtin12 ⇒ Object

  The GTIN-12 code of the product, or the product to which the offer refers.

• #gtin12=(value) ⇒ Object

  The GTIN-12 code of the product, or the product to which the offer refers.

• #gtin13 ⇒ Object

  The GTIN-13 code of the product, or the product to which the offer refers.

• #gtin13=(value) ⇒ Object

  The GTIN-13 code of the product, or the product to which the offer refers.

• #gtin14 ⇒ Object

  The GTIN-14 code of the product, or the product to which the offer refers.

• #gtin14=(value) ⇒ Object

  The GTIN-14 code of the product, or the product to which the offer refers.

• #gtin8 ⇒ Object

  The GTIN-8 code of the product, or the product to which the offer refers.

• #gtin8=(value) ⇒ Object

  The GTIN-8 code of the product, or the product to which the offer refers.

• #gtin=(value) ⇒ Object

  A Global Trade Item Number (GTIN).

• #has_adult_consideration ⇒ Object

  Used to tag an item to be intended or suitable for consumption or use by adults only.

• #has_adult_consideration=(value) ⇒ Object

  Used to tag an item to be intended or suitable for consumption or use by adults only.

• #has_certification ⇒ Object

  Certification information about a product, organization, service, place, or person.

• #has_certification=(value) ⇒ Object

  Certification information about a product, organization, service, place, or person.

• #has_energy_consumption_details ⇒ Object

  Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.

• #has_energy_consumption_details=(value) ⇒ Object

  Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.

• #has_gs1_digital_link ⇒ Object

  The GS1 digital link associated with the object.

• #has_gs1_digital_link=(value) ⇒ Object

  The GS1 digital link associated with the object.

• #has_measurement ⇒ Object

  A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority.

• #has_measurement=(value) ⇒ Object

  A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority.

• #has_merchant_return_policy ⇒ Object

  Specifies a MerchantReturnPolicy that may be applicable.

• #has_merchant_return_policy=(value) ⇒ Object

  Specifies a MerchantReturnPolicy that may be applicable.

• #has_product_return_policy ⇒ Object

  Indicates a ProductReturnPolicy that may be applicable.

• #has_product_return_policy=(value) ⇒ Object

  Indicates a ProductReturnPolicy that may be applicable.

• #height ⇒ Object

  The height of the item.

• #height=(value) ⇒ Object

  The height of the item.

• #in_product_group_with_id ⇒ Object

  Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].

• #in_product_group_with_id=(value) ⇒ Object

  Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].

• #is_accessory_or_spare_part_for ⇒ Object

  A pointer to another product (or multiple products) for which this product is an accessory or spare part.

• #is_accessory_or_spare_part_for=(value) ⇒ Object

  A pointer to another product (or multiple products) for which this product is an accessory or spare part.

• #is_consumable_for ⇒ Object

  A pointer to another product (or multiple products) for which this product is a consumable.

• #is_consumable_for=(value) ⇒ Object

  A pointer to another product (or multiple products) for which this product is a consumable.

• #is_family_friendly ⇒ Object

  Indicates whether this content is family friendly.

• #is_family_friendly=(value) ⇒ Object

  Indicates whether this content is family friendly.

• #is_related_to ⇒ Object

  A pointer to another, somehow related product (or multiple products).

• #is_related_to=(value) ⇒ Object

  A pointer to another, somehow related product (or multiple products).

• #is_similar_to ⇒ Object

  A pointer to another, functionally similar product (or multiple products).

• #is_similar_to=(value) ⇒ Object

  A pointer to another, functionally similar product (or multiple products).

• #is_variant_of ⇒ Object

  Indicates the kind of product that this is a variant of.

• #is_variant_of=(value) ⇒ Object

  Indicates the kind of product that this is a variant of.

• #item_condition ⇒ Object

  A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer.

• #item_condition=(value) ⇒ Object

  A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer.

• #keywords ⇒ Object

  Keywords or tags used to describe some item.

• #keywords=(value) ⇒ Object

  Keywords or tags used to describe some item.

• #logo ⇒ Object

  An associated logo.

• #logo=(value) ⇒ Object

  An associated logo.

• #manufacturer ⇒ Object

  The manufacturer of the product.

• #manufacturer=(value) ⇒ Object

  The manufacturer of the product.

• #material ⇒ Object

  A material that something is made from, e.g.

• #material=(value) ⇒ Object

  A material that something is made from, e.g.

• #mobile_url ⇒ Object

  The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.

• #mobile_url=(value) ⇒ Object

  The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.

• #model ⇒ Object

  The model of the product.

• #model=(value) ⇒ Object

  The model of the product.

• #mpn ⇒ Object

  The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.

• #mpn=(value) ⇒ Object

  The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.

• #negative_notes ⇒ Object

  Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]).

• #negative_notes=(value) ⇒ Object

  Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]).

• #nsn ⇒ Object

  Indicates the NATO stock number (nsn) of a [[Product]].

• #nsn=(value) ⇒ Object

  Indicates the NATO stock number (nsn) of a [[Product]].

• #offers ⇒ Object

  An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event.

• #offers=(value) ⇒ Object

  An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event.

• #pattern ⇒ Object

  A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'.

• #pattern=(value) ⇒ Object

  A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'.

• #positive_notes ⇒ Object

  Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.

• #positive_notes=(value) ⇒ Object

  Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.

• #product_id ⇒ Object

  The product identifier, such as ISBN.

• #product_id=(value) ⇒ Object

  The product identifier, such as ISBN.

• #production_date ⇒ Object

  The date of production of the item, e.g.

• #production_date=(value) ⇒ Object

  The date of production of the item, e.g.

• #purchase_date ⇒ Object

  The date the item, e.g.

• #purchase_date=(value) ⇒ Object

  The date the item, e.g.

• #release_date ⇒ Object

  The release date of a product or product model.

• #release_date=(value) ⇒ Object

  The release date of a product or product model.

• #review ⇒ Object

  A review of the item.

• #review=(value) ⇒ Object

  A review of the item.

• #reviews ⇒ Object

  Review of the item.

• #reviews=(value) ⇒ Object

  Review of the item.

• #size ⇒ Object

  A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.

• #size=(value) ⇒ Object

  A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.

• #sku ⇒ Object

  The Stock Keeping Unit (SKU), i.e.

• #sku=(value) ⇒ Object

  The Stock Keeping Unit (SKU), i.e.

• #slogan ⇒ Object

  A slogan or motto associated with the item.

• #slogan=(value) ⇒ Object

  A slogan or motto associated with the item.

• #weight ⇒ Object

  The weight of the product or person.

• #weight=(value) ⇒ Object

  The weight of the product or person.

• #width ⇒ Object

  The width of the item.

• #width=(value) ⇒ Object

  The width of the item.

Methods included from Thing

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, #subject_of, #subject_of=, #url, #url=

Class Method Details

.schema_property_definitions ⇒ Object

# File 'lib/schema_org/mixins/product.rb', line 11

def self.schema_property_definitions
  {
    additional_property: {
      schema_name: "additionalProperty",
      schema_url: "https://schema.org/additionalProperty",
      comment_lines: ["A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\\n\\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism."].freeze,
      ranges: ["PropertyValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    aggregate_rating: {
      schema_name: "aggregateRating",
      schema_url: "https://schema.org/aggregateRating",
      comment_lines: ["The overall rating, based on a collection of reviews or ratings, of the item."].freeze,
      ranges: ["AggregateRating"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    asin: {
      schema_name: "asin",
      schema_url: "https://schema.org/asin",
      comment_lines: ["An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).", "", "Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.", "ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too."].freeze,
      ranges: ["Text", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    audience: {
      schema_name: "audience",
      schema_url: "https://schema.org/audience",
      comment_lines: ["An intended audience, i.e. a group for whom something was created."].freeze,
      ranges: ["Audience"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["serviceAudience"].freeze
    }.freeze,
    award: {
      schema_name: "award",
      schema_url: "https://schema.org/award",
      comment_lines: ["An award won by or for this item."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["awards"].freeze
    }.freeze,
    awards: {
      schema_name: "awards",
      schema_url: "https://schema.org/awards",
      comment_lines: ["Awards won by or for this item."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: "award",
      supersedes: nil
    }.freeze,
    brand: {
      schema_name: "brand",
      schema_url: "https://schema.org/brand",
      comment_lines: ["The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person."].freeze,
      ranges: ["Brand", "Organization"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    category: {
      schema_name: "category",
      schema_url: "https://schema.org/category",
      comment_lines: ["A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy."].freeze,
      ranges: ["CategoryCode", "PhysicalActivityCategory", "Text", "Thing", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    color: {
      schema_name: "color",
      schema_url: "https://schema.org/color",
      comment_lines: ["The color of the product."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    color_swatch: {
      schema_name: "colorSwatch",
      schema_url: "https://schema.org/colorSwatch",
      comment_lines: ["A color swatch image, visualizing the color of a [[Product]]. Should match the textual description specified in the [[color]] property. This can be a URL or a fully described ImageObject."].freeze,
      ranges: ["ImageObject", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    country_of_assembly: {
      schema_name: "countryOfAssembly",
      schema_url: "https://schema.org/countryOfAssembly",
      comment_lines: ["The place where the product was assembled."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    country_of_last_processing: {
      schema_name: "countryOfLastProcessing",
      schema_url: "https://schema.org/countryOfLastProcessing",
      comment_lines: ["The place where the item (typically [[Product]]) was last processed and tested before importation."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    country_of_origin: {
      schema_name: "countryOfOrigin",
      schema_url: "https://schema.org/countryOfOrigin",
      comment_lines: ["The country of origin of something, including products as well as creative  works such as movie and TV content.", "", "In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.", "", "In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here."].freeze,
      ranges: ["Country"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    depth: {
      schema_name: "depth",
      schema_url: "https://schema.org/depth",
      comment_lines: ["The depth of the item."].freeze,
      ranges: ["Distance", "QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    display_location: {
      schema_name: "displayLocation",
      schema_url: "https://schema.org/displayLocation",
      comment_lines: ["The location at which an item can be viewed or experienced in-person."].freeze,
      ranges: ["Place"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    funding: {
      schema_name: "funding",
      schema_url: "https://schema.org/funding",
      comment_lines: ["A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]."].freeze,
      ranges: ["Grant"].freeze,
      external_ranges: [].freeze,
      inverse_of: "fundedItem",
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin: {
      schema_name: "gtin",
      schema_url: "https://schema.org/gtin",
      comment_lines: ["A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.", "", "A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a \"GS1 Digital Link\" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.", "", "The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) expresses GTINs as URLs (URIs, IRIs, etc.).", "Digital Links should be populated into the [[hasGS1DigitalLink]] attribute.", "", "Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details."].freeze,
      ranges: ["Text", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin12: {
      schema_name: "gtin12",
      schema_url: "https://schema.org/gtin12",
      comment_lines: ["The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin13: {
      schema_name: "gtin13",
      schema_url: "https://schema.org/gtin13",
      comment_lines: ["The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin14: {
      schema_name: "gtin14",
      schema_url: "https://schema.org/gtin14",
      comment_lines: ["The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    gtin8: {
      schema_name: "gtin8",
      schema_url: "https://schema.org/gtin8",
      comment_lines: ["The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_adult_consideration: {
      schema_name: "hasAdultConsideration",
      schema_url: "https://schema.org/hasAdultConsideration",
      comment_lines: ["Used to tag an item to be intended or suitable for consumption or use by adults only."].freeze,
      ranges: ["AdultOrientedEnumeration"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_certification: {
      schema_name: "hasCertification",
      schema_url: "https://schema.org/hasCertification",
      comment_lines: ["Certification information about a product, organization, service, place, or person."].freeze,
      ranges: ["Certification"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_energy_consumption_details: {
      schema_name: "hasEnergyConsumptionDetails",
      schema_url: "https://schema.org/hasEnergyConsumptionDetails",
      comment_lines: ["Defines the energy efficiency Category (also known as \"class\" or \"rating\") for a product according to an international energy efficiency standard."].freeze,
      ranges: ["EnergyConsumptionDetails"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_gs1_digital_link: {
      schema_name: "hasGS1DigitalLink",
      schema_url: "https://schema.org/hasGS1DigitalLink",
      comment_lines: ["The <a href=\"https://www.gs1.org/standards/gs1-digital-link\">GS1 digital link</a> associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a [[Product]] or an [[Organization]], and for the correct granularity. In particular, for products:<ul><li>A Digital Link that contains a serial number (AI <code>21</code>) should only be present on instances of [[IndividualProduct]]</li><li>A Digital Link that contains a lot number (AI <code>10</code>) should be annotated as [[SomeProducts]] if only products from that lot are sold, or [[IndividualProduct]] if there is only a specific product.</li><li>A Digital Link that contains a global model number (AI <code>8013</code>) should be attached to a [[Product]] or a [[ProductModel]].</li></ul> Other item types should be adapted similarly."].freeze,
      ranges: ["URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_measurement: {
      schema_name: "hasMeasurement",
      schema_url: "https://schema.org/hasMeasurement",
      comment_lines: ["A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings."].freeze,
      ranges: ["QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    has_merchant_return_policy: {
      schema_name: "hasMerchantReturnPolicy",
      schema_url: "https://schema.org/hasMerchantReturnPolicy",
      comment_lines: ["Specifies a MerchantReturnPolicy that may be applicable."].freeze,
      ranges: ["MerchantReturnPolicy"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["hasProductReturnPolicy"].freeze
    }.freeze,
    has_product_return_policy: {
      schema_name: "hasProductReturnPolicy",
      schema_url: "https://schema.org/hasProductReturnPolicy",
      comment_lines: ["Indicates a ProductReturnPolicy that may be applicable."].freeze,
      ranges: ["ProductReturnPolicy"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: "hasMerchantReturnPolicy",
      supersedes: nil
    }.freeze,
    height: {
      schema_name: "height",
      schema_url: "https://schema.org/height",
      comment_lines: ["The height of the item."].freeze,
      ranges: ["Distance", "QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    in_product_group_with_id: {
      schema_name: "inProductGroupWithID",
      schema_url: "https://schema.org/inProductGroupWithID",
      comment_lines: ["Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]]."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    is_accessory_or_spare_part_for: {
      schema_name: "isAccessoryOrSparePartFor",
      schema_url: "https://schema.org/isAccessoryOrSparePartFor",
      comment_lines: ["A pointer to another product (or multiple products) for which this product is an accessory or spare part."].freeze,
      ranges: ["Product"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    is_consumable_for: {
      schema_name: "isConsumableFor",
      schema_url: "https://schema.org/isConsumableFor",
      comment_lines: ["A pointer to another product (or multiple products) for which this product is a consumable."].freeze,
      ranges: ["Product"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    is_family_friendly: {
      schema_name: "isFamilyFriendly",
      schema_url: "https://schema.org/isFamilyFriendly",
      comment_lines: ["Indicates whether this content is family friendly."].freeze,
      ranges: ["Boolean"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    is_related_to: {
      schema_name: "isRelatedTo",
      schema_url: "https://schema.org/isRelatedTo",
      comment_lines: ["A pointer to another, somehow related product (or multiple products)."].freeze,
      ranges: ["Product", "Service"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    is_similar_to: {
      schema_name: "isSimilarTo",
      schema_url: "https://schema.org/isSimilarTo",
      comment_lines: ["A pointer to another, functionally similar product (or multiple products)."].freeze,
      ranges: ["Product", "Service"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    is_variant_of: {
      schema_name: "isVariantOf",
      schema_url: "https://schema.org/isVariantOf",
      comment_lines: ["Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group."].freeze,
      ranges: ["ProductGroup", "ProductModel"].freeze,
      external_ranges: [].freeze,
      inverse_of: "hasVariant",
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    item_condition: {
      schema_name: "itemCondition",
      schema_url: "https://schema.org/itemCondition",
      comment_lines: ["A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns."].freeze,
      ranges: ["OfferItemCondition"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    keywords: {
      schema_name: "keywords",
      schema_url: "https://schema.org/keywords",
      comment_lines: ["Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property."].freeze,
      ranges: ["DefinedTerm", "Text", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    logo: {
      schema_name: "logo",
      schema_url: "https://schema.org/logo",
      comment_lines: ["An associated logo."].freeze,
      ranges: ["ImageObject", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    manufacturer: {
      schema_name: "manufacturer",
      schema_url: "https://schema.org/manufacturer",
      comment_lines: ["The manufacturer of the product."].freeze,
      ranges: ["Organization"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    material: {
      schema_name: "material",
      schema_url: "https://schema.org/material",
      comment_lines: ["A material that something is made from, e.g. leather, wool, cotton, paper."].freeze,
      ranges: ["Product", "Text", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    mobile_url: {
      schema_name: "mobileUrl",
      schema_url: "https://schema.org/mobileUrl",
      comment_lines: ["The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.", "", "To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional \"mobile site\" alongside the main one. It should not be taken as an endorsement of this publication style."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    model: {
      schema_name: "model",
      schema_url: "https://schema.org/model",
      comment_lines: ["The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties."].freeze,
      ranges: ["ProductModel", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    mpn: {
      schema_name: "mpn",
      schema_url: "https://schema.org/mpn",
      comment_lines: ["The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    negative_notes: {
      schema_name: "negativeNotes",
      schema_url: "https://schema.org/negativeNotes",
      comment_lines: ["Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry", "", "In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions", "tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].", "", "The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list)."].freeze,
      ranges: ["ItemList", "ListItem", "Text", "WebContent"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    nsn: {
      schema_name: "nsn",
      schema_url: "https://schema.org/nsn",
      comment_lines: ["Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]]."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    offers: {
      schema_name: "offers",
      schema_url: "https://schema.org/offers",
      comment_lines: ["An offer to provide this item&#x2014;for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer."].freeze,
      ranges: ["Demand", "Offer"].freeze,
      external_ranges: [].freeze,
      inverse_of: "itemOffered",
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    pattern: {
      schema_name: "pattern",
      schema_url: "https://schema.org/pattern",
      comment_lines: ["A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported."].freeze,
      ranges: ["DefinedTerm", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    positive_notes: {
      schema_name: "positiveNotes",
      schema_url: "https://schema.org/positiveNotes",
      comment_lines: ["Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.", "", "In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.", "", "The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list)."].freeze,
      ranges: ["ItemList", "ListItem", "Text", "WebContent"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    product_id: {
      schema_name: "productID",
      schema_url: "https://schema.org/productID",
      comment_lines: ["The product identifier, such as ISBN. For example: ``` meta itemprop=\"productID\" content=\"isbn:123-456-789\" ```."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    production_date: {
      schema_name: "productionDate",
      schema_url: "https://schema.org/productionDate",
      comment_lines: ["The date of production of the item, e.g. vehicle."].freeze,
      ranges: ["Date"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    purchase_date: {
      schema_name: "purchaseDate",
      schema_url: "https://schema.org/purchaseDate",
      comment_lines: ["The date the item, e.g. vehicle, was purchased by the current owner."].freeze,
      ranges: ["Date"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    release_date: {
      schema_name: "releaseDate",
      schema_url: "https://schema.org/releaseDate",
      comment_lines: ["The release date of a product or product model. This can be used to distinguish the exact variant of a product."].freeze,
      ranges: ["Date"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    review: {
      schema_name: "review",
      schema_url: "https://schema.org/review",
      comment_lines: ["A review of the item."].freeze,
      ranges: ["Review"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: ["reviews"].freeze
    }.freeze,
    reviews: {
      schema_name: "reviews",
      schema_url: "https://schema.org/reviews",
      comment_lines: ["Review of the item."].freeze,
      ranges: ["Review"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: "review",
      supersedes: nil
    }.freeze,
    size: {
      schema_name: "size",
      schema_url: "https://schema.org/size",
      comment_lines: ["A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a  QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable."].freeze,
      ranges: ["DefinedTerm", "QuantitativeValue", "SizeSpecification", "Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    sku: {
      schema_name: "sku",
      schema_url: "https://schema.org/sku",
      comment_lines: ["The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    slogan: {
      schema_name: "slogan",
      schema_url: "https://schema.org/slogan",
      comment_lines: ["A slogan or motto associated with the item."].freeze,
      ranges: ["Text"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    weight: {
      schema_name: "weight",
      schema_url: "https://schema.org/weight",
      comment_lines: ["The weight of the product or person."].freeze,
      ranges: ["Mass", "QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze,
    width: {
      schema_name: "width",
      schema_url: "https://schema.org/width",
      comment_lines: ["The width of the item."].freeze,
      ranges: ["Distance", "QuantitativeValue"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze
  }.freeze
end

Instance Method Details

#additional_property ⇒ Object

A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\n\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.

# File 'lib/schema_org/mixins/product.rb', line 617

def additional_property
  read_property(:additional_property)
end

#additional_property=(value) ⇒ Object

A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\n\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.

# File 'lib/schema_org/mixins/product.rb', line 622

def additional_property=(value)
  write_property(:additional_property, value)
end

#aggregate_rating ⇒ Object

The overall rating, based on a collection of reviews or ratings, of the item.

# File 'lib/schema_org/mixins/product.rb', line 627

def aggregate_rating
  read_property(:aggregate_rating)
end

#aggregate_rating=(value) ⇒ Object

The overall rating, based on a collection of reviews or ratings, of the item.

# File 'lib/schema_org/mixins/product.rb', line 632

def aggregate_rating=(value)
  write_property(:aggregate_rating, value)
end

#asin ⇒ Object

An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article).

Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.

# File 'lib/schema_org/mixins/product.rb', line 640

def asin
  read_property(:asin)
end

#asin=(value) ⇒ Object

An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article).

Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.

# File 'lib/schema_org/mixins/product.rb', line 648

def asin=(value)
  write_property(:asin, value)
end

#audience ⇒ Object

An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.

# File 'lib/schema_org/mixins/product.rb', line 654

def audience
  read_property(:audience)
end

#audience=(value) ⇒ Object

An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.

# File 'lib/schema_org/mixins/product.rb', line 660

def audience=(value)
  write_property(:audience, value)
end

#award ⇒ Object

An award won by or for this item. Supersedes awards.

# File 'lib/schema_org/mixins/product.rb', line 666

def award
  read_property(:award)
end

#award=(value) ⇒ Object

An award won by or for this item. Supersedes awards.

# File 'lib/schema_org/mixins/product.rb', line 672

def award=(value)
  write_property(:award, value)
end

#awards ⇒ Object

Awards won by or for this item. Superseded by award.

# File 'lib/schema_org/mixins/product.rb', line 678

def awards
  read_property(:awards)
end

#awards=(value) ⇒ Object

Awards won by or for this item. Superseded by award.

# File 'lib/schema_org/mixins/product.rb', line 684

def awards=(value)
  write_property(:awards, value)
end

#brand ⇒ Object

The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

# File 'lib/schema_org/mixins/product.rb', line 689

def brand
  read_property(:brand)
end

#brand=(value) ⇒ Object

The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

# File 'lib/schema_org/mixins/product.rb', line 694

def brand=(value)
  write_property(:brand, value)
end

#category ⇒ Object

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

# File 'lib/schema_org/mixins/product.rb', line 699

def category
  read_property(:category)
end

#category=(value) ⇒ Object

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

# File 'lib/schema_org/mixins/product.rb', line 704

def category=(value)
  write_property(:category, value)
end

#color ⇒ Object

The color of the product.

# File 'lib/schema_org/mixins/product.rb', line 709

def color
  read_property(:color)
end

#color=(value) ⇒ Object

The color of the product.

# File 'lib/schema_org/mixins/product.rb', line 714

def color=(value)
  write_property(:color, value)
end

#color_swatch ⇒ Object

A color swatch image, visualizing the color of a [[Product]]. Should match the textual description specified in the [[color]] property. This can be a URL or a fully described ImageObject.

# File 'lib/schema_org/mixins/product.rb', line 719

def color_swatch
  read_property(:color_swatch)
end

#color_swatch=(value) ⇒ Object

A color swatch image, visualizing the color of a [[Product]]. Should match the textual description specified in the [[color]] property. This can be a URL or a fully described ImageObject.

# File 'lib/schema_org/mixins/product.rb', line 724

def color_swatch=(value)
  write_property(:color_swatch, value)
end

#country_of_assembly ⇒ Object

The place where the product was assembled.

# File 'lib/schema_org/mixins/product.rb', line 729

def country_of_assembly
  read_property(:country_of_assembly)
end

#country_of_assembly=(value) ⇒ Object

The place where the product was assembled.

# File 'lib/schema_org/mixins/product.rb', line 734

def country_of_assembly=(value)
  write_property(:country_of_assembly, value)
end

#country_of_last_processing ⇒ Object

The place where the item (typically [[Product]]) was last processed and tested before importation.

# File 'lib/schema_org/mixins/product.rb', line 739

def country_of_last_processing
  read_property(:country_of_last_processing)
end

#country_of_last_processing=(value) ⇒ Object

The place where the item (typically [[Product]]) was last processed and tested before importation.

# File 'lib/schema_org/mixins/product.rb', line 744

def country_of_last_processing=(value)
  write_property(:country_of_last_processing, value)
end

#country_of_origin ⇒ Object

The country of origin of something, including products as well as creative works such as movie and TV content.

In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.

In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.

# File 'lib/schema_org/mixins/product.rb', line 753

def country_of_origin
  read_property(:country_of_origin)
end

#country_of_origin=(value) ⇒ Object

The country of origin of something, including products as well as creative works such as movie and TV content.

In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.

In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.

# File 'lib/schema_org/mixins/product.rb', line 762

def country_of_origin=(value)
  write_property(:country_of_origin, value)
end

#depth ⇒ Object

The depth of the item.

# File 'lib/schema_org/mixins/product.rb', line 767

def depth
  read_property(:depth)
end

#depth=(value) ⇒ Object

The depth of the item.

# File 'lib/schema_org/mixins/product.rb', line 772

def depth=(value)
  write_property(:depth, value)
end

#display_location ⇒ Object

The location at which an item can be viewed or experienced in-person.

# File 'lib/schema_org/mixins/product.rb', line 777

def display_location
  read_property(:display_location)
end

#display_location=(value) ⇒ Object

The location at which an item can be viewed or experienced in-person.

# File 'lib/schema_org/mixins/product.rb', line 782

def display_location=(value)
  write_property(:display_location, value)
end

#funding ⇒ Object

A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. Inverse-property: fundedItem.

# File 'lib/schema_org/mixins/product.rb', line 788

def funding
  read_property(:funding)
end

#funding=(value) ⇒ Object

A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. Inverse-property: fundedItem.

# File 'lib/schema_org/mixins/product.rb', line 794

def funding=(value)
  write_property(:funding, value)
end

#gtin ⇒ Object

A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.

A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a valid GS1 check digit and meet the other rules for valid GTINs. See also GS1's GTIN Summary and Wikipedia for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.

The GS1 digital link specifications expresses GTINs as URLs (URIs, IRIs, etc.). Digital Links should be populated into the [[hasGS1DigitalLink]] attribute.

Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.

# File 'lib/schema_org/mixins/product.rb', line 806

def gtin
  read_property(:gtin)
end

#gtin12 ⇒ Object

The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 823

def gtin12
  read_property(:gtin12)
end

#gtin12=(value) ⇒ Object

The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 828

def gtin12=(value)
  write_property(:gtin12, value)
end

#gtin13 ⇒ Object

The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 833

def gtin13
  read_property(:gtin13)
end

#gtin13=(value) ⇒ Object

The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 838

def gtin13=(value)
  write_property(:gtin13, value)
end

#gtin14 ⇒ Object

The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 843

def gtin14
  read_property(:gtin14)
end

#gtin14=(value) ⇒ Object

The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 848

def gtin14=(value)
  write_property(:gtin14, value)
end

#gtin8 ⇒ Object

The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 853

def gtin8
  read_property(:gtin8)
end

#gtin8=(value) ⇒ Object

The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details.

# File 'lib/schema_org/mixins/product.rb', line 858

def gtin8=(value)
  write_property(:gtin8, value)
end

#gtin=(value) ⇒ Object

A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.

A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a valid GS1 check digit and meet the other rules for valid GTINs. See also GS1's GTIN Summary and Wikipedia for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.

The GS1 digital link specifications expresses GTINs as URLs (URIs, IRIs, etc.). Digital Links should be populated into the [[hasGS1DigitalLink]] attribute.

Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.

# File 'lib/schema_org/mixins/product.rb', line 818

def gtin=(value)
  write_property(:gtin, value)
end

#has_adult_consideration ⇒ Object

Used to tag an item to be intended or suitable for consumption or use by adults only.

# File 'lib/schema_org/mixins/product.rb', line 863

def has_adult_consideration
  read_property(:has_adult_consideration)
end

#has_adult_consideration=(value) ⇒ Object

Used to tag an item to be intended or suitable for consumption or use by adults only.

# File 'lib/schema_org/mixins/product.rb', line 868

def has_adult_consideration=(value)
  write_property(:has_adult_consideration, value)
end

#has_certification ⇒ Object

Certification information about a product, organization, service, place, or person.

# File 'lib/schema_org/mixins/product.rb', line 873

def has_certification
  read_property(:has_certification)
end

#has_certification=(value) ⇒ Object

Certification information about a product, organization, service, place, or person.

# File 'lib/schema_org/mixins/product.rb', line 878

def has_certification=(value)
  write_property(:has_certification, value)
end

#has_energy_consumption_details ⇒ Object

Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.

# File 'lib/schema_org/mixins/product.rb', line 883

def has_energy_consumption_details
  read_property(:has_energy_consumption_details)
end

#has_energy_consumption_details=(value) ⇒ Object

Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.

# File 'lib/schema_org/mixins/product.rb', line 888

def has_energy_consumption_details=(value)
  write_property(:has_energy_consumption_details, value)
end

#has_gs1_digital_link ⇒ Object

The GS1 digital link associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a [[Product]] or an [[Organization]], and for the correct granularity. In particular, for products:

• A Digital Link that contains a serial number (AI 21) should only be present on instances of [[IndividualProduct]]
• A Digital Link that contains a lot number (AI 10) should be annotated as [[SomeProducts]] if only products from that lot are sold, or [[IndividualProduct]] if there is only a specific product.
• A Digital Link that contains a global model number (AI 8013) should be attached to a [[Product]] or a [[ProductModel]].

Other item types should be adapted similarly.

# File 'lib/schema_org/mixins/product.rb', line 893

def has_gs1_digital_link
  read_property(:has_gs1_digital_link)
end

#has_gs1_digital_link=(value) ⇒ Object

The GS1 digital link associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a [[Product]] or an [[Organization]], and for the correct granularity. In particular, for products:

• A Digital Link that contains a serial number (AI 21) should only be present on instances of [[IndividualProduct]]
• A Digital Link that contains a lot number (AI 10) should be annotated as [[SomeProducts]] if only products from that lot are sold, or [[IndividualProduct]] if there is only a specific product.
• A Digital Link that contains a global model number (AI 8013) should be attached to a [[Product]] or a [[ProductModel]].

Other item types should be adapted similarly.

# File 'lib/schema_org/mixins/product.rb', line 898

def has_gs1_digital_link=(value)
  write_property(:has_gs1_digital_link, value)
end

#has_measurement ⇒ Object

A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.

# File 'lib/schema_org/mixins/product.rb', line 903

def has_measurement
  read_property(:has_measurement)
end

#has_measurement=(value) ⇒ Object

A measurement of an item, For example, the inseam of pants, the wheel size of a bicycle, the gauge of a screw, or the carbon footprint measured for certification by an authority. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.

# File 'lib/schema_org/mixins/product.rb', line 908

def has_measurement=(value)
  write_property(:has_measurement, value)
end

#has_merchant_return_policy ⇒ Object

Specifies a MerchantReturnPolicy that may be applicable. Supersedes hasProductReturnPolicy.

# File 'lib/schema_org/mixins/product.rb', line 914

def has_merchant_return_policy
  read_property(:has_merchant_return_policy)
end

#has_merchant_return_policy=(value) ⇒ Object

Specifies a MerchantReturnPolicy that may be applicable. Supersedes hasProductReturnPolicy.

# File 'lib/schema_org/mixins/product.rb', line 920

def has_merchant_return_policy=(value)
  write_property(:has_merchant_return_policy, value)
end

#has_product_return_policy ⇒ Object

Indicates a ProductReturnPolicy that may be applicable. Superseded by hasMerchantReturnPolicy.

# File 'lib/schema_org/mixins/product.rb', line 926

def has_product_return_policy
  read_property(:has_product_return_policy)
end

#has_product_return_policy=(value) ⇒ Object

Indicates a ProductReturnPolicy that may be applicable. Superseded by hasMerchantReturnPolicy.

# File 'lib/schema_org/mixins/product.rb', line 932

def has_product_return_policy=(value)
  write_property(:has_product_return_policy, value)
end

#height ⇒ Object

The height of the item.

# File 'lib/schema_org/mixins/product.rb', line 937

def height
  read_property(:height)
end

#height=(value) ⇒ Object

The height of the item.

# File 'lib/schema_org/mixins/product.rb', line 942

def height=(value)
  write_property(:height, value)
end

#in_product_group_with_id ⇒ Object

Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].

# File 'lib/schema_org/mixins/product.rb', line 947

def in_product_group_with_id
  read_property(:in_product_group_with_id)
end

#in_product_group_with_id=(value) ⇒ Object

Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].

# File 'lib/schema_org/mixins/product.rb', line 952

def in_product_group_with_id=(value)
  write_property(:in_product_group_with_id, value)
end

#is_accessory_or_spare_part_for ⇒ Object

A pointer to another product (or multiple products) for which this product is an accessory or spare part.

# File 'lib/schema_org/mixins/product.rb', line 957

def is_accessory_or_spare_part_for
  read_property(:is_accessory_or_spare_part_for)
end

#is_accessory_or_spare_part_for=(value) ⇒ Object

A pointer to another product (or multiple products) for which this product is an accessory or spare part.

# File 'lib/schema_org/mixins/product.rb', line 962

def is_accessory_or_spare_part_for=(value)
  write_property(:is_accessory_or_spare_part_for, value)
end

#is_consumable_for ⇒ Object

A pointer to another product (or multiple products) for which this product is a consumable.

# File 'lib/schema_org/mixins/product.rb', line 967

def is_consumable_for
  read_property(:is_consumable_for)
end

#is_consumable_for=(value) ⇒ Object

A pointer to another product (or multiple products) for which this product is a consumable.

# File 'lib/schema_org/mixins/product.rb', line 972

def is_consumable_for=(value)
  write_property(:is_consumable_for, value)
end

#is_family_friendly ⇒ Object

Indicates whether this content is family friendly.

# File 'lib/schema_org/mixins/product.rb', line 977

def is_family_friendly
  read_property(:is_family_friendly)
end

#is_family_friendly=(value) ⇒ Object

Indicates whether this content is family friendly.

# File 'lib/schema_org/mixins/product.rb', line 982

def is_family_friendly=(value)
  write_property(:is_family_friendly, value)
end

#is_related_to ⇒ Object

A pointer to another, somehow related product (or multiple products).

# File 'lib/schema_org/mixins/product.rb', line 987

def is_related_to
  read_property(:is_related_to)
end

#is_related_to=(value) ⇒ Object

A pointer to another, somehow related product (or multiple products).

# File 'lib/schema_org/mixins/product.rb', line 992

def is_related_to=(value)
  write_property(:is_related_to, value)
end

#is_similar_to ⇒ Object

A pointer to another, functionally similar product (or multiple products).

# File 'lib/schema_org/mixins/product.rb', line 997

def is_similar_to
  read_property(:is_similar_to)
end

#is_similar_to=(value) ⇒ Object

A pointer to another, functionally similar product (or multiple products).

# File 'lib/schema_org/mixins/product.rb', line 1002

def is_similar_to=(value)
  write_property(:is_similar_to, value)
end

#is_variant_of ⇒ Object

Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group. Inverse-property: hasVariant.

# File 'lib/schema_org/mixins/product.rb', line 1008

def is_variant_of
  read_property(:is_variant_of)
end

#is_variant_of=(value) ⇒ Object

Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group. Inverse-property: hasVariant.

# File 'lib/schema_org/mixins/product.rb', line 1014

def is_variant_of=(value)
  write_property(:is_variant_of, value)
end

#item_condition ⇒ Object

A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.

# File 'lib/schema_org/mixins/product.rb', line 1019

def item_condition
  read_property(:item_condition)
end

#item_condition=(value) ⇒ Object

A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.

# File 'lib/schema_org/mixins/product.rb', line 1024

def item_condition=(value)
  write_property(:item_condition, value)
end

#keywords ⇒ Object

Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.

# File 'lib/schema_org/mixins/product.rb', line 1029

def keywords
  read_property(:keywords)
end

#keywords=(value) ⇒ Object

Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.

# File 'lib/schema_org/mixins/product.rb', line 1034

def keywords=(value)
  write_property(:keywords, value)
end

#logo ⇒ Object

An associated logo.

# File 'lib/schema_org/mixins/product.rb', line 1039

def logo
  read_property(:logo)
end

#logo=(value) ⇒ Object

An associated logo.

# File 'lib/schema_org/mixins/product.rb', line 1044

def logo=(value)
  write_property(:logo, value)
end

#manufacturer ⇒ Object

The manufacturer of the product.

# File 'lib/schema_org/mixins/product.rb', line 1049

def manufacturer
  read_property(:manufacturer)
end

#manufacturer=(value) ⇒ Object

The manufacturer of the product.

# File 'lib/schema_org/mixins/product.rb', line 1054

def manufacturer=(value)
  write_property(:manufacturer, value)
end

#material ⇒ Object

A material that something is made from, e.g. leather, wool, cotton, paper.

# File 'lib/schema_org/mixins/product.rb', line 1059

def material
  read_property(:material)
end

#material=(value) ⇒ Object

A material that something is made from, e.g. leather, wool, cotton, paper.

# File 'lib/schema_org/mixins/product.rb', line 1064

def material=(value)
  write_property(:material, value)
end

#mobile_url ⇒ Object

The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.

To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards responsive design in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.

# File 'lib/schema_org/mixins/product.rb', line 1071

def mobile_url
  read_property(:mobile_url)
end

#mobile_url=(value) ⇒ Object

The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.

To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards responsive design in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.

# File 'lib/schema_org/mixins/product.rb', line 1078

def mobile_url=(value)
  write_property(:mobile_url, value)
end

#model ⇒ Object

The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.

# File 'lib/schema_org/mixins/product.rb', line 1083

def model
  read_property(:model)
end

#model=(value) ⇒ Object

The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.

# File 'lib/schema_org/mixins/product.rb', line 1088

def model=(value)
  write_property(:model, value)
end

#mpn ⇒ Object

The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.

# File 'lib/schema_org/mixins/product.rb', line 1093

def mpn
  read_property(:mpn)
end

#mpn=(value) ⇒ Object

The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.

# File 'lib/schema_org/mixins/product.rb', line 1098

def mpn=(value)
  write_property(:mpn, value)
end

#negative_notes ⇒ Object

Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry

In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].

The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).

# File 'lib/schema_org/mixins/product.rb', line 1108

def negative_notes
  read_property(:negative_notes)
end

#negative_notes=(value) ⇒ Object

Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry

In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].

The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).

# File 'lib/schema_org/mixins/product.rb', line 1118

def negative_notes=(value)
  write_property(:negative_notes, value)
end

#nsn ⇒ Object

Indicates the NATO stock number (nsn) of a [[Product]].

# File 'lib/schema_org/mixins/product.rb', line 1123

def nsn
  read_property(:nsn)
end

#nsn=(value) ⇒ Object

Indicates the NATO stock number (nsn) of a [[Product]].

# File 'lib/schema_org/mixins/product.rb', line 1128

def nsn=(value)
  write_property(:nsn, value)
end

#offers ⇒ Object

An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. Inverse-property: itemOffered.

# File 'lib/schema_org/mixins/product.rb', line 1134

def offers
  read_property(:offers)
end

#offers=(value) ⇒ Object

An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. Inverse-property: itemOffered.

# File 'lib/schema_org/mixins/product.rb', line 1140

def offers=(value)
  write_property(:offers, value)
end

#pattern ⇒ Object

A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.

# File 'lib/schema_org/mixins/product.rb', line 1145

def pattern
  read_property(:pattern)
end

#pattern=(value) ⇒ Object

A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.

# File 'lib/schema_org/mixins/product.rb', line 1150

def pattern=(value)
  write_property(:pattern, value)
end

#positive_notes ⇒ Object

Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.

In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.

The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).

# File 'lib/schema_org/mixins/product.rb', line 1159

def positive_notes
  read_property(:positive_notes)
end

#positive_notes=(value) ⇒ Object

Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.

In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.

The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).

# File 'lib/schema_org/mixins/product.rb', line 1168

def positive_notes=(value)
  write_property(:positive_notes, value)
end

#product_id ⇒ Object

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".

# File 'lib/schema_org/mixins/product.rb', line 1173

def product_id
  read_property(:product_id)
end

#product_id=(value) ⇒ Object

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".

# File 'lib/schema_org/mixins/product.rb', line 1178

def product_id=(value)
  write_property(:product_id, value)
end

#production_date ⇒ Object

The date of production of the item, e.g. vehicle.

# File 'lib/schema_org/mixins/product.rb', line 1183

def production_date
  read_property(:production_date)
end

#production_date=(value) ⇒ Object

The date of production of the item, e.g. vehicle.

# File 'lib/schema_org/mixins/product.rb', line 1188

def production_date=(value)
  write_property(:production_date, value)
end

#purchase_date ⇒ Object

The date the item, e.g. vehicle, was purchased by the current owner.

# File 'lib/schema_org/mixins/product.rb', line 1193

def purchase_date
  read_property(:purchase_date)
end

#purchase_date=(value) ⇒ Object

The date the item, e.g. vehicle, was purchased by the current owner.

# File 'lib/schema_org/mixins/product.rb', line 1198

def purchase_date=(value)
  write_property(:purchase_date, value)
end

#release_date ⇒ Object

The release date of a product or product model. This can be used to distinguish the exact variant of a product.

# File 'lib/schema_org/mixins/product.rb', line 1203

def release_date
  read_property(:release_date)
end

#release_date=(value) ⇒ Object

The release date of a product or product model. This can be used to distinguish the exact variant of a product.

# File 'lib/schema_org/mixins/product.rb', line 1208

def release_date=(value)
  write_property(:release_date, value)
end

#review ⇒ Object

A review of the item. Supersedes reviews.

# File 'lib/schema_org/mixins/product.rb', line 1214

def review
  read_property(:review)
end

#review=(value) ⇒ Object

A review of the item. Supersedes reviews.

# File 'lib/schema_org/mixins/product.rb', line 1220

def review=(value)
  write_property(:review, value)
end

#reviews ⇒ Object

Review of the item. Superseded by review.

# File 'lib/schema_org/mixins/product.rb', line 1226

def reviews
  read_property(:reviews)
end

#reviews=(value) ⇒ Object

Review of the item. Superseded by review.

# File 'lib/schema_org/mixins/product.rb', line 1232

def reviews=(value)
  write_property(:reviews, value)
end

#size ⇒ Object

A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.

# File 'lib/schema_org/mixins/product.rb', line 1237

def size
  read_property(:size)
end

#size=(value) ⇒ Object

A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.

# File 'lib/schema_org/mixins/product.rb', line 1242

def size=(value)
  write_property(:size, value)
end

#sku ⇒ Object

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

# File 'lib/schema_org/mixins/product.rb', line 1247

def sku
  read_property(:sku)
end

#sku=(value) ⇒ Object

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

# File 'lib/schema_org/mixins/product.rb', line 1252

def sku=(value)
  write_property(:sku, value)
end

#slogan ⇒ Object

A slogan or motto associated with the item.

# File 'lib/schema_org/mixins/product.rb', line 1257

def slogan
  read_property(:slogan)
end

#slogan=(value) ⇒ Object

A slogan or motto associated with the item.

# File 'lib/schema_org/mixins/product.rb', line 1262

def slogan=(value)
  write_property(:slogan, value)
end

#weight ⇒ Object

The weight of the product or person.

# File 'lib/schema_org/mixins/product.rb', line 1267

def weight
  read_property(:weight)
end

#weight=(value) ⇒ Object

The weight of the product or person.

# File 'lib/schema_org/mixins/product.rb', line 1272

def weight=(value)
  write_property(:weight, value)
end

#width ⇒ Object

The width of the item.

# File 'lib/schema_org/mixins/product.rb', line 1277

def width
  read_property(:width)
end

#width=(value) ⇒ Object

The width of the item.

# File 'lib/schema_org/mixins/product.rb', line 1282

def width=(value)
  write_property(:width, value)
end