SchemaProduct class

a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online. See https://schema.org/Product

Constructors

SchemaProduct.new({SchemaPropertyValue? additionalProperty, SchemaAggregateRating? aggregateRating, String? asin, SchemaAudience? audience, String? award, String? awards, dynamic brand, dynamic category, String? color, dynamic colorSwatch, String? countryOfAssembly, String? countryOfLastProcessing, SchemaCountry? countryOfOrigin, dynamic depth, SchemaGrant? funding, String? gtin, String? gtin12, String? gtin13, String? gtin14, String? gtin8, SchemaAdultOrientedEnumeration? hasAdultConsideration, SchemaCertification? hasCertification, SchemaEnergyConsumptionDetails? hasEnergyConsumptionDetails, SchemaQuantitativeValue? hasMeasurement, SchemaMerchantReturnPolicy? hasMerchantReturnPolicy, dynamic height, String? inProductGroupWithID, SchemaProduct? isAccessoryOrSparePartFor, SchemaProduct? isConsumableFor, bool? isFamilyFriendly, dynamic isRelatedTo, dynamic isSimilarTo, dynamic isVariantOf, SchemaOfferItemCondition? itemCondition, dynamic keywords, dynamic logo, SchemaOrganization? manufacturer, dynamic material, String? mobileUrl, dynamic model, String? mpn, dynamic negativeNotes, String? nsn, dynamic offers, dynamic pattern, dynamic positiveNotes, String? productID, String? productionDate, String? purchaseDate, String? releaseDate, SchemaReview? review, SchemaReview? reviews, dynamic size, String? sku, String? slogan, SchemaQuantitativeValue? weight, dynamic width, String? additionalType, String? alternateName, dynamic description, String? disambiguatingDescription, dynamic identifier, dynamic image, dynamic mainEntityOfPage, String? name, SchemaAction? potentialAction, String? sameAs, dynamic subjectOf, String? url})

Create a new instance of SchemaProduct

Properties

additionalProperty ↔ SchemaPropertyValue?

//schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.

getter/setter pair

additionalType ↔ String?

//schema.org/docs/styleguide.html">style guide. Supported types: String, String

getter/setter pair

aggregateRating ↔ SchemaAggregateRating?

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

getter/setter pair

alternateName ↔ String?

An alias for the item.

getter/setter pair

asin ↔ String?

//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. Supported types: String, String

getter/setter pair

audience ↔ SchemaAudience?

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

getter/setter pair

award ↔ String?

An award won by or for this item.

getter/setter pair

awards ↔ String?

Awards won by or for this item.

getter/setter pair

brand ↔ dynamic

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

getter/setter pair

category ↔ dynamic

A category for the item Greater signs or slashes can be used to informally indicate a category hierarchy. Supported types: CategoryCode, PhysicalActivityCategory, String, String, Thing

getter/setter pair

color ↔ String?

The color of the product.

getter/setter pair

colorSwatch ↔ dynamic

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. Supported types: ImageObject, String

getter/setter pair

countryOfAssembly ↔ String?

The place where the product was assembled.

getter/setter pair

countryOfLastProcessing ↔ String?

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

getter/setter pair

countryOfOrigin ↔ SchemaCountry?

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.

getter/setter pair

depth ↔ dynamic

The depth of the item. Supported types: Distance, QuantitativeValue

getter/setter pair

description ↔ dynamic

A description of the item. Supported types: String, TextObject

getter/setter pair

disambiguatingDescription ↔ String?

A sub property of description A short description of the item used to disambiguate from other, similar items Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

getter/setter pair

funding ↔ SchemaGrant?

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

getter/setter pair

gtin ↔ String?

//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 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. Supported types: String, String

getter/setter pair

gtin12 ↔ String?

//www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

getter/setter pair

gtin13 ↔ String?

//www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

getter/setter pair

gtin14 ↔ String?

//www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

getter/setter pair

gtin8 ↔ String?

//www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

getter/setter pair

hasAdultConsideration ↔ SchemaAdultOrientedEnumeration?

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

getter/setter pair

hasCertification ↔ SchemaCertification?

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

getter/setter pair

hasEnergyConsumptionDetails ↔ SchemaEnergyConsumptionDetails?

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

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hasMeasurement ↔ SchemaQuantitativeValue?

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.

getter/setter pair

hasMerchantReturnPolicy ↔ SchemaMerchantReturnPolicy?

Specifies a MerchantReturnPolicy that may be applicable.

getter/setter pair

height ↔ dynamic

The height of the item. Supported types: Distance, QuantitativeValue

getter/setter pair

identifier ↔ dynamic

The identifier property represents any kind of identifier for any kind of [Thing], such as ISBNs, GTIN codes, UUIDs etc Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links See background notes for more details Supported types: PropertyValue, String, String

getter/setter pair

image ↔ dynamic

An image of the item This can be a [URL] or a fully described [ImageObject]. Supported types: ImageObject, String

getter/setter pair

inProductGroupWithID ↔ String?

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

getter/setter pair

isAccessoryOrSparePartFor ↔ SchemaProduct?

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

getter/setter pair

isConsumableFor ↔ SchemaProduct?

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

getter/setter pair

isFamilyFriendly ↔ bool?

Indicates whether this content is family friendly.

getter/setter pair

isRelatedTo ↔ dynamic

A pointer to another, somehow related product (or multiple products). Supported types: Product, Service

getter/setter pair

isSimilarTo ↔ dynamic

A pointer to another, functionally similar product (or multiple products). Supported types: Product, Service

getter/setter pair

isVariantOf ↔ dynamic

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. Supported types: ProductGroup, ProductModel

getter/setter pair

itemCondition ↔ SchemaOfferItemCondition?

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.

getter/setter pair

keywords ↔ dynamic

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. Supported types: DefinedTerm, String, String

getter/setter pair

logo ↔ dynamic

An associated logo. Supported types: ImageObject, String

getter/setter pair

mainEntityOfPage ↔ dynamic

Indicates a page (or other CreativeWork) for which this thing is the main entity being described See background notes for details. Supported types: CreativeWork, String

getter/setter pair

manufacturer ↔ SchemaOrganization?

The manufacturer of the product.

getter/setter pair

material ↔ dynamic

A material that something is made from, e.g leather, wool, cotton, paper. Supported types: Product, String, String

getter/setter pair

mobileUrl ↔ String?

//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.

getter/setter pair

model ↔ dynamic

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. Supported types: ProductModel, String

getter/setter pair

mpn ↔ String?

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

getter/setter pair

name ↔ String?

The name of the item.

getter/setter pair

negativeNotes ↔ dynamic

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). Supported types: ItemList, ListItem, String, WebContent

getter/setter pair

nsn ↔ String?

//en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [Product].

getter/setter pair

offers ↔ dynamic

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 Supported types: Demand, Offer

getter/setter pair

pattern ↔ dynamic

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. Supported types: DefinedTerm, String

getter/setter pair

positiveNotes ↔ dynamic

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). Supported types: ItemList, ListItem, String, WebContent

getter/setter pair

potentialAction ↔ SchemaAction?

Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

getter/setter pair

productID ↔ String?

123-456-789" ```.

getter/setter pair

productionDate ↔ String?

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

getter/setter pair

purchaseDate ↔ String?

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

getter/setter pair

releaseDate ↔ String?

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

getter/setter pair

review ↔ SchemaReview?

A review of the item.

getter/setter pair

reviews ↔ SchemaReview?

Review of the item.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sameAs ↔ String?

URL of a reference Web page that unambiguously indicates the item's identity E.g the URL of the item's Wikipedia page, Wikidata entry, or official website.

getter/setter pair

size ↔ dynamic

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 Supported types: DefinedTerm, QuantitativeValue, SizeSpecification, String

getter/setter pair

sku ↔ String?

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

getter/setter pair

slogan ↔ String?

A slogan or motto associated with the item.

getter/setter pair

subjectOf ↔ dynamic

A CreativeWork or Event about this Thing. Supported types: CreativeWork, Event

getter/setter pair

url ↔ String?

URL of the item.

getter/setter pair

weight ↔ SchemaQuantitativeValue?

The weight of the product or person.

getter/setter pair

width ↔ dynamic

The width of the item. Supported types: Distance, QuantitativeValue

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJsonLd() → Map<String, dynamic>

Serialize SchemaProduct to JSON-LD

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited