Product
Any offered product or service. For example, a pair of shoes; a haircut; or an episode of a TV show streamed online.
The Product
type allows you to provide details about a product such as the product brand, logo and ID. This type can be used as any kind of product that is not CreativeWork
item. Product
is analogous, and structurally similar to, the JATS XML <product>
element which contains the metadata concerning one product (for example, a book, software package, website, or hardware component) discussed in an article. To meet Google's guidelines for Product
instances are required to have image
and name
properties.
Properties​
Name | @id | Type | Description | Inherited from |
---|---|---|---|---|
alternateNames | schema:alternateName | Array of string | Alternate names (aliases) for the item. | Thing |
brands | schema:brand | Array of Brand | Brands that the product is labelled with. | Product |
description | schema:description | Array of BlockContent or Array of InlineContent or string | A description of the item. See note 1. | Thing |
id | schema:id | string | The identifier for this item. | Entity |
identifiers | schema:identifier | Array of (PropertyValue or string) | Any kind of identifier for any kind of Thing. See note 2. | Thing |
images | schema:image | Array of (ImageObject or Format 'uri') | Images of the item. | Thing |
logo | schema:logo | ImageObject or Format 'uri' | The logo of the product. | Product |
meta | stencila:meta | object | Metadata associated with this item. | Entity |
name | schema:name | string | The name of the item. | Thing |
productID | schema:productID | string | Product identification code. | Product |
url | schema:url | Format 'uri' | The URL of the item. | Thing |
Notes​
- description : Allows for the description to be an array of nodes (e.g. an array of inline content, or a couple of paragraphs), or a string. The
minItems
restriction avoids a string being coerced into an array with a single string item. - identifiers : Some identifiers have specific properties e.g the
issn
property for thePeriodical
type. These should be used in preference to this property which is intended for identifiers that do not yet have a specific property. Identifiers can be represented as strings, but using aPropertyValue
will usually be better because it allows forpropertyID
(i.e. the type of identifier).
Examples​
{
"type": "Product",
"brand": {
"type": "Brand",
"name": "Astro"
},
"name": "Astrolabe",
"logo": {
"type": "ImageObject",
"contentUrl": "http://www.product-astrolabe.com/logo.png",
"caption": "Astrolabe Logo"
},
"productID": "AA55"
}
Related​
- Parent: Thing
- Descendants: None
Available as​
- JSON-LD
- JSON Schema
- Python
class Product
- TypeScript
interface Product
- R
class Product
- Rust
struct Product
Source​
This documentation was generated from Product.schema.yaml.