ConformityCredential
version: working
ConformityCredential Domain
Data Model
![Data Model of unece/ConformityCredential](/user/unece/ConformityCredential/v/working/artefacts/diagram/unece_ConformityCredential.svg)
Data Definitions
DigitalConformityCredential
A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation.
Property |
Definition |
Type |
@context |
A list of JSON-LD contect URIs that define the seamntic meaning of prperties within the credential. |
Text |
id |
A unique identifier (URI) assigned to the product passport. May be a UUID |
URI |
issuer |
The organisation that is the isuer of this VC. Note that the "id" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the "otherIdentifiers" property. |
Party |
validFrom |
The date and time from which the credential is valid. |
DateTime |
validUntil |
The expiry date (if applicable) of this verifiable credential. |
DateTime |
credentialSubject |
The conformity attestion is the subject of the verifiable credential. |
ConformityAttestation |
ConformityAttestation
A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation.
Property |
Definition |
Type |
id |
The globally unique ID of this conformity attestation. |
URI |
assessorLevel |
Assurance code pertaining to assessor (relation to the object under assessment) |
Code (assessorAssuranceCode) |
assessmentLevel |
Assurance pertaining to assessment (any authority or support for the assessment process) |
Code (assessmentAssuranceCode) |
attestationType |
The type of criterion (optional or mandatory). |
Code (attestationTypeCode) |
attestationDescription |
A textual description of the scope or purpose of this confomrity attestation |
Text |
issuedTo |
The party to whom the conformity attestation was issued. |
PartyID |
accreditation |
The accreditation from a competent authority (ag NATA) that confirms the issuers authorised scope of assessments. |
Authorisation |
conformityCertificate |
A reference to the human / printable version of this conformity attestation - typically represented as a PDF document. The document may have more details than are represented in the digital attestation. |
BinaryFile |
auditableEvidence |
Auditable evidence supporting this assessment such as raw measurements, supporting documents. This is usally private data and would normally be encrypted. |
SecureBinaryFile |
scope |
A list of relevant standards and/or regulations against which apply to this attestation (eg AS1163:2016). |
ConformityAssessmentScheme |
assessments |
The list of specific assessments made within this conformity attestation. |
ConformityAssessment |
ConformityAssessmentScheme
A formal governance scheme under which this attestation is issued (eg ACRS structural steel certification)
Property |
Definition |
Type |
id |
The globally unique ID of the standard - eg https://www.iso.org/standard/60857.html |
URI |
standardName |
The name of the standard (eg ISO 14001:2015 Environmental management system) |
Text |
issuingBody |
The party that issued the standard (ID and Name reference only) |
PartyID |
issueDate |
The date when the standard was issued. |
Date |
trustmark |
The trust mark that represents the conformity assessment scheme. |
BinaryFile |
ConformityAssessment
A specific assessment about the product or facility against a specific specification. Eg the carbon intensity of a given product or batch.
Property |
Definition |
Type |
id |
A unique identifier for the standard (eg https://www.iso.org/standard/60857.html). |
URI |
referenceStandard |
The reference to the standard that defines the specification / criteria |
Standard |
referenceRegulation |
The reference to the regulation that defines the assessment criteria |
Regulation |
assessmentCriterion |
The specification against which the assessment is made. |
Criteria |
declaredValues |
The list of specific values measured as part of this assessment (eg tensile strength) |
Metric |
compliance |
An indicator of whether or not the assessment meets the specification. |
Indicator |
conformityTopic |
The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions) |
Code (conformityTopicCode) |
assessedProducts |
The list of products that are the subject of this conformity assessment |
ProductID |
assessedFacilities |
The list of facilities that are the subject of this conformity assessment. |
FacilityID |
verfifiedByCAB |
Indicates whether the conformity assessment body has verified the identity of the subject of the assement (a facility or product / batch). |
Indicator |
VerifiableCredential
A verifiable credential is a digital and verifiable version of everyday credentials such as certificates and licenses. It conforms to the W3C Verifiable Credentials Data Model v2.0 (VCDM)
Property |
Definition |
Type |
@context |
A list of JSON-LD contect URIs that define the seamntic meaning of prperties within the credential. |
Text |
id |
A unique identifier (URI) assigned to the product passport. May be a UUID |
URI |
issuer |
The organisation that is the isuer of this VC. Note that the "id" property MUST be a W3C DID. Other identifiers such as tax registration numbers can be listed in the "otherIdentifiers" property. |
Party |
validFrom |
The date and time from which the credential is valid. |
DateTime |
validUntil |
The expiry date (if applicable) of this verifiable credential. |
DateTime |
Party
An organisation. May be a supply chain actor, a certifier, a government agency.
Property |
Definition |
Type |
id |
A globally unique URI for the that identifies this organisation - eg https://abr.business.gov.au/ABN/View?abn=90664869327 |
URI |
idScheme |
The scheme ID for the organisation ID, usually the registry operator - eg abr.business.gov.au |
URI |
idSchemeName |
The name of the business registration scheme - eg Austrlaian Business Number |
Text |
idValue |
The value of the organisation identifier within the scheme - eg 90664869327 |
Text |
partyName |
The name of the organization or company, represented as a text string. SHOULD match the registered name in the identifeir scheme. Eg PYX Industries Pty Ltd |
Text |
registrationCountry |
the country in which this organisation is registered |
Code (countryCode) |
organisationWebsite |
Website for this organisation |
URI |
industryCategory |
The industry categories for this organisations. Recommend use of UNCPC as the category scheme. |
Classification |
otherIdentifiers |
An optional lsit of other registered identifiers for this organisations |
Identifier |
PartyID
The ID and Name of an organisation. Used for lightweight links from other classes.
Property |
Definition |
Type |
id |
A globally unique URI for the that identifies this organisation - eg https://abr.business.gov.au/ABN/View?abn=90664869327 |
URI |
idScheme |
The scheme ID for the organisation ID, usually the registry operator - eg abr.business.gov.au |
URI |
idSchemeName |
The name of the business registration scheme - eg Austrlaian Business Number |
Text |
idValue |
The value of the organisation identifier within the scheme - eg 90664869327 |
Text |
partyName |
The name of the organization or company, represented as a text string. SHOULD match the registered name in the identifeir scheme. Eg PYX Industries Pty Ltd |
Text |
Thing
The most generic type of item.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
Action
An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.\n\nSee also blog post and Actions overview document.
Property |
Definition |
Type |
endTime |
The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
startTime |
The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
result |
The result produced in the action. E.g. John wrote a book. |
Thing |
actionStatus |
Indicates the current disposition of the Action. |
ActionStatusType |
agent |
The direct performer or driver of the action (animate or inanimate). E.g. John wrote a book. |
Organization |
instrument |
The object that helped the agent perform the action. E.g. John wrote a book with a pen. |
Thing |
object |
The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read a book. |
Thing |
error |
For failed actions, more information on the cause of the failure. |
Thing |
target |
Indicates a target EntryPoint, or url, for an Action. |
URI |
location |
The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
Place |
participant |
Other co-agents that participated in the action indirectly. E.g. John wrote a book with Steve. |
Organization |
Organization
An organization such as a school, NGO, corporation, club, etc.
Property |
Definition |
Type |
serviceArea |
The geographic area where the service is provided. |
AdministrativeArea |
founder |
A person who founded this organization. |
Person |
isicV4 |
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place. |
Text |
hasPOS |
Points-of-Sales operated by the organization or person. |
Place |
globalLocationNumber |
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. |
Text |
member |
A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals. |
Organization |
knowsAbout |
Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions. |
Thing |
makesOffer |
A pointer to products or services offered by the organization or person. |
Offer |
ownershipFundingInfo |
For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable. |
AboutPage |
founders |
A person who founded this organization. |
Person |
legalName |
The official name of the organization, e.g. the registered company name. |
Text |
actionableFeedbackPolicy |
For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroom’s), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication. |
CreativeWork |
areaServed |
The geographic area where a service or offered item is provided. |
Text |
parentOrganization |
The larger organization that this organization is a [[subOrganization]] of, if any. |
Organization |
slogan |
A slogan or motto associated with the item. |
Text |
department |
A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe. |
Organization |
keywords |
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. |
URI |
reviews |
Review of the item. |
Review |
memberOf |
An Organization (or ProgramMembership) to which this Person or Organization belongs. |
Organization |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
employee |
Someone working for this organization. |
Person |
award |
An award won by or for this item. |
Text |
email |
Email address. |
Text |
contactPoints |
A contact point for a person or organization. |
ContactPoint |
diversityStaffingReport |
For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported. |
Article |
foundingDate |
The date that this organization was founded. |
Date |
owns |
Products owned by the organization or person. |
Product |
awards |
Awards won by or for this item. |
Text |
review |
A review of the item. |
Review |
dissolutionDate |
The date that this organization was dissolved. |
Date |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
events |
Upcoming or past events associated with this place or organization. |
Event |
seeks |
A pointer to products or services sought by the organization or person (demand). |
Demand |
employees |
People working for this organization. |
Person |
unnamedSourcesPolicy |
For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required. |
CreativeWork |
subOrganization |
A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property. |
Organization |
foundingLocation |
The place where the Organization was founded. |
Place |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
iso6523Code |
An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as leiCode, duns and vatID can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly. |
Text |
diversityPolicy |
Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroom’s diversity policy on both staffing and sources, typically providing staffing data. |
URI |
hasMerchantReturnPolicy |
Specifies a MerchantReturnPolicy that may be applicable. |
MerchantReturnPolicy |
event |
Upcoming or past event associated with this place, organization, or action. |
Event |
duns |
The Dun & Bradstreet DUNS number for identifying an organization or business person. |
Text |
alumni |
Alumni of an organization. |
Person |
ethicsPolicy |
Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization. |
CreativeWork |
leiCode |
An organization identifier that uniquely identifies a legal entity as defined in ISO 17442. |
Text |
vatID |
The Value-added Tax ID of the organization or person. |
Text |
knowsLanguage |
Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the IETF BCP 47 standard. |
Text |
correctionsPolicy |
For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors. |
URI |
logo |
An associated logo. |
ImageObject |
hasCredential |
A credential awarded to the Person or Organization. |
EducationalOccupationalCredential |
address |
Physical address of the item. |
Text |
brand |
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. |
Brand |
nonprofitStatus |
nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business. |
NonprofitType |
contactPoint |
A contact point for a person or organization. |
ContactPoint |
hasOfferCatalog |
Indicates an OfferCatalog listing for this Organization, Person, or Service. |
OfferCatalog |
members |
A member of this organization. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
faxNumber |
The fax number. |
Text |
telephone |
The telephone number. |
Text |
taxID |
The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain. |
Text |
naics |
The North American Industry Classification System (NAICS) code for a particular organization or business person. |
Text |
location |
The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
Place |
numberOfEmployees |
The number of employees in an organization, e.g. business. |
QuantitativeValue |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
AdministrativeArea
A geographical region, typically under the jurisdiction of a particular government.
Property |
Definition |
Type |
geoCovers |
Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in DE-9IM. |
GeospatialGeometry |
longitude |
The longitude of a location. For example -122.08585 (WGS 84). |
Text |
smokingAllowed |
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room. |
Indicator |
isicV4 |
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place. |
Text |
globalLocationNumber |
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. |
Text |
amenityFeature |
An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs. |
LocationFeatureSpecification |
additionalProperty |
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. |
PropertyValue |
slogan |
A slogan or motto associated with the item. |
Text |
photos |
Photographs of this place. |
ImageObject |
keywords |
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. |
URI |
reviews |
Review of the item. |
Review |
tourBookingPage |
A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate. |
URI |
geoWithin |
Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in DE-9IM. |
GeospatialGeometry |
containsPlace |
The basic containment relation between a place and another that it contains. |
Place |
review |
A review of the item. |
Review |
hasMap |
A URL to a map of the place. |
URI |
containedIn |
The basic containment relation between a place and one that contains it. |
Place |
events |
Upcoming or past events associated with this place or organization. |
Event |
geoOverlaps |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in DE-9IM. |
GeospatialGeometry |
geoEquals |
Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in DE-9IM. "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship). |
GeospatialGeometry |
maps |
A URL to a map of the place. |
URI |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
event |
Upcoming or past event associated with this place, organization, or action. |
Event |
photo |
A photograph of this place. |
Photograph |
containedInPlace |
The basic containment relation between a place and one that contains it. |
Place |
logo |
An associated logo. |
ImageObject |
geoCrosses |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in DE-9IM. |
GeospatialGeometry |
address |
Physical address of the item. |
Text |
geo |
The geo coordinates of the place. |
GeoCoordinates |
openingHoursSpecification |
The opening hours of a certain place. |
OpeningHoursSpecification |
geoDisjoint |
Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoIntersects |
Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in DE-9IM. |
GeospatialGeometry |
latitude |
The latitude of a location. For example 37.42242 (WGS 84). |
Numeric |
maximumAttendeeCapacity |
The total number of individuals that may attend an event or venue. |
Integer |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
map |
A URL to a map of the place. |
URI |
branchCode |
A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.\n\nFor example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. |
Text |
faxNumber |
The fax number. |
Text |
publicAccess |
A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value |
Indicator |
geoTouches |
Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoCoveredBy |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in DE-9IM. |
GeospatialGeometry |
telephone |
The telephone number. |
Text |
hasDriveThroughService |
Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users. |
Indicator |
specialOpeningHoursSpecification |
The special opening hours of a certain place.\n\nUse this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]]. |
OpeningHoursSpecification |
geoContains |
Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in DE-9IM. |
Place |
Place
Entities that have a somewhat fixed, physical extension.
Property |
Definition |
Type |
geoCovers |
Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in DE-9IM. |
GeospatialGeometry |
longitude |
The longitude of a location. For example -122.08585 (WGS 84). |
Text |
smokingAllowed |
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room. |
Indicator |
isicV4 |
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place. |
Text |
globalLocationNumber |
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. |
Text |
amenityFeature |
An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs. |
LocationFeatureSpecification |
additionalProperty |
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. |
PropertyValue |
slogan |
A slogan or motto associated with the item. |
Text |
photos |
Photographs of this place. |
ImageObject |
keywords |
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. |
URI |
reviews |
Review of the item. |
Review |
tourBookingPage |
A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate. |
URI |
geoWithin |
Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in DE-9IM. |
GeospatialGeometry |
containsPlace |
The basic containment relation between a place and another that it contains. |
Place |
review |
A review of the item. |
Review |
hasMap |
A URL to a map of the place. |
URI |
containedIn |
The basic containment relation between a place and one that contains it. |
Place |
events |
Upcoming or past events associated with this place or organization. |
Event |
geoOverlaps |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in DE-9IM. |
GeospatialGeometry |
geoEquals |
Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in DE-9IM. "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship). |
GeospatialGeometry |
maps |
A URL to a map of the place. |
URI |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
event |
Upcoming or past event associated with this place, organization, or action. |
Event |
photo |
A photograph of this place. |
Photograph |
containedInPlace |
The basic containment relation between a place and one that contains it. |
Place |
logo |
An associated logo. |
ImageObject |
geoCrosses |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in DE-9IM. |
GeospatialGeometry |
address |
Physical address of the item. |
Text |
geo |
The geo coordinates of the place. |
GeoCoordinates |
openingHoursSpecification |
The opening hours of a certain place. |
OpeningHoursSpecification |
geoDisjoint |
Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoIntersects |
Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in DE-9IM. |
GeospatialGeometry |
latitude |
The latitude of a location. For example 37.42242 (WGS 84). |
Numeric |
maximumAttendeeCapacity |
The total number of individuals that may attend an event or venue. |
Integer |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
map |
A URL to a map of the place. |
URI |
branchCode |
A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.\n\nFor example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. |
Text |
faxNumber |
The fax number. |
Text |
publicAccess |
A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value |
Indicator |
geoTouches |
Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoCoveredBy |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in DE-9IM. |
GeospatialGeometry |
telephone |
The telephone number. |
Text |
hasDriveThroughService |
Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users. |
Indicator |
specialOpeningHoursSpecification |
The special opening hours of a certain place.\n\nUse this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]]. |
OpeningHoursSpecification |
geoContains |
Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in DE-9IM. |
Place |
GeospatialGeometry
(Eventually to be defined as) a supertype of GeoShape designed to accommodate definitions from Geo-Spatial best practices.
Property |
Definition |
Type |
geoCovers |
Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in DE-9IM. |
GeospatialGeometry |
geoWithin |
Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in DE-9IM. |
GeospatialGeometry |
geoOverlaps |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in DE-9IM. |
GeospatialGeometry |
geoEquals |
Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in DE-9IM. "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship). |
GeospatialGeometry |
geoCrosses |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in DE-9IM. |
GeospatialGeometry |
geoDisjoint |
Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoIntersects |
Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in DE-9IM. |
GeospatialGeometry |
geoTouches |
Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoCoveredBy |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in DE-9IM. |
GeospatialGeometry |
geoContains |
Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in DE-9IM. |
Place |
LocationFeatureSpecification
Specifies a location feature by providing a structured value representing a feature of an accommodation as a property-value pair of varying degrees of formality.
Property |
Definition |
Type |
value |
The value of the quantitative value or property value node.\n\n* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type for values is 'Number'.\n* For [[PropertyValue]], it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
StructuredValue |
valueReference |
A secondary value that provides additional information on the original value, e.g. a reference temperature or a type of measurement. |
Enumeration |
measurementTechnique |
A technique or technology used in a [[Dataset]] (or [[DataDownload]], [[DataCatalog]]),corresponding to the method used for measuring the corresponding variable(s) (described using [[variableMeasured]]). This is oriented towards scientific and scholarly dataset publication but may have broader applicability; it is not intended as a full representation of measurement, but rather as a high level summary for dataset discovery.For example, if [[variableMeasured]] is: molecule concentration, [[measurementTechnique]] could be: "mass spectrometry" or "nmr spectroscopy" or "colorimetry" or "immunofluorescence".If the [[variableMeasured]] is "depression rating", the [[measurementTechnique]] could be "Zung Scale" or "HAM-D" or "Beck Depression Inventory".If there are several [[variableMeasured]] properties recorded for some given data object, use a [[PropertyValue]] for each [[variableMeasured]] and attach the corresponding [[measurementTechnique]]. |
URI |
unitCode |
The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon. |
Text |
maxValue |
The upper value of some characteristic or property. |
Numeric |
unitText |
A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code forunitCode. |
Text |
propertyID |
A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property. propertyID can be(1) a prefixed string, mainly meant to be used with standards for product properties; (2) a site-specific, non-prefixed string (e.g. the primary key of the property or the vendor-specific ID of the property), or (3)a URL indicating the type of the property, either pointing to an external vocabulary, or a Web resource that describes the property (e.g. a glossary entry).Standards bodies should promote a standard prefix for the identifiers of properties from their standards. |
Text |
minValue |
The lower value of some characteristic or property. |
Numeric |
validThrough |
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours. |
Date |
hoursAvailable |
The hours during which this service or contact is available. |
OpeningHoursSpecification |
validFrom |
The date when the item becomes valid. |
Date |
PropertyValue
A property-value pair, e.g. representing a feature of a product or place. Use the 'name' property for the name of the property. If there is an additional human-readable version of the value, put that into the 'description' property.\n\n Always use specific schema.org properties when a) they exist and b) you can populate them. Using PropertyValue as a substitute will typically not trigger the same effect as using the original, specific property.
Property |
Definition |
Type |
value |
The value of the quantitative value or property value node.\n\n* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type for values is 'Number'.\n* For [[PropertyValue]], it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
StructuredValue |
valueReference |
A secondary value that provides additional information on the original value, e.g. a reference temperature or a type of measurement. |
Enumeration |
measurementTechnique |
A technique or technology used in a [[Dataset]] (or [[DataDownload]], [[DataCatalog]]),corresponding to the method used for measuring the corresponding variable(s) (described using [[variableMeasured]]). This is oriented towards scientific and scholarly dataset publication but may have broader applicability; it is not intended as a full representation of measurement, but rather as a high level summary for dataset discovery.For example, if [[variableMeasured]] is: molecule concentration, [[measurementTechnique]] could be: "mass spectrometry" or "nmr spectroscopy" or "colorimetry" or "immunofluorescence".If the [[variableMeasured]] is "depression rating", the [[measurementTechnique]] could be "Zung Scale" or "HAM-D" or "Beck Depression Inventory".If there are several [[variableMeasured]] properties recorded for some given data object, use a [[PropertyValue]] for each [[variableMeasured]] and attach the corresponding [[measurementTechnique]]. |
URI |
unitCode |
The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon. |
Text |
maxValue |
The upper value of some characteristic or property. |
Numeric |
unitText |
A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code forunitCode. |
Text |
propertyID |
A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property. propertyID can be(1) a prefixed string, mainly meant to be used with standards for product properties; (2) a site-specific, non-prefixed string (e.g. the primary key of the property or the vendor-specific ID of the property), or (3)a URL indicating the type of the property, either pointing to an external vocabulary, or a Web resource that describes the property (e.g. a glossary entry).Standards bodies should promote a standard prefix for the identifiers of properties from their standards. |
Text |
minValue |
The lower value of some characteristic or property. |
Numeric |
StructuredValue
Structured values are used when the value of a property has a more complex structure than simply being a textual value or a reference to another thing.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
Intangible
A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
Event
An event happening at a certain time and location, such as a concert, lecture, or festival. Ticketing information may be added via the [[offers]] property. Repeated events may be structured as separate Event objects.
Property |
Definition |
Type |
performer |
A performer at the event—for example, a presenter, musician, musical group or actor. |
Person |
eventAttendanceMode |
The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix. |
EventAttendanceModeEnumeration |
workFeatured |
A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent). |
CreativeWork |
remainingAttendeeCapacity |
The number of attendee places for an event that remain unallocated. |
Integer |
actor |
An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip. |
Person |
doorTime |
The time admission will commence. |
DateTime |
previousStartDate |
Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated. |
Date |
recordedIn |
The CreativeWork that captured all or part of this Event. |
CreativeWork |
keywords |
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. |
URI |
contributor |
A secondary contributor to the CreativeWork or Event. |
Organization |
superEvent |
An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent. |
Event |
eventSchedule |
Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons. |
Schedule |
maximumVirtualAttendeeCapacity |
The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]). |
Integer |
attendees |
A person attending the event. |
Organization |
review |
A review of the item. |
Review |
eventStatus |
An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled. |
EventStatusType |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
workPerformed |
A work performed in some event, for example a play performed in a TheaterEvent. |
CreativeWork |
duration |
The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. |
Duration |
about |
The subject matter of the content. |
Thing |
composer |
The person or organization who wrote a composition, or who is the composer of a work performed at some event. |
Organization |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
subEvent |
An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference. |
Event |
typicalAgeRange |
The typical expected age range, e.g. '7-9', '11-'. |
Text |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
attendee |
A person or organization attending the event. |
Organization |
subEvents |
Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference. |
Event |
performers |
The main performer or performers of the event—for example, a presenter, musician, or actor. |
Person |
maximumAttendeeCapacity |
The total number of individuals that may attend an event or venue. |
Integer |
translator |
Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
maximumPhysicalAttendeeCapacity |
The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]). |
Integer |
director |
A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip. |
Person |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
startDate |
The start date and time of the item (in ISO 8601 date format). |
DateTime |
offers |
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. |
Demand |
endDate |
The end date and time of the item (in ISO 8601 date format). |
DateTime |
location |
The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
Place |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
organizer |
An organizer of an Event. |
Organization |
Person
A person (alive, dead, undead, or fictional).
Property |
Definition |
Type |
sibling |
A sibling of the person. |
Person |
isicV4 |
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place. |
Text |
hasPOS |
Points-of-Sales operated by the organization or person. |
Place |
globalLocationNumber |
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. |
Text |
spouse |
The person's spouse. |
Person |
knowsAbout |
Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions. |
Thing |
makesOffer |
A pointer to products or services offered by the organization or person. |
Offer |
colleague |
A colleague of the person. |
Person |
honorificSuffix |
An honorific suffix following a Person's name such as M.D./PhD/MSCSW. |
Text |
nationality |
Nationality of the person. |
Country |
affiliation |
An organization that this person is affiliated with. For example, a school/university, a club, or a team. |
Organization |
memberOf |
An Organization (or ProgramMembership) to which this Person or Organization belongs. |
Organization |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
height |
The height of the item. |
QuantitativeValue |
knows |
The most generic bi-directional social/work relation. |
Person |
relatedTo |
The most generic familial relation. |
Person |
worksFor |
Organizations that the person works for. |
Organization |
award |
An award won by or for this item. |
Text |
email |
Email address. |
Text |
givenName |
Given name. In the U.S., the first name of a Person. |
Text |
workLocation |
A contact location for a person's place of work. |
ContactPoint |
contactPoints |
A contact point for a person or organization. |
ContactPoint |
jobTitle |
The job title of the person (for example, Financial Manager). |
DefinedTerm |
owns |
Products owned by the organization or person. |
Product |
awards |
Awards won by or for this item. |
Text |
children |
A child of the person. |
Person |
parent |
A parent of this person. |
Person |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
seeks |
A pointer to products or services sought by the organization or person (demand). |
Demand |
weight |
The weight of the product or person. |
QuantitativeValue |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
birthDate |
Date of birth. |
Date |
deathDate |
Date of death. |
Date |
additionalName |
An additional name for a Person, can be used for a middle name. |
Text |
duns |
The Dun & Bradstreet DUNS number for identifying an organization or business person. |
Text |
performerIn |
Event that this person is a performer or participant in. |
Event |
vatID |
The Value-added Tax ID of the organization or person. |
Text |
knowsLanguage |
Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the IETF BCP 47 standard. |
Text |
honorificPrefix |
An honorific prefix preceding a Person's name such as Dr/Mrs/Mr. |
Text |
parents |
A parents of the person. |
Person |
familyName |
Family name. In the U.S., the last name of a Person. |
Text |
siblings |
A sibling of the person. |
Person |
hasCredential |
A credential awarded to the Person or Organization. |
EducationalOccupationalCredential |
address |
Physical address of the item. |
Text |
brand |
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. |
Brand |
hasOccupation |
The Person's occupation. For past professions, use Role for expressing dates. |
Occupation |
netWorth |
The total financial value of the person as calculated by subtracting assets from liabilities. |
MonetaryAmount |
contactPoint |
A contact point for a person or organization. |
ContactPoint |
homeLocation |
A contact location for a person's residence. |
ContactPoint |
gender |
Gender of something, typically a [[Person]], but possibly also fictional characters, animals, etc. While https://schema.org/Male and https://schema.org/Female may be used, text strings are also acceptable for people who do not identify as a binary gender. The [[gender]] property can also be used in an extended sense to cover e.g. the gender of sports teams. As with the gender of individuals, we do not try to enumerate all possibilities. A mixed-gender [[SportsTeam]] can be indicated with a text value of "Mixed". |
GenderType |
hasOfferCatalog |
Indicates an OfferCatalog listing for this Organization, Person, or Service. |
OfferCatalog |
follows |
The most generic uni-directional social relation. |
Person |
birthPlace |
The place where the person was born. |
Place |
faxNumber |
The fax number. |
Text |
telephone |
The telephone number. |
Text |
taxID |
The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain. |
Text |
callSign |
A callsign, as used in broadcasting and radio communications to identify people, radio and TV stations, or vehicles. |
Text |
naics |
The North American Industry Classification System (NAICS) code for a particular organization or business person. |
Text |
deathPlace |
The place where the person died. |
Place |
alumniOf |
An organization that the person is an alumni of. |
Organization |
colleagues |
A colleague of the person. |
Person |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
Offer
An offer to transfer some rights to an item or to provide a service — for example, an offer to sell tickets to an event, to rent the DVD of a movie, to stream a TV show over the internet, to repair a motorcycle, or to loan a book.\n\nNote: As the [[businessFunction]] property, which identifies the form of offer (e.g. sell, lease, repair, dispose), defaults to http://purl.org/goodrelations/v1#Sell; an Offer without a defined businessFunction value can be assumed to be an offer to sell.\n\nFor GTIN-related fields, see Check Digit calculator and validation guide from GS1.
Property |
Definition |
Type |
hasMeasurement |
A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings. |
QuantitativeValue |
eligibleQuantity |
The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity. |
QuantitativeValue |
deliveryLeadTime |
The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup. |
QuantitativeValue |
availabilityEnds |
The end of the availability of the product or service included in the offer. |
DateTime |
seller |
An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. |
Organization |
availabilityStarts |
The beginning of the availability of the product or service included in the offer. |
Date |
areaServed |
The geographic area where a service or offered item is provided. |
Text |
advanceBookingRequirement |
The amount of time that is required between accepting the offer and the actual usage of the resource or service. |
QuantitativeValue |
priceValidUntil |
The date after which the price is no longer available. |
Date |
gtin14 |
The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details. |
Text |
reviews |
Review of the item. |
Review |
warranty |
The warranty promise(s) included in the offer. |
WarrantyPromise |
inventoryLevel |
The current approximate inventory level for the item or items. |
QuantitativeValue |
eligibleDuration |
The duration for which the given offer is valid. |
QuantitativeValue |
availability |
The availability of this item—for example In stock, Out of stock, Pre-order, etc. |
ItemAvailability |
itemCondition |
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. |
OfferItemCondition |
checkoutPageURLTemplate |
A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here. |
Text |
price |
The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.\n\nUsage guidelines:\n\n* Use the [[priceCurrency]] property (with standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including ambiguous symbols such as '~~~CONTENT~~~#39; in the value.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\n* Note that both RDFa and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. |
Text |
review |
A review of the item. |
Review |
gtin |
A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 digital link specifications express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also schema.org tracking issue for schema.org-specific discussion. 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.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. |
Text |
itemOffered |
An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
Product |
mobileUrl |
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. |
Text |
shippingDetails |
Indicates information about the shipping policies and options associated with an [[Offer]]. |
OfferShippingDetails |
hasMerchantReturnPolicy |
Specifies a MerchantReturnPolicy that may be applicable. |
MerchantReturnPolicy |
businessFunction |
The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell. |
BusinessFunction |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
leaseLength |
Length of the lease for some [[Accommodation]], either particular to some [[Offer]] or in some cases intrinsic to the property. |
QuantitativeValue |
gtin12 |
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. |
Text |
validThrough |
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours. |
Date |
hasAdultConsideration |
Used to tag an item to be intended or suitable for consumption or use by adults only. |
AdultOrientedEnumeration |
includesObject |
This links to a node or nodes indicating the exact quantity of the products included in an [[Offer]] or [[ProductCollection]]. |
TypeAndQuantityNode |
eligibleRegion |
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\n\nSee also [[ineligibleRegion]]. |
Place |
asin |
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. |
Text |
gtin8 |
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. |
Text |
ineligibleRegion |
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also [[eligibleRegion]]. |
Place |
priceSpecification |
One or more detailed price specifications, indicating the unit price and delivery or payment charges. |
PriceSpecification |
validFrom |
The date when the item becomes valid. |
Date |
eligibleTransactionVolume |
The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount. |
PriceSpecification |
mpn |
The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
Text |
category |
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
URI |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
offeredBy |
A pointer to the organization or person making the offer. |
Organization |
addOn |
An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge). |
Offer |
availableAtOrFrom |
The place(s) from which the offer can be obtained (e.g. store locations). |
Place |
priceCurrency |
The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.\n\nUse standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR". |
Text |
eligibleCustomerType |
The type(s) of customers for which the given offer is valid. |
BusinessEntityType |
gtin13 |
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. |
Text |
serialNumber |
The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer. |
Text |
sku |
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. |
Text |
acceptedPaymentMethod |
The payment method(s) accepted by seller for this offer. |
PaymentMethod |
availableDeliveryMethod |
The delivery method(s) available for this offer. |
DeliveryMethod |
QuantitativeValue
A point value or interval for product characteristics and other purposes.
Property |
Definition |
Type |
value |
The value of the quantitative value or property value node.\n\n* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type for values is 'Number'.\n* For [[PropertyValue]], it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
StructuredValue |
additionalProperty |
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. |
PropertyValue |
valueReference |
A secondary value that provides additional information on the original value, e.g. a reference temperature or a type of measurement. |
Enumeration |
unitCode |
The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon. |
Text |
maxValue |
The upper value of some characteristic or property. |
Numeric |
unitText |
A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code forunitCode. |
Text |
minValue |
The lower value of some characteristic or property. |
Numeric |
Enumeration
Lists or enumerations—for example, a list of cuisines or music genres, etc.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Class
A class, also often called a 'Type'; equivalent to rdfs:Class.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Review
A review of an item - for example, of a restaurant, movie, or store.
Property |
Definition |
Type |
reviewBody |
The actual body of the review. |
Text |
associatedMediaReview |
An associated [[MediaReview]], related by specific common content, topic or claim. The expectation is that this property would be most typically used in cases where a single activity is conducting both claim reviews and media reviews, in which case [[relatedMediaReview]] would commonly be used on a [[ClaimReview]], while [[relatedClaimReview]] would be used on [[MediaReview]]. |
Review |
associatedReview |
An associated [[Review]]. |
Review |
positiveNotes |
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). |
Text |
reviewRating |
The rating given in this review. Note that reviews can themselves be rated. The reviewRating applies to rating given by the review. The [[aggregateRating]] property applies to the review itself, as a creative work. |
Rating |
reviewAspect |
This Review or Rating is relevant to this part or facet of the itemReviewed. |
Text |
itemReviewed |
The item that is being reviewed/rated. |
Thing |
negativeNotes |
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). |
ListItem |
associatedClaimReview |
An associated [[ClaimReview]], related by specific common content, topic or claim. The expectation is that this property would be most typically used in cases where a single activity is conducting both claim reviews and media reviews, in which case [[relatedMediaReview]] would commonly be used on a [[ClaimReview]], while [[relatedClaimReview]] would be used on [[MediaReview]]. |
Review |
Rating
A rating is an evaluation on a numeric scale, such as 1 to 5 stars.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
reviewAspect |
This Review or Rating is relevant to this part or facet of the itemReviewed. |
Text |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
ratingExplanation |
A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using [[ClaimReview]]. |
Text |
bestRating |
The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed. |
Text |
ratingValue |
The rating for the content.\n\nUsage guidelines:\n\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
Numeric |
worstRating |
The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed. |
Text |
ListItem
An list item, e.g. a step in a checklist or how-to description.
Property |
Definition |
Type |
item |
An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists'). |
Thing |
nextItem |
A link to the ListItem that follows the current one. |
ListItem |
previousItem |
A link to the ListItem that precedes the current one. |
ListItem |
position |
The position of an item in a series or sequence of items. |
Text |
WarrantyPromise
A structured value representing the duration and scope of services that will be provided to a customer free of charge in case of a defect or malfunction of a product.
Property |
Definition |
Type |
warrantyScope |
The scope of the warranty promise. |
WarrantyScope |
durationOfWarranty |
The duration of the warranty promise. Common unitCode values are ANN for year, MON for months, or DAY for days. |
QuantitativeValue |
WarrantyScope
A range of services that will be provided to a customer free of charge in case of a defect or malfunction of a product.\n\nCommonly used values:\n\n* http://purl.org/goodrelations/v1#Labor-BringIn\n* http://purl.org/goodrelations/v1#PartsAndLabor-BringIn\n* http://purl.org/goodrelations/v1#PartsAndLabor-PickUp
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
ItemAvailability
A list of possible product availability options.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
OfferItemCondition
A list of possible conditions for the item.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Product
Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online.
Property |
Definition |
Type |
hasMeasurement |
A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings. |
QuantitativeValue |
countryOfAssembly |
The place where the product was assembled. |
Text |
width |
The width of the item. |
Distance |
isAccessoryOrSparePartFor |
A pointer to another product (or multiple products) for which this product is an accessory or spare part. |
Product |
isConsumableFor |
A pointer to another product (or multiple products) for which this product is a consumable. |
Product |
depth |
The depth of the item. |
QuantitativeValue |
additionalProperty |
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. |
PropertyValue |
isVariantOf |
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. |
ProductModel |
slogan |
A slogan or motto associated with the item. |
Text |
manufacturer |
The manufacturer of the product. |
Organization |
gtin14 |
The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details. |
Text |
keywords |
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. |
URI |
positiveNotes |
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). |
Text |
reviews |
Review of the item. |
Review |
height |
The height of the item. |
QuantitativeValue |
model |
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. |
ProductModel |
itemCondition |
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. |
OfferItemCondition |
award |
An award won by or for this item. |
Text |
nsn |
Indicates the NATO stock number (nsn) of a [[Product]]. |
Text |
awards |
Awards won by or for this item. |
Text |
review |
A review of the item. |
Review |
gtin |
A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 digital link specifications express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also schema.org tracking issue for schema.org-specific discussion. 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.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. |
Text |
isRelatedTo |
A pointer to another, somehow related product (or multiple products). |
Product |
negativeNotes |
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). |
ListItem |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
mobileUrl |
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. |
Text |
hasEnergyConsumptionDetails |
Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard. |
EnergyConsumptionDetails |
weight |
The weight of the product or person. |
QuantitativeValue |
hasMerchantReturnPolicy |
Specifies a MerchantReturnPolicy that may be applicable. |
MerchantReturnPolicy |
pattern |
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. |
DefinedTerm |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
gtin12 |
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. |
Text |
isSimilarTo |
A pointer to another, functionally similar product (or multiple products). |
Product |
productID |
The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789" . |
Text |
countryOfOrigin |
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. |
Country |
hasAdultConsideration |
Used to tag an item to be intended or suitable for consumption or use by adults only. |
AdultOrientedEnumeration |
purchaseDate |
The date the item, e.g. vehicle, was purchased by the current owner. |
Date |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
logo |
An associated logo. |
ImageObject |
countryOfLastProcessing |
The place where the item (typically [[Product]]) was last processed and tested before importation. |
Text |
asin |
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. |
Text |
gtin8 |
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. |
Text |
releaseDate |
The release date of a product or product model. This can be used to distinguish the exact variant of a product. |
Date |
brand |
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. |
Brand |
productionDate |
The date of production of the item, e.g. vehicle. |
Date |
inProductGroupWithID |
Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]]. |
Text |
size |
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. |
DefinedTerm |
mpn |
The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
Text |
category |
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
URI |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
color |
The color of the product. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
offers |
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. |
Demand |
gtin13 |
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. |
Text |
sku |
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. |
Text |
Distance
Properties that take Distances as values are of the form '<Number> <Length unit of measure>'. E.g., '7 ft'.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
Quantity
Quantities such as distance, time, mass, weight, etc. Particular instances of say Mass are entities like '3 kg' or '4 milligrams'.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
ProductModel
A datasheet or vendor specification of a product (in the sense of a prototypical description).
Property |
Definition |
Type |
hasMeasurement |
A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings. |
QuantitativeValue |
countryOfAssembly |
The place where the product was assembled. |
Text |
width |
The width of the item. |
Distance |
isAccessoryOrSparePartFor |
A pointer to another product (or multiple products) for which this product is an accessory or spare part. |
Product |
isConsumableFor |
A pointer to another product (or multiple products) for which this product is a consumable. |
Product |
depth |
The depth of the item. |
QuantitativeValue |
additionalProperty |
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. |
PropertyValue |
slogan |
A slogan or motto associated with the item. |
Text |
manufacturer |
The manufacturer of the product. |
Organization |
gtin14 |
The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details. |
Text |
keywords |
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. |
URI |
positiveNotes |
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). |
Text |
reviews |
Review of the item. |
Review |
height |
The height of the item. |
QuantitativeValue |
model |
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. |
ProductModel |
itemCondition |
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. |
OfferItemCondition |
award |
An award won by or for this item. |
Text |
nsn |
Indicates the NATO stock number (nsn) of a [[Product]]. |
Text |
awards |
Awards won by or for this item. |
Text |
review |
A review of the item. |
Review |
gtin |
A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 digital link specifications express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also schema.org tracking issue for schema.org-specific discussion. 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.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. |
Text |
isRelatedTo |
A pointer to another, somehow related product (or multiple products). |
Product |
negativeNotes |
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). |
ListItem |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
mobileUrl |
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. |
Text |
hasEnergyConsumptionDetails |
Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard. |
EnergyConsumptionDetails |
weight |
The weight of the product or person. |
QuantitativeValue |
hasMerchantReturnPolicy |
Specifies a MerchantReturnPolicy that may be applicable. |
MerchantReturnPolicy |
pattern |
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. |
DefinedTerm |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
gtin12 |
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. |
Text |
isSimilarTo |
A pointer to another, functionally similar product (or multiple products). |
Product |
productID |
The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789" . |
Text |
countryOfOrigin |
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. |
Country |
hasAdultConsideration |
Used to tag an item to be intended or suitable for consumption or use by adults only. |
AdultOrientedEnumeration |
purchaseDate |
The date the item, e.g. vehicle, was purchased by the current owner. |
Date |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
logo |
An associated logo. |
ImageObject |
countryOfLastProcessing |
The place where the item (typically [[Product]]) was last processed and tested before importation. |
Text |
asin |
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. |
Text |
gtin8 |
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. |
Text |
releaseDate |
The release date of a product or product model. This can be used to distinguish the exact variant of a product. |
Date |
brand |
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. |
Brand |
productionDate |
The date of production of the item, e.g. vehicle. |
Date |
inProductGroupWithID |
Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]]. |
Text |
size |
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. |
DefinedTerm |
mpn |
The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
Text |
category |
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
URI |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
color |
The color of the product. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
offers |
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. |
Demand |
gtin13 |
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. |
Text |
sku |
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. |
Text |
isVariantOf |
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. |
ProductModel |
successorOf |
A pointer from a newer variant of a product to its previous, often discontinued predecessor. |
ProductModel |
predecessorOf |
A pointer from a previous, often discontinued variant of the product to its newer variant. |
ProductModel |
Grant
A grant, typically financial or otherwise quantifiable, of resources. Typically a [[funder]] sponsors some [[MonetaryAmount]] to an [[Organization]] or [[Person]], sometimes not necessarily via a dedicated or long-lived [[Project]], resulting in one or more outputs, or [[fundedItem]]s. For financial sponsorship, indicate the [[funder]] of a [[MonetaryGrant]]. For non-financial support, indicate [[sponsor]] of [[Grant]]s of resources (e.g. office space).Grants support activities directed towards some agreed collective goals, often but not always organized as [[Project]]s. Long-lived projects are sometimes sponsored by a variety of grants over time, but it is also common for a project to be associated with a single grant.The amount of a [[Grant]] is represented using [[amount]] as a [[MonetaryAmount]].
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
fundedItem |
Indicates something directly or indirectly funded or sponsored through a [[Grant]]. See also [[ownershipFundingInfo]]. |
Organization |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
EnergyConsumptionDetails
EnergyConsumptionDetails represents information related to the energy efficiency of a product that consumes energy. The information that can be provided is based on international regulations such as for example EU directive 2017/1369 for energy labeling and the Energy labeling rule under the Energy Policy and Conservation Act (EPCA) in the US.
Property |
Definition |
Type |
hasEnergyEfficiencyCategory |
Defines the energy efficiency Category (which could be either a rating out of range of values or a yes/no certification) for a product according to an international energy efficiency standard. |
EnergyEfficiencyEnumeration |
energyEfficiencyScaleMin |
Specifies the least energy efficient class on the regulated EU energy consumption scale for the product category a product belongs to. For example, energy consumption for televisions placed on the market after January 1, 2020 is scaled from D to A+++. |
EUEnergyEfficiencyEnumeration |
energyEfficiencyScaleMax |
Specifies the most energy efficient class on the regulated EU energy consumption scale for the product category a product belongs to. For example, energy consumption for televisions placed on the market after January 1, 2020 is scaled from D to A+++. |
EUEnergyEfficiencyEnumeration |
EnergyEfficiencyEnumeration
Enumerates energy efficiency levels (also known as "classes" or "ratings") and certifications that are part of several international energy efficiency standards.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
EUEnergyEfficiencyEnumeration
Enumerates the EU energy efficiency classes A-G as well as A+, A++, and A+++ as defined in EU directive 2017/1369.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
MerchantReturnPolicy
A MerchantReturnPolicy provides information about product return policies associated with an [[Organization]], [[Product]], or [[Offer]].
Property |
Definition |
Type |
refundType |
A refund type, from an enumerated list. |
RefundTypeEnumeration |
customerRemorseReturnFees |
The type of return fees if the product is returned due to customer remorse. |
ReturnFeesEnumeration |
additionalProperty |
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. |
PropertyValue |
itemDefectReturnLabelSource |
The method (from an enumeration) by which the customer obtains a return shipping label for a defect product. |
ReturnLabelSourceEnumeration |
inStoreReturnsOffered |
Are in-store returns offered? (For more advanced return methods use the [[returnMethod]] property.) |
Indicator |
itemCondition |
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. |
OfferItemCondition |
restockingFee |
Use [[MonetaryAmount]] to specify a fixed restocking fee for product returns, or use [[Number]] to specify a percentage of the product price paid by the customer. |
MonetaryAmount |
returnPolicyCategory |
Specifies an applicable return policy (from an enumeration). |
MerchantReturnEnumeration |
returnLabelSource |
The method (from an enumeration) by which the customer obtains a return shipping label for a product returned for any reason. |
ReturnLabelSourceEnumeration |
applicableCountry |
A country where a particular merchant return policy applies to, for example the two-letter ISO 3166-1 alpha-2 country code. |
Country |
returnMethod |
The type of return method offered, specified from an enumeration. |
ReturnMethodEnumeration |
returnShippingFeesAmount |
Amount of shipping costs for product returns (for any reason). Applicable when property [[returnFees]] equals [[ReturnShippingFees]]. |
MonetaryAmount |
itemDefectReturnShippingFeesAmount |
Amount of shipping costs for defect product returns. Applicable when property [[itemDefectReturnFees]] equals [[ReturnShippingFees]]. |
MonetaryAmount |
returnPolicySeasonalOverride |
Seasonal override of a return policy. |
MerchantReturnPolicySeasonalOverride |
customerRemorseReturnShippingFeesAmount |
The amount of shipping costs if a product is returned due to customer remorse. Applicable when property [[customerRemorseReturnFees]] equals [[ReturnShippingFees]]. |
MonetaryAmount |
returnFees |
The type of return fees for purchased products (for any return reason). |
ReturnFeesEnumeration |
customerRemorseReturnLabelSource |
The method (from an enumeration) by which the customer obtains a return shipping label for a product returned due to customer remorse. |
ReturnLabelSourceEnumeration |
merchantReturnLink |
Specifies a Web page or service by URL, for product returns. |
URI |
itemDefectReturnFees |
The type of return fees for returns of defect products. |
ReturnFeesEnumeration |
merchantReturnDays |
Specifies either a fixed return date or the number of days (from the delivery date) that a product can be returned. Used when the [[returnPolicyCategory]] property is specified as [[MerchantReturnFiniteReturnWindow]]. |
DateTime |
returnPolicyCountry |
The country where the product has to be sent to for returns, for example "Ireland" using the [[name]] property of [[Country]]. You can also provide the two-letter ISO 3166-1 alpha-2 country code. Note that this can be different from the country where the product was originally shipped from or sent to. |
Country |
RefundTypeEnumeration
Enumerates several kinds of product return refund types.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
ReturnFeesEnumeration
Enumerates several kinds of policies for product return fees.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
ReturnLabelSourceEnumeration
Enumerates several types of return labels for product returns.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
MonetaryAmount
A monetary value or range. This type can be used to describe an amount of money such as $50 USD, or a range as in describing a bank account being suitable for a balance between £1,000 and £1,000,000 GBP, or the value of a salary, etc. It is recommended to use [[PriceSpecification]] Types to describe the price of an Offer, Invoice, etc.
Property |
Definition |
Type |
value |
The value of the quantitative value or property value node.\n\n* For [[QuantitativeValue]] and [[MonetaryAmount]], the recommended type for values is 'Number'.\n* For [[PropertyValue]], it can be 'Text', 'Number', 'Boolean', or 'StructuredValue'.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
StructuredValue |
currency |
The currency in which the monetary amount is expressed.\n\nUse standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR". |
Text |
validThrough |
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours. |
Date |
maxValue |
The upper value of some characteristic or property. |
Numeric |
validFrom |
The date when the item becomes valid. |
Date |
minValue |
The lower value of some characteristic or property. |
Numeric |
MerchantReturnEnumeration
Enumerates several kinds of product return policies.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Country
A country.
Property |
Definition |
Type |
geoCovers |
Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in DE-9IM. |
GeospatialGeometry |
longitude |
The longitude of a location. For example -122.08585 (WGS 84). |
Text |
smokingAllowed |
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room. |
Indicator |
isicV4 |
The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place. |
Text |
globalLocationNumber |
The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. |
Text |
amenityFeature |
An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs. |
LocationFeatureSpecification |
additionalProperty |
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. |
PropertyValue |
slogan |
A slogan or motto associated with the item. |
Text |
photos |
Photographs of this place. |
ImageObject |
keywords |
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. |
URI |
reviews |
Review of the item. |
Review |
tourBookingPage |
A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate. |
URI |
geoWithin |
Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in DE-9IM. |
GeospatialGeometry |
containsPlace |
The basic containment relation between a place and another that it contains. |
Place |
review |
A review of the item. |
Review |
hasMap |
A URL to a map of the place. |
URI |
containedIn |
The basic containment relation between a place and one that contains it. |
Place |
events |
Upcoming or past events associated with this place or organization. |
Event |
geoOverlaps |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in DE-9IM. |
GeospatialGeometry |
geoEquals |
Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in DE-9IM. "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship). |
GeospatialGeometry |
maps |
A URL to a map of the place. |
URI |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
event |
Upcoming or past event associated with this place, organization, or action. |
Event |
photo |
A photograph of this place. |
Photograph |
containedInPlace |
The basic containment relation between a place and one that contains it. |
Place |
logo |
An associated logo. |
ImageObject |
geoCrosses |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in DE-9IM. |
GeospatialGeometry |
address |
Physical address of the item. |
Text |
geo |
The geo coordinates of the place. |
GeoCoordinates |
openingHoursSpecification |
The opening hours of a certain place. |
OpeningHoursSpecification |
geoDisjoint |
Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoIntersects |
Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in DE-9IM. |
GeospatialGeometry |
latitude |
The latitude of a location. For example 37.42242 (WGS 84). |
Numeric |
maximumAttendeeCapacity |
The total number of individuals that may attend an event or venue. |
Integer |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
map |
A URL to a map of the place. |
URI |
branchCode |
A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.\n\nFor example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. |
Text |
faxNumber |
The fax number. |
Text |
publicAccess |
A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value |
Indicator |
geoTouches |
Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in DE-9IM.) |
GeospatialGeometry |
geoCoveredBy |
Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in DE-9IM. |
GeospatialGeometry |
telephone |
The telephone number. |
Text |
hasDriveThroughService |
Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users. |
Indicator |
specialOpeningHoursSpecification |
The special opening hours of a certain place.\n\nUse this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]]. |
OpeningHoursSpecification |
geoContains |
Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in DE-9IM. |
Place |
ImageObject
An image file.
Property |
Definition |
Type |
caption |
The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]]. |
MediaObject |
thumbnail |
Thumbnail image for an image or video. |
ImageObject |
exifData |
exif data for this object. |
Text |
embeddedTextCaption |
Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'. |
Text |
representativeOfPage |
Indicates whether this image is representative of the content of the page. |
Indicator |
MediaObject
A media object, such as an image, video, or audio object embedded in a web page or a downloadable dataset, i.e. DataDownload. Note that a creative work may have many media objects associated with it on the same web page. For example, a page about a single song (MusicRecording) may have a music video (VideoObject), and a high and low bandwidth audio stream (2 [[AudioObject]]s).
Property |
Definition |
Type |
embedUrl |
A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag. |
URI |
bitrate |
The bitrate of the media object. |
Text |
width |
The width of the item. |
Distance |
sha256 |
The SHA-2 SHA256 hash of the content of the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855' |
Text |
endTime |
The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
startTime |
The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
contentSize |
File size in (mega/kilo)bytes. |
Text |
height |
The height of the item. |
QuantitativeValue |
playerType |
Player type required—for example, Flash or Silverlight. |
Text |
associatedArticle |
A NewsArticle associated with the Media Object. |
NewsArticle |
interpretedAsClaim |
Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]]. |
Claim |
duration |
The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. |
Duration |
requiresSubscription |
Indicates if use of the media require a subscription (either paid or free). Allowed values are true or false (note that an earlier version had 'yes', 'no'). |
MediaSubscription |
regionsAllowed |
The regions where the media is allowed. If not specified, then it's assumed to be allowed everywhere. Specify the countries in ISO 3166 format. |
Place |
contentUrl |
Actual bytes of the media object, for example the image file or video file. |
URI |
productionCompany |
The production company or studio responsible for the item, e.g. series, video game, episode etc. |
Organization |
encodesCreativeWork |
The CreativeWork encoded by this media object. |
CreativeWork |
uploadDate |
Date when this media object was uploaded to this site. |
Date |
ineligibleRegion |
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also [[eligibleRegion]]. |
Place |
encodingFormat |
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
URI |
NewsArticle
A NewsArticle is an article whose content reports news, or provides background context and supporting materials for understanding the news.A more detailed overview of schema.org News markup is also available.
Property |
Definition |
Type |
printColumn |
The number of the column in which the NewsArticle appears in the print edition. |
Text |
printEdition |
The edition of the print product in which the NewsArticle appears. |
Text |
printSection |
If this NewsArticle appears in print, this field indicates the print section in which the article appeared. |
Text |
printPage |
If this NewsArticle appears in print, this field indicates the name of the page on which the article is found. Please note that this field is intended for the exact page name (e.g. A5, B18). |
Text |
dateline |
A dateline is a brief piece of text included in news articles that describes where and when the story was written or filed though the date is often omitted. Sometimes only a placename is provided.Structured representations of dateline-related information can also be expressed more explicitly using [[locationCreated]] (which represents where a work was created, e.g. where a news report was written). For location depicted or described in the content, use [[contentLocation]].Dateline summaries are oriented more towards human readers than towards automated processing, and can vary substantially. Some examples: "BEIRUT, Lebanon, June 2.", "Paris, France", "December 19, 2017 11:43AM Reporting from Washington", "Beijing/Moscow", "QUEZON CITY, Philippines". |
Text |
Claim
A [[Claim]] in Schema.org represents a specific, factually-oriented claim that could be the [[itemReviewed]] in a [[ClaimReview]]. The content of a claim can be summarized with the [[text]] property. Variations on well known claims can have their common identity indicated via [[sameAs]] links, and summarized with a [[name]]. Ideally, a [[Claim]] description includes enough contextual information to minimize the risk of ambiguity or inclarity. In practice, many claims are better understood in the context in which they appear or the interpretations provided by claim reviews. Beyond [[ClaimReview]], the Claim type can be associated with related creative works - for example a [[ScholarlyArticle]] or [[Question]] might be [[about]] some [[Claim]]. At this time, Schema.org does not define any types of relationship between claims. This is a natural area for future exploration.
Property |
Definition |
Type |
claimInterpreter |
For a [[Claim]] interpreted from [[MediaObject]] content sed to indicate a claim contained, implied or refined from the content of a [[MediaObject]]. |
Organization |
appearance |
Indicates an occurrence of a [[Claim]] in some [[CreativeWork]]. |
CreativeWork |
firstAppearance |
Indicates the first known occurrence of a [[Claim]] in some [[CreativeWork]]. |
CreativeWork |
CreativeWork
The most generic kind of creative work, including books, movies, photographs, software programs, etc.
Property |
Definition |
Type |
workTranslation |
A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
CreativeWork |
educationalLevel |
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
Text |
associatedMedia |
A media object that encodes this CreativeWork. This property is a synonym for encoding. |
MediaObject |
exampleOfWork |
A creative work that this work is an example/instance/realization/derivation of. |
CreativeWork |
releasedEvent |
The place and time the release was issued, expressed as a PublicationEvent. |
PublicationEvent |
version |
The version of the CreativeWork embodied by a specified resource. |
Numeric |
locationCreated |
The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. |
Place |
acquireLicensePage |
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
CreativeWork |
thumbnailUrl |
A thumbnail image relevant to the Thing. |
URI |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
expires |
Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. |
Date |
contentLocation |
The location depicted or described in the content. For example, the location in a photograph or painting. |
Place |
educationalUse |
The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
DefinedTerm |
copyrightHolder |
The party holding the legal copyright to the CreativeWork. |
Organization |
accessibilityControl |
Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the approved vocabulary. |
Text |
maintainer |
A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
Person |
educationalAlignment |
An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. |
AlignmentObject |
spatial |
The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. |
Place |
publisher |
The publisher of the creative work. |
Organization |
keywords |
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. |
URI |
assesses |
The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
DefinedTerm |
reviews |
Review of the item. |
Review |
isBasedOn |
A resource from which this work is derived or from which it is a modification or adaption. |
URI |
mentions |
Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. |
Thing |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
contributor |
A secondary contributor to the CreativeWork or Event. |
Organization |
license |
A license document that applies to this content, typically indicated by URL. |
URI |
citation |
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
CreativeWork |
accessibilitySummary |
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." |
Text |
award |
An award won by or for this item. |
Text |
commentCount |
The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. |
Integer |
temporalCoverage |
The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
URI |
dateCreated |
The date on which the CreativeWork was created or the item was added to a DataFeed. |
DateTime |
discussionUrl |
A link to the page containing the comments of the CreativeWork. |
URI |
copyrightNotice |
Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. |
Text |
learningResourceType |
The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
DefinedTerm |
awards |
Awards won by or for this item. |
Text |
accessModeSufficient |
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the approved vocabulary. |
ItemList |
review |
A review of the item. |
Review |
conditionsOfAccess |
Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". |
Text |
interactivityType |
The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
Text |
abstract |
An abstract is a short description that summarizes a [[CreativeWork]]. |
Text |
fileFormat |
Media type, typically MIME format (see IANA site) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
Text |
interpretedAsClaim |
Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]]. |
Claim |
text |
The textual content of this CreativeWork. |
Text |
archivedAt |
Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content. |
WebPage |
alternativeHeadline |
A secondary title of the CreativeWork. |
Text |
creditText |
Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. |
Text |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
workExample |
Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book. |
CreativeWork |
about |
The subject matter of the content. |
Thing |
encodings |
A media object that encodes this CreativeWork. |
MediaObject |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
video |
An embedded video object. |
VideoObject |
isPartOf |
Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
URI |
pattern |
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. |
DefinedTerm |
editor |
Specifies the Person who edited the CreativeWork. |
Person |
dateModified |
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
DateTime |
translationOfWork |
The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”. |
CreativeWork |
creativeWorkStatus |
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
DefinedTerm |
isBasedOnUrl |
A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
URI |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
contentReferenceTime |
The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. |
DateTime |
correction |
Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
URI |
sdDatePublished |
Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] |
Date |
comment |
Comments, typically from users. |
Comment |
countryOfOrigin |
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. |
Country |
timeRequired |
Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. |
Duration |
typicalAgeRange |
The typical expected age range, e.g. '7-9', '11-'. |
Text |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
producer |
The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.). |
Organization |
schemaVersion |
Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. 10.0 as a simple string, or more explicitly via URL, https://schema.org/docs/releases.html#v10.0 . There may be situations in which other schemas might usefully be referenced this way, e.g. http://dublincore.org/specifications/dublin-core/dces/1999-07-02/ but this has not been carefully explored in the community. |
URI |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
encoding |
A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. |
MediaObject |
publisherImprint |
The publishing division which published the comic. |
Organization |
accessibilityAPI |
Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the approved vocabulary. |
Text |
sdPublisher |
Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The |
Organization |
audio |
An embedded audio object. |
MusicRecording |
accessibilityFeature |
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the approved vocabulary. |
Text |
spatialCoverage |
The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. |
Place |
accessMode |
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the approved vocabulary. |
Text |
editEIDR |
An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
URI |
usageInfo |
The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
URI |
position |
The position of an item in a series or sequence of items. |
Text |
encodingFormat |
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
URI |
copyrightYear |
The year during which the claimed copyright for the CreativeWork was first asserted. |
Numeric |
mainEntity |
Indicates the primary entity described in some page or other CreativeWork. |
Thing |
creator |
The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
Person |
teaches |
The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
DefinedTerm |
temporal |
The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
DateTime |
size |
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. |
DefinedTerm |
translator |
Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
accountablePerson |
Specifies the Person that is legally accountable for the CreativeWork. |
Person |
accessibilityHazard |
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the approved vocabulary. |
Text |
contentRating |
Official rating of a piece of content—for example, 'MPAA PG-13'. |
Text |
recordedAt |
The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. |
Event |
publication |
A publication event associated with the item. |
PublicationEvent |
sdLicense |
A license document that applies to this structured data, typically indicated by URL. |
CreativeWork |
headline |
Headline of the article. |
Text |
materialExtent |
undefined |
QuantitativeValue |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
datePublished |
Date of first broadcast/publication. |
DateTime |
offers |
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. |
Demand |
hasPart |
Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). |
CreativeWork |
sourceOrganization |
The Organization on whose behalf the creator was working. |
Organization |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
character |
Fictional person connected with a creative work. |
Person |
PublicationEvent
A PublicationEvent corresponds indifferently to the event of publication for a CreativeWork of any type, e.g. a broadcast event, an on-demand event, a book/journal publication via a variety of delivery media.
Property |
Definition |
Type |
publishedBy |
An agent associated with the publication event. |
Organization |
free |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
publishedOn |
A broadcast service associated with the publication event. |
BroadcastService |
BroadcastService
A delivery service through which content is provided via broadcast over the air or online.
Property |
Definition |
Type |
hasBroadcastChannel |
A broadcast channel of a broadcast service. |
BroadcastChannel |
parentService |
A broadcast service to which the broadcast service may belong to such as regional variations of a national channel. |
BroadcastService |
broadcastAffiliateOf |
The media network(s) whose content is broadcast on this station. |
Organization |
broadcaster |
The organization owning or operating the broadcast service. |
Organization |
videoFormat |
The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.). |
Text |
broadcastTimezone |
The timezone in ISO 8601 format for which the service bases its broadcasts. |
Text |
broadcastDisplayName |
The name displayed in the channel guide. For many US affiliates, it is the network name. |
Text |
broadcastFrequency |
The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM". |
Text |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
area |
The area within which users can expect to reach the broadcast service. |
Place |
callSign |
A callsign, as used in broadcasting and radio communications to identify people, radio and TV stations, or vehicles. |
Text |
BroadcastChannel
A unique instance of a BroadcastService on a CableOrSatelliteService lineup.
Property |
Definition |
Type |
broadcastChannelId |
The unique address by which the BroadcastService can be identified in a provider lineup. In US, this is typically a number. |
Text |
providesBroadcastService |
The BroadcastService offered on this channel. |
BroadcastService |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
broadcastServiceTier |
The type of service required to have access to the channel (e.g. Standard or Premium). |
Text |
inBroadcastLineup |
The CableOrSatelliteService offering the channel. |
CableOrSatelliteService |
broadcastFrequency |
The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM". |
Text |
CableOrSatelliteService
A service which provides access to media programming like TV or radio. Access may be via cable or satellite.
Property |
Definition |
Type |
serviceArea |
The geographic area where the service is provided. |
AdministrativeArea |
broker |
An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. |
Person |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
areaServed |
The geographic area where a service or offered item is provided. |
Text |
slogan |
A slogan or motto associated with the item. |
Text |
award |
An award won by or for this item. |
Text |
termsOfService |
Human-readable terms of service documentation. |
URI |
review |
A review of the item. |
Review |
availableChannel |
A means of accessing the service (e.g. a phone bank, a web site, a location, etc.). |
ServiceChannel |
isRelatedTo |
A pointer to another, somehow related product (or multiple products). |
Product |
serviceAudience |
The audience eligible for this service. |
Audience |
isSimilarTo |
A pointer to another, functionally similar product (or multiple products). |
Product |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
logo |
An associated logo. |
ImageObject |
providerMobility |
Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). |
Text |
hoursAvailable |
The hours during which this service or contact is available. |
OpeningHoursSpecification |
brand |
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. |
Brand |
serviceOutput |
The tangible thing generated by the service, e.g. a passport, permit, etc. |
Thing |
produces |
The tangible thing generated by the service, e.g. a passport, permit, etc. |
Thing |
hasOfferCatalog |
Indicates an OfferCatalog listing for this Organization, Person, or Service. |
OfferCatalog |
category |
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
URI |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
serviceType |
The type of service being offered, e.g. veterans' benefits, emergency relief, etc. |
Text |
offers |
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. |
Demand |
Service
A service provided by an organization, e.g. delivery service, print services, etc.
Property |
Definition |
Type |
serviceArea |
The geographic area where the service is provided. |
AdministrativeArea |
broker |
An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. |
Person |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
areaServed |
The geographic area where a service or offered item is provided. |
Text |
slogan |
A slogan or motto associated with the item. |
Text |
award |
An award won by or for this item. |
Text |
termsOfService |
Human-readable terms of service documentation. |
URI |
review |
A review of the item. |
Review |
availableChannel |
A means of accessing the service (e.g. a phone bank, a web site, a location, etc.). |
ServiceChannel |
isRelatedTo |
A pointer to another, somehow related product (or multiple products). |
Product |
serviceAudience |
The audience eligible for this service. |
Audience |
isSimilarTo |
A pointer to another, functionally similar product (or multiple products). |
Product |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
logo |
An associated logo. |
ImageObject |
providerMobility |
Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). |
Text |
hoursAvailable |
The hours during which this service or contact is available. |
OpeningHoursSpecification |
brand |
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. |
Brand |
serviceOutput |
The tangible thing generated by the service, e.g. a passport, permit, etc. |
Thing |
produces |
The tangible thing generated by the service, e.g. a passport, permit, etc. |
Thing |
hasOfferCatalog |
Indicates an OfferCatalog listing for this Organization, Person, or Service. |
OfferCatalog |
category |
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
URI |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
serviceType |
The type of service being offered, e.g. veterans' benefits, emergency relief, etc. |
Text |
offers |
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. |
Demand |
ServiceChannel
A means for accessing a service, e.g. a government office location, web site, or phone number.
Property |
Definition |
Type |
servicePhone |
The phone number to use to access the service. |
ContactPoint |
availableLanguage |
A language someone may use with or at the item, service or place. Please use one of the language codes from the IETF BCP 47 standard. See also [[inLanguage]]. |
Text |
serviceUrl |
The website to access the service. |
URI |
processingTime |
Estimated processing time for the service using this channel. |
Duration |
servicePostalAddress |
The address for accessing the service by mail. |
PostalAddress |
providesService |
The service provided by this channel. |
Service |
serviceSmsNumber |
The number to access the service by text message. |
ContactPoint |
serviceLocation |
The location (e.g. civic structure, local business, etc.) where a person can go to access the service. |
Place |
ContactPoint
A contact point—for example, a Customer Complaints department.
Property |
Definition |
Type |
serviceArea |
The geographic area where the service is provided. |
AdministrativeArea |
availableLanguage |
A language someone may use with or at the item, service or place. Please use one of the language codes from the IETF BCP 47 standard. See also [[inLanguage]]. |
Text |
productSupported |
The product or service this support contact point is related to (such as product support for a particular product line). This can be a specific product or product line (e.g. "iPhone") or a general category of products or services (e.g. "smartphones"). |
Text |
areaServed |
The geographic area where a service or offered item is provided. |
Text |
contactOption |
An option available on this contact point (e.g. a toll-free number or support for hearing-impaired callers). |
ContactPointOption |
email |
Email address. |
Text |
contactType |
A person or organization can have different contact points, for different purposes. For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point. |
Text |
hoursAvailable |
The hours during which this service or contact is available. |
OpeningHoursSpecification |
faxNumber |
The fax number. |
Text |
telephone |
The telephone number. |
Text |
ContactPointOption
Enumerated options related to a ContactPoint.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
OpeningHoursSpecification
A structured value providing information about the opening hours of a place or a certain service inside a place.\n\nThe place is open if the [[opens]] property is specified, and closed otherwise.\n\nIf the value for the [[closes]] property is less than the value for the [[opens]] property then the hour range is assumed to span over the next day.
Property |
Definition |
Type |
closes |
The closing hour of the place or service on the given day(s) of the week. |
DateTime |
validThrough |
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours. |
Date |
opens |
The opening hour of the place or service on the given day(s) of the week. |
DateTime |
validFrom |
The date when the item becomes valid. |
Date |
dayOfWeek |
The day of the week for which these opening hours are valid. |
DayOfWeek |
DayOfWeek
The day of the week, e.g. used to specify to which day the opening hours of an OpeningHoursSpecification refer.Originally, URLs from GoodRelations were used (for [[Monday]], [[Tuesday]], [[Wednesday]], [[Thursday]], [[Friday]], [[Saturday]], [[Sunday]] plus a special entry for [[PublicHolidays]]); these have now been integrated directly into schema.org.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Duration
Quantity: Duration (use ISO 8601 duration format).
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
PostalAddress
The mailing address.
Property |
Definition |
Type |
addressLocality |
The locality in which the street address is, and which is in the region. For example, Mountain View. |
Text |
postOfficeBoxNumber |
The post office box number for PO box addresses. |
Text |
streetAddress |
The street address. For example, 1600 Amphitheatre Pkwy. |
Text |
addressCountry |
The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code. |
Country |
postalCode |
The postal code. For example, 94043. |
Text |
addressRegion |
The region in which the locality is, and which is in the country. For example, California or another appropriate first-level Administrative division. |
Text |
Audience
Intended audience for an item, i.e. the group for whom the item was created.
Property |
Definition |
Type |
audienceType |
The target group associated with a given audience (e.g. veterans, car owners, musicians, etc.). |
Text |
geographicArea |
The geographic area associated with the audience. |
AdministrativeArea |
Brand
A brand is a name used by an organization or business person for labeling a product, product group, or similar.
Property |
Definition |
Type |
slogan |
A slogan or motto associated with the item. |
Text |
review |
A review of the item. |
Review |
logo |
An associated logo. |
ImageObject |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
AggregateRating
The average rating based on multiple ratings or reviews.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
reviewAspect |
This Review or Rating is relevant to this part or facet of the itemReviewed. |
Text |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
ratingExplanation |
A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using [[ClaimReview]]. |
Text |
bestRating |
The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed. |
Text |
ratingValue |
The rating for the content.\n\nUsage guidelines:\n\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator. |
Numeric |
worstRating |
The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed. |
Text |
itemReviewed |
The item that is being reviewed/rated. |
Thing |
ratingCount |
The count of total number of ratings. |
Integer |
reviewCount |
The count of total number of reviews. |
Integer |
OfferCatalog
An OfferCatalog is an ItemList that contains related Offers and/or further OfferCatalogs that are offeredBy the same provider.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
itemListOrder |
Type of ordering (e.g. Ascending, Descending, Unordered). |
ItemListOrderType |
numberOfItems |
The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list. |
Integer |
itemListElement |
For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.\n\nText values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.\n\nNote: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases. |
ListItem |
ItemList
A list of items of any sort—for example, Top 10 Movies About Weathermen, or Top 100 Party Songs. Not to be confused with HTML lists, which are often used only for formatting.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
itemListOrder |
Type of ordering (e.g. Ascending, Descending, Unordered). |
ItemListOrderType |
numberOfItems |
The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list. |
Integer |
itemListElement |
For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.\n\nText values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.\n\nNote: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases. |
ListItem |
ItemListOrderType
Enumerated for values for itemListOrder for indicating how an ordered ItemList is organized.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Demand
A demand entity represents the public, not necessarily binding, not necessarily exclusive, announcement by an organization or person to seek a certain type of goods or services. For describing demand using this type, the very same properties used for Offer apply.
Property |
Definition |
Type |
eligibleQuantity |
The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity. |
QuantitativeValue |
deliveryLeadTime |
The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup. |
QuantitativeValue |
availabilityEnds |
The end of the availability of the product or service included in the offer. |
DateTime |
seller |
An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. |
Organization |
availabilityStarts |
The beginning of the availability of the product or service included in the offer. |
Date |
areaServed |
The geographic area where a service or offered item is provided. |
Text |
advanceBookingRequirement |
The amount of time that is required between accepting the offer and the actual usage of the resource or service. |
QuantitativeValue |
gtin14 |
The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details. |
Text |
warranty |
The warranty promise(s) included in the offer. |
WarrantyPromise |
inventoryLevel |
The current approximate inventory level for the item or items. |
QuantitativeValue |
eligibleDuration |
The duration for which the given offer is valid. |
QuantitativeValue |
availability |
The availability of this item—for example In stock, Out of stock, Pre-order, etc. |
ItemAvailability |
itemCondition |
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. |
OfferItemCondition |
gtin |
A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 digital link specifications express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also schema.org tracking issue for schema.org-specific discussion. 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.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. |
Text |
itemOffered |
An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. |
Product |
businessFunction |
The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell. |
BusinessFunction |
gtin12 |
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. |
Text |
validThrough |
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours. |
Date |
includesObject |
This links to a node or nodes indicating the exact quantity of the products included in an [[Offer]] or [[ProductCollection]]. |
TypeAndQuantityNode |
eligibleRegion |
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\n\nSee also [[ineligibleRegion]]. |
Place |
asin |
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. |
Text |
gtin8 |
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. |
Text |
ineligibleRegion |
The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also [[eligibleRegion]]. |
Place |
priceSpecification |
One or more detailed price specifications, indicating the unit price and delivery or payment charges. |
PriceSpecification |
validFrom |
The date when the item becomes valid. |
Date |
eligibleTransactionVolume |
The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount. |
PriceSpecification |
mpn |
The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
Text |
availableAtOrFrom |
The place(s) from which the offer can be obtained (e.g. store locations). |
Place |
eligibleCustomerType |
The type(s) of customers for which the given offer is valid. |
BusinessEntityType |
gtin13 |
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. |
Text |
serialNumber |
The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer. |
Text |
sku |
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. |
Text |
acceptedPaymentMethod |
The payment method(s) accepted by seller for this offer. |
PaymentMethod |
availableDeliveryMethod |
The delivery method(s) available for this offer. |
DeliveryMethod |
BusinessFunction
The business function specifies the type of activity or access (i.e., the bundle of rights) offered by the organization or business person through the offer. Typical are sell, rental or lease, maintenance or repair, manufacture / produce, recycle / dispose, engineering / construction, or installation. Proprietary specifications of access rights are also instances of this class.\n\nCommonly used values:\n\n* http://purl.org/goodrelations/v1#ConstructionInstallation\n* http://purl.org/goodrelations/v1#Dispose\n* http://purl.org/goodrelations/v1#LeaseOut\n* http://purl.org/goodrelations/v1#Maintain\n* http://purl.org/goodrelations/v1#ProvideService\n* http://purl.org/goodrelations/v1#Repair\n* http://purl.org/goodrelations/v1#Sell\n* http://purl.org/goodrelations/v1#Buy
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
TypeAndQuantityNode
A structured value indicating the quantity, unit of measurement, and business function of goods included in a bundle offer.
Property |
Definition |
Type |
amountOfThisGood |
The quantity of the goods included in the offer. |
Numeric |
businessFunction |
The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell. |
BusinessFunction |
unitCode |
The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon. |
Text |
unitText |
A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code forunitCode. |
Text |
typeOfGood |
The product that this structured value is referring to. |
Product |
PriceSpecification
A structured value representing a price or price range. Typically, only the subclasses of this type are used for markup. It is recommended to use [[MonetaryAmount]] to describe independent amounts of money such as a salary, credit card limits, etc.
Property |
Definition |
Type |
eligibleQuantity |
The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity. |
QuantitativeValue |
valueAddedTaxIncluded |
Specifies whether the applicable value-added tax (VAT) is included in the price specification or not. |
Indicator |
minPrice |
The lowest price if the price is a range. |
Numeric |
price |
The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.\n\nUsage guidelines:\n\n* Use the [[priceCurrency]] property (with standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR") instead of including ambiguous symbols such as '~~~CONTENT~~~#39; in the value.\n* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.\n* Note that both RDFa and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.\n* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols. |
Text |
validThrough |
The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours. |
Date |
maxPrice |
The highest price if the price is a range. |
Numeric |
validFrom |
The date when the item becomes valid. |
Date |
eligibleTransactionVolume |
The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount. |
PriceSpecification |
priceCurrency |
The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.\n\nUse standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR". |
Text |
BusinessEntityType
A business entity type is a conceptual entity representing the legal form, the size, the main line of business, the position in the value chain, or any combination thereof, of an organization or business person.\n\nCommonly used values:\n\n* http://purl.org/goodrelations/v1#Business\n* http://purl.org/goodrelations/v1#Enduser\n* http://purl.org/goodrelations/v1#PublicInstitution\n* http://purl.org/goodrelations/v1#Reseller
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
PaymentMethod
A payment method is a standardized procedure for transferring the monetary amount for a purchase. Payment methods are characterized by the legal and technical structures used, and by the organization or group carrying out the transaction.\n\nCommonly used values:\n\n* http://purl.org/goodrelations/v1#ByBankTransferInAdvance\n* http://purl.org/goodrelations/v1#ByInvoice\n* http://purl.org/goodrelations/v1#Cash\n* http://purl.org/goodrelations/v1#CheckInAdvance\n* http://purl.org/goodrelations/v1#COD\n* http://purl.org/goodrelations/v1#DirectDebit\n* http://purl.org/goodrelations/v1#GoogleCheckout\n* http://purl.org/goodrelations/v1#PayPal\n* http://purl.org/goodrelations/v1#PaySwarm
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
DeliveryMethod
A delivery method is a standardized procedure for transferring the product or service to the destination of fulfillment chosen by the customer. Delivery methods are characterized by the means of transportation used, and by the organization or group that is the contracting party for the sending organization or person.\n\nCommonly used values:\n\n* http://purl.org/goodrelations/v1#DeliveryModeDirectDownload\n* http://purl.org/goodrelations/v1#DeliveryModeFreight\n* http://purl.org/goodrelations/v1#DeliveryModeMail\n* http://purl.org/goodrelations/v1#DeliveryModeOwnFleet\n* http://purl.org/goodrelations/v1#DeliveryModePickUp\n* http://purl.org/goodrelations/v1#DHL\n* http://purl.org/goodrelations/v1#FederalExpress\n* http://purl.org/goodrelations/v1#UPS
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
DefinedTerm
A word, name, acronym, phrase, etc. with a formal definition. Often used in the context of category or subject classification, glossaries or dictionaries, product or creative work types, etc. Use the name property for the term being defined, use termCode if the term has an alpha-numeric code allocated, use description to provide the definition of the term.
Property |
Definition |
Type |
inDefinedTermSet |
A [[DefinedTermSet]] that contains this term. |
DefinedTermSet |
termCode |
A code that identifies this [[DefinedTerm]] within a [[DefinedTermSet]] |
Text |
DefinedTermSet
A set of defined terms, for example a set of categories or a classification scheme, a glossary, dictionary or enumeration.
Property |
Definition |
Type |
hasDefinedTerm |
A Defined Term contained in this term set. |
DefinedTerm |
AlignmentObject
An intangible item that describes an alignment between a learning resource and a node in an educational framework.Should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
Property |
Definition |
Type |
targetName |
The name of a node in an established educational framework. |
Text |
targetUrl |
The URL of a node in an established educational framework. |
URI |
alignmentType |
A category of alignment between the learning resource and the framework node. Recommended values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'. |
Text |
targetDescription |
The description of a node in an established educational framework. |
Text |
educationalFramework |
The framework to which the resource being described is aligned. |
Text |
WebPage
A web page. Every web page is implicitly assumed to be declared to be of type WebPage, so the various properties about that webpage, such as breadcrumb
may be used. We recommend explicit declaration if these properties are specified, but if they are found outside of an itemscope, they will be assumed to be about the page.
Property |
Definition |
Type |
significantLink |
One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most. |
URI |
specialty |
One of the domain specialities to which this web page's content applies. |
Specialty |
reviewedBy |
People or organizations that have reviewed the content on this web page for accuracy and/or completeness. |
Organization |
lastReviewed |
Date on which the content on this web page was last reviewed for accuracy and/or completeness. |
Date |
relatedLink |
A link related to this web page, for example to other related web pages. |
URI |
breadcrumb |
A set of links that can help a user understand and navigate a website hierarchy. |
BreadcrumbList |
significantLinks |
The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most. |
URI |
mainContentOfPage |
Indicates if this web page element is the main subject of the page. |
WebPageElement |
speakable |
Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.The speakable property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:1.) id-value URL references - uses id-value of an element in the page being annotated. The simplest use of speakable has (potentially relative) URL values, referencing identified sections of the document concerned.2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the speakable property. |
SpeakableSpecification |
primaryImageOfPage |
Indicates the main image on the page. |
ImageObject |
Specialty
Any branch of a field in which people typically develop specific expertise, usually after significant study, time, and effort.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
BreadcrumbList
A BreadcrumbList is an ItemList consisting of a chain of linked Web pages, typically described using at least their URL and their name, and typically ending with the current page.\n\nThe [[position]] property is used to reconstruct the order of the items in a BreadcrumbList. The convention is that a breadcrumb list has an [[itemListOrder]] of [[ItemListOrderAscending]] (lower values listed first), and that the first items in this list correspond to the "top" or beginning of the breadcrumb trail, e.g. with a site or section homepage. The specific values of 'position' are not assigned meaning for a BreadcrumbList, but they should be integers, e.g. beginning with '1' for the first item in the list.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
itemListOrder |
Type of ordering (e.g. Ascending, Descending, Unordered). |
ItemListOrderType |
numberOfItems |
The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list. |
Integer |
itemListElement |
For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.\n\nText values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.\n\nNote: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases. |
ListItem |
WebPageElement
A web page element, like a table or an image.
Property |
Definition |
Type |
workTranslation |
A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
CreativeWork |
educationalLevel |
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
Text |
associatedMedia |
A media object that encodes this CreativeWork. This property is a synonym for encoding. |
MediaObject |
exampleOfWork |
A creative work that this work is an example/instance/realization/derivation of. |
CreativeWork |
releasedEvent |
The place and time the release was issued, expressed as a PublicationEvent. |
PublicationEvent |
version |
The version of the CreativeWork embodied by a specified resource. |
Numeric |
locationCreated |
The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. |
Place |
acquireLicensePage |
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
CreativeWork |
thumbnailUrl |
A thumbnail image relevant to the Thing. |
URI |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
expires |
Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. |
Date |
contentLocation |
The location depicted or described in the content. For example, the location in a photograph or painting. |
Place |
educationalUse |
The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
DefinedTerm |
copyrightHolder |
The party holding the legal copyright to the CreativeWork. |
Organization |
accessibilityControl |
Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the approved vocabulary. |
Text |
maintainer |
A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
Person |
educationalAlignment |
An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. |
AlignmentObject |
spatial |
The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. |
Place |
publisher |
The publisher of the creative work. |
Organization |
keywords |
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. |
URI |
assesses |
The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
DefinedTerm |
reviews |
Review of the item. |
Review |
isBasedOn |
A resource from which this work is derived or from which it is a modification or adaption. |
URI |
mentions |
Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. |
Thing |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
contributor |
A secondary contributor to the CreativeWork or Event. |
Organization |
license |
A license document that applies to this content, typically indicated by URL. |
URI |
citation |
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
CreativeWork |
accessibilitySummary |
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." |
Text |
award |
An award won by or for this item. |
Text |
commentCount |
The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. |
Integer |
temporalCoverage |
The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
URI |
dateCreated |
The date on which the CreativeWork was created or the item was added to a DataFeed. |
DateTime |
discussionUrl |
A link to the page containing the comments of the CreativeWork. |
URI |
copyrightNotice |
Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. |
Text |
learningResourceType |
The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
DefinedTerm |
awards |
Awards won by or for this item. |
Text |
accessModeSufficient |
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the approved vocabulary. |
ItemList |
review |
A review of the item. |
Review |
conditionsOfAccess |
Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". |
Text |
interactivityType |
The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
Text |
abstract |
An abstract is a short description that summarizes a [[CreativeWork]]. |
Text |
fileFormat |
Media type, typically MIME format (see IANA site) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
Text |
interpretedAsClaim |
Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]]. |
Claim |
text |
The textual content of this CreativeWork. |
Text |
archivedAt |
Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content. |
WebPage |
alternativeHeadline |
A secondary title of the CreativeWork. |
Text |
creditText |
Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. |
Text |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
workExample |
Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book. |
CreativeWork |
about |
The subject matter of the content. |
Thing |
encodings |
A media object that encodes this CreativeWork. |
MediaObject |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
video |
An embedded video object. |
VideoObject |
isPartOf |
Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
URI |
pattern |
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. |
DefinedTerm |
editor |
Specifies the Person who edited the CreativeWork. |
Person |
dateModified |
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
DateTime |
translationOfWork |
The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”. |
CreativeWork |
creativeWorkStatus |
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
DefinedTerm |
isBasedOnUrl |
A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
URI |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
contentReferenceTime |
The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. |
DateTime |
correction |
Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
URI |
sdDatePublished |
Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] |
Date |
comment |
Comments, typically from users. |
Comment |
countryOfOrigin |
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. |
Country |
timeRequired |
Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. |
Duration |
typicalAgeRange |
The typical expected age range, e.g. '7-9', '11-'. |
Text |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
producer |
The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.). |
Organization |
schemaVersion |
Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. 10.0 as a simple string, or more explicitly via URL, https://schema.org/docs/releases.html#v10.0 . There may be situations in which other schemas might usefully be referenced this way, e.g. http://dublincore.org/specifications/dublin-core/dces/1999-07-02/ but this has not been carefully explored in the community. |
URI |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
encoding |
A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. |
MediaObject |
publisherImprint |
The publishing division which published the comic. |
Organization |
accessibilityAPI |
Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the approved vocabulary. |
Text |
sdPublisher |
Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The |
Organization |
audio |
An embedded audio object. |
MusicRecording |
accessibilityFeature |
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the approved vocabulary. |
Text |
spatialCoverage |
The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. |
Place |
accessMode |
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the approved vocabulary. |
Text |
editEIDR |
An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
URI |
usageInfo |
The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
URI |
position |
The position of an item in a series or sequence of items. |
Text |
encodingFormat |
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
URI |
copyrightYear |
The year during which the claimed copyright for the CreativeWork was first asserted. |
Numeric |
mainEntity |
Indicates the primary entity described in some page or other CreativeWork. |
Thing |
creator |
The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
Person |
teaches |
The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
DefinedTerm |
temporal |
The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
DateTime |
size |
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. |
DefinedTerm |
translator |
Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
accountablePerson |
Specifies the Person that is legally accountable for the CreativeWork. |
Person |
accessibilityHazard |
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the approved vocabulary. |
Text |
contentRating |
Official rating of a piece of content—for example, 'MPAA PG-13'. |
Text |
recordedAt |
The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. |
Event |
publication |
A publication event associated with the item. |
PublicationEvent |
sdLicense |
A license document that applies to this structured data, typically indicated by URL. |
CreativeWork |
headline |
Headline of the article. |
Text |
materialExtent |
undefined |
QuantitativeValue |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
datePublished |
Date of first broadcast/publication. |
DateTime |
offers |
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. |
Demand |
hasPart |
Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). |
CreativeWork |
sourceOrganization |
The Organization on whose behalf the creator was working. |
Organization |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
character |
Fictional person connected with a creative work. |
Person |
xpath |
An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element". |
Text |
cssSelector |
A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element". |
Text |
InteractionCounter
A summary of how users have interacted with this CreativeWork. In most cases, authors will use a subtype to specify the specific type of interaction.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
endTime |
The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
startTime |
The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
interactionType |
The Action representing the type of interaction. For up votes, +1s, etc. use [[LikeAction]]. For down votes use [[DislikeAction]]. Otherwise, use the most specific Action. |
Action |
interactionService |
The WebSite or SoftwareApplication where the interactions took place. |
WebSite |
userInteractionCount |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. |
Integer |
location |
The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
Place |
WebSite
A WebSite is a set of related web pages and other items typically served from a single web domain and accessible via URLs.
Property |
Definition |
Type |
workTranslation |
A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
CreativeWork |
educationalLevel |
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
Text |
associatedMedia |
A media object that encodes this CreativeWork. This property is a synonym for encoding. |
MediaObject |
exampleOfWork |
A creative work that this work is an example/instance/realization/derivation of. |
CreativeWork |
releasedEvent |
The place and time the release was issued, expressed as a PublicationEvent. |
PublicationEvent |
version |
The version of the CreativeWork embodied by a specified resource. |
Numeric |
locationCreated |
The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. |
Place |
acquireLicensePage |
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
CreativeWork |
thumbnailUrl |
A thumbnail image relevant to the Thing. |
URI |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
expires |
Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. |
Date |
contentLocation |
The location depicted or described in the content. For example, the location in a photograph or painting. |
Place |
educationalUse |
The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
DefinedTerm |
copyrightHolder |
The party holding the legal copyright to the CreativeWork. |
Organization |
accessibilityControl |
Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the approved vocabulary. |
Text |
maintainer |
A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
Person |
educationalAlignment |
An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. |
AlignmentObject |
spatial |
The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. |
Place |
publisher |
The publisher of the creative work. |
Organization |
keywords |
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. |
URI |
assesses |
The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
DefinedTerm |
reviews |
Review of the item. |
Review |
isBasedOn |
A resource from which this work is derived or from which it is a modification or adaption. |
URI |
mentions |
Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. |
Thing |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
contributor |
A secondary contributor to the CreativeWork or Event. |
Organization |
license |
A license document that applies to this content, typically indicated by URL. |
URI |
citation |
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
CreativeWork |
accessibilitySummary |
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." |
Text |
award |
An award won by or for this item. |
Text |
commentCount |
The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. |
Integer |
temporalCoverage |
The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
URI |
dateCreated |
The date on which the CreativeWork was created or the item was added to a DataFeed. |
DateTime |
discussionUrl |
A link to the page containing the comments of the CreativeWork. |
URI |
copyrightNotice |
Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. |
Text |
learningResourceType |
The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
DefinedTerm |
awards |
Awards won by or for this item. |
Text |
accessModeSufficient |
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the approved vocabulary. |
ItemList |
review |
A review of the item. |
Review |
conditionsOfAccess |
Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". |
Text |
interactivityType |
The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
Text |
abstract |
An abstract is a short description that summarizes a [[CreativeWork]]. |
Text |
fileFormat |
Media type, typically MIME format (see IANA site) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
Text |
interpretedAsClaim |
Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]]. |
Claim |
text |
The textual content of this CreativeWork. |
Text |
archivedAt |
Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content. |
WebPage |
alternativeHeadline |
A secondary title of the CreativeWork. |
Text |
creditText |
Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. |
Text |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
workExample |
Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book. |
CreativeWork |
about |
The subject matter of the content. |
Thing |
encodings |
A media object that encodes this CreativeWork. |
MediaObject |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
video |
An embedded video object. |
VideoObject |
isPartOf |
Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
URI |
pattern |
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. |
DefinedTerm |
editor |
Specifies the Person who edited the CreativeWork. |
Person |
dateModified |
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
DateTime |
translationOfWork |
The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”. |
CreativeWork |
creativeWorkStatus |
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
DefinedTerm |
isBasedOnUrl |
A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
URI |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
contentReferenceTime |
The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. |
DateTime |
correction |
Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
URI |
sdDatePublished |
Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] |
Date |
comment |
Comments, typically from users. |
Comment |
countryOfOrigin |
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. |
Country |
timeRequired |
Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. |
Duration |
typicalAgeRange |
The typical expected age range, e.g. '7-9', '11-'. |
Text |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
producer |
The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.). |
Organization |
schemaVersion |
Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. 10.0 as a simple string, or more explicitly via URL, https://schema.org/docs/releases.html#v10.0 . There may be situations in which other schemas might usefully be referenced this way, e.g. http://dublincore.org/specifications/dublin-core/dces/1999-07-02/ but this has not been carefully explored in the community. |
URI |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
encoding |
A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. |
MediaObject |
publisherImprint |
The publishing division which published the comic. |
Organization |
accessibilityAPI |
Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the approved vocabulary. |
Text |
sdPublisher |
Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The |
Organization |
audio |
An embedded audio object. |
MusicRecording |
accessibilityFeature |
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the approved vocabulary. |
Text |
spatialCoverage |
The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. |
Place |
accessMode |
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the approved vocabulary. |
Text |
editEIDR |
An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
URI |
usageInfo |
The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
URI |
position |
The position of an item in a series or sequence of items. |
Text |
encodingFormat |
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
URI |
copyrightYear |
The year during which the claimed copyright for the CreativeWork was first asserted. |
Numeric |
mainEntity |
Indicates the primary entity described in some page or other CreativeWork. |
Thing |
creator |
The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
Person |
teaches |
The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
DefinedTerm |
temporal |
The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
DateTime |
size |
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. |
DefinedTerm |
translator |
Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
accountablePerson |
Specifies the Person that is legally accountable for the CreativeWork. |
Person |
accessibilityHazard |
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the approved vocabulary. |
Text |
contentRating |
Official rating of a piece of content—for example, 'MPAA PG-13'. |
Text |
recordedAt |
The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. |
Event |
publication |
A publication event associated with the item. |
PublicationEvent |
sdLicense |
A license document that applies to this structured data, typically indicated by URL. |
CreativeWork |
headline |
Headline of the article. |
Text |
materialExtent |
undefined |
QuantitativeValue |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
datePublished |
Date of first broadcast/publication. |
DateTime |
offers |
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. |
Demand |
hasPart |
Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). |
CreativeWork |
sourceOrganization |
The Organization on whose behalf the creator was working. |
Organization |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
character |
Fictional person connected with a creative work. |
Person |
issn |
The International Standard Serial Number (ISSN) that identifies this serial publication. You can repeat this property to identify different formats of, or the linking ISSN (ISSN-L) for, this serial publication. |
Text |
VideoObject
A video file.
Property |
Definition |
Type |
actors |
An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip. |
Person |
actor |
An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip. |
Person |
caption |
The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]]. |
MediaObject |
thumbnail |
Thumbnail image for an image or video. |
ImageObject |
embeddedTextCaption |
Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'. |
Text |
director |
A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip. |
Person |
videoFrameSize |
The frame size of the video. |
Text |
directors |
A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip. |
Person |
transcript |
If this MediaObject is an AudioObject or VideoObject, the transcript of that object. |
Text |
musicBy |
The composer of the soundtrack. |
MusicGroup |
videoQuality |
The quality of the video. |
Text |
MusicGroup
A musical group, such as a band, an orchestra, or a choir. Can also be a solo musician.
Property |
Definition |
Type |
album |
A music album. |
MusicAlbum |
tracks |
A music recording (track)—usually a single song. |
MusicRecording |
track |
A music recording (track)—usually a single song. If an ItemList is given, the list should contain items of type MusicRecording. |
ItemList |
albums |
A collection of music albums. |
MusicAlbum |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
musicGroupMember |
A member of a music group—for example, John, Paul, George, or Ringo. |
Person |
MusicAlbum
A collection of music tracks.
Property |
Definition |
Type |
albumReleaseType |
The kind of release which this album is: single, EP or album. |
MusicAlbumReleaseType |
albumRelease |
A release of this album. |
MusicRelease |
byArtist |
The artist that performed this album or recording. |
MusicGroup |
albumProductionType |
Classification of the album by its type of content: soundtrack, live album, studio album, etc. |
MusicAlbumProductionType |
MusicAlbumReleaseType
The kind of release which this album is: single, EP or album.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
MusicRelease
A MusicRelease is a specific release of a music album.
Property |
Definition |
Type |
releaseOf |
The album this is a release of. |
MusicAlbum |
musicReleaseFormat |
Format of this release (the type of recording media used, i.e. compact disc, digital media, LP, etc.). |
MusicReleaseFormatType |
duration |
The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. |
Duration |
recordLabel |
The label that issued the release. |
Organization |
catalogNumber |
The catalog number for the release. |
Text |
creditedTo |
The group the release is credited to if different than the byArtist. For example, Red and Blue is credited to "Stefani Germanotta Band", but by Lady Gaga. |
Person |
MusicReleaseFormatType
Format of this release (the type of recording media used, i.e. compact disc, digital media, LP, etc.).
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
MusicAlbumProductionType
Classification of the album by its type of content: soundtrack, live album, studio album, etc.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
MusicRecording
A music recording (track), usually a single song.
Property |
Definition |
Type |
recordingOf |
The composition this track is a recording of. |
MusicComposition |
byArtist |
The artist that performed this album or recording. |
MusicGroup |
inPlaylist |
The playlist to which this recording belongs. |
MusicPlaylist |
duration |
The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. |
Duration |
isrcCode |
The International Standard Recording Code for the recording. |
Text |
inAlbum |
The album to which this recording belongs. |
MusicAlbum |
MusicComposition
A musical composition.
Property |
Definition |
Type |
iswcCode |
The International Standard Musical Work Code for the composition. |
Text |
lyrics |
The words in the song. |
CreativeWork |
musicalKey |
The key, mode, or scale this composition uses. |
Text |
includedComposition |
Smaller compositions included in this work (e.g. a movement in a symphony). |
MusicComposition |
recordedAs |
An audio recording of the work. |
MusicRecording |
composer |
The person or organization who wrote a composition, or who is the composer of a work performed at some event. |
Organization |
musicCompositionForm |
The type of composition (e.g. overture, sonata, symphony, etc.). |
Text |
firstPerformance |
The date and place the work was first performed. |
Event |
lyricist |
The person who wrote the words. |
Person |
musicArrangement |
An arrangement derived from the composition. |
MusicComposition |
MusicPlaylist
A collection of music tracks in playlist form.
Property |
Definition |
Type |
workTranslation |
A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
CreativeWork |
educationalLevel |
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
Text |
associatedMedia |
A media object that encodes this CreativeWork. This property is a synonym for encoding. |
MediaObject |
exampleOfWork |
A creative work that this work is an example/instance/realization/derivation of. |
CreativeWork |
releasedEvent |
The place and time the release was issued, expressed as a PublicationEvent. |
PublicationEvent |
version |
The version of the CreativeWork embodied by a specified resource. |
Numeric |
locationCreated |
The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. |
Place |
acquireLicensePage |
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
CreativeWork |
thumbnailUrl |
A thumbnail image relevant to the Thing. |
URI |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
expires |
Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. |
Date |
contentLocation |
The location depicted or described in the content. For example, the location in a photograph or painting. |
Place |
educationalUse |
The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
DefinedTerm |
copyrightHolder |
The party holding the legal copyright to the CreativeWork. |
Organization |
accessibilityControl |
Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the approved vocabulary. |
Text |
maintainer |
A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
Person |
educationalAlignment |
An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. |
AlignmentObject |
spatial |
The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. |
Place |
publisher |
The publisher of the creative work. |
Organization |
keywords |
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. |
URI |
assesses |
The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
DefinedTerm |
reviews |
Review of the item. |
Review |
isBasedOn |
A resource from which this work is derived or from which it is a modification or adaption. |
URI |
mentions |
Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. |
Thing |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
contributor |
A secondary contributor to the CreativeWork or Event. |
Organization |
license |
A license document that applies to this content, typically indicated by URL. |
URI |
citation |
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
CreativeWork |
accessibilitySummary |
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." |
Text |
award |
An award won by or for this item. |
Text |
commentCount |
The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. |
Integer |
temporalCoverage |
The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
URI |
dateCreated |
The date on which the CreativeWork was created or the item was added to a DataFeed. |
DateTime |
discussionUrl |
A link to the page containing the comments of the CreativeWork. |
URI |
copyrightNotice |
Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. |
Text |
learningResourceType |
The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
DefinedTerm |
awards |
Awards won by or for this item. |
Text |
accessModeSufficient |
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the approved vocabulary. |
ItemList |
review |
A review of the item. |
Review |
conditionsOfAccess |
Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". |
Text |
interactivityType |
The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
Text |
abstract |
An abstract is a short description that summarizes a [[CreativeWork]]. |
Text |
fileFormat |
Media type, typically MIME format (see IANA site) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
Text |
interpretedAsClaim |
Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]]. |
Claim |
text |
The textual content of this CreativeWork. |
Text |
archivedAt |
Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content. |
WebPage |
alternativeHeadline |
A secondary title of the CreativeWork. |
Text |
creditText |
Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. |
Text |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
workExample |
Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book. |
CreativeWork |
about |
The subject matter of the content. |
Thing |
encodings |
A media object that encodes this CreativeWork. |
MediaObject |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
video |
An embedded video object. |
VideoObject |
isPartOf |
Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
URI |
pattern |
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. |
DefinedTerm |
editor |
Specifies the Person who edited the CreativeWork. |
Person |
dateModified |
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
DateTime |
translationOfWork |
The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”. |
CreativeWork |
creativeWorkStatus |
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
DefinedTerm |
isBasedOnUrl |
A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
URI |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
contentReferenceTime |
The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. |
DateTime |
correction |
Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
URI |
sdDatePublished |
Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] |
Date |
comment |
Comments, typically from users. |
Comment |
countryOfOrigin |
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. |
Country |
timeRequired |
Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. |
Duration |
typicalAgeRange |
The typical expected age range, e.g. '7-9', '11-'. |
Text |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
producer |
The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.). |
Organization |
schemaVersion |
Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. 10.0 as a simple string, or more explicitly via URL, https://schema.org/docs/releases.html#v10.0 . There may be situations in which other schemas might usefully be referenced this way, e.g. http://dublincore.org/specifications/dublin-core/dces/1999-07-02/ but this has not been carefully explored in the community. |
URI |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
encoding |
A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. |
MediaObject |
publisherImprint |
The publishing division which published the comic. |
Organization |
accessibilityAPI |
Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the approved vocabulary. |
Text |
sdPublisher |
Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The |
Organization |
audio |
An embedded audio object. |
MusicRecording |
accessibilityFeature |
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the approved vocabulary. |
Text |
spatialCoverage |
The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. |
Place |
accessMode |
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the approved vocabulary. |
Text |
editEIDR |
An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
URI |
usageInfo |
The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
URI |
position |
The position of an item in a series or sequence of items. |
Text |
encodingFormat |
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
URI |
copyrightYear |
The year during which the claimed copyright for the CreativeWork was first asserted. |
Numeric |
mainEntity |
Indicates the primary entity described in some page or other CreativeWork. |
Thing |
creator |
The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
Person |
teaches |
The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
DefinedTerm |
temporal |
The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
DateTime |
size |
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. |
DefinedTerm |
translator |
Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
accountablePerson |
Specifies the Person that is legally accountable for the CreativeWork. |
Person |
accessibilityHazard |
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the approved vocabulary. |
Text |
contentRating |
Official rating of a piece of content—for example, 'MPAA PG-13'. |
Text |
recordedAt |
The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. |
Event |
publication |
A publication event associated with the item. |
PublicationEvent |
sdLicense |
A license document that applies to this structured data, typically indicated by URL. |
CreativeWork |
headline |
Headline of the article. |
Text |
materialExtent |
undefined |
QuantitativeValue |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
datePublished |
Date of first broadcast/publication. |
DateTime |
offers |
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. |
Demand |
hasPart |
Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). |
CreativeWork |
sourceOrganization |
The Organization on whose behalf the creator was working. |
Organization |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
character |
Fictional person connected with a creative work. |
Person |
tracks |
A music recording (track)—usually a single song. |
MusicRecording |
track |
A music recording (track)—usually a single song. If an ItemList is given, the list should contain items of type MusicRecording. |
ItemList |
numTracks |
The number of tracks in this album or playlist. |
Integer |
Comment
A comment on an item - for example, a comment on a blog post. The comment's content is expressed via the [[text]] property, and its topic via [[about]], properties shared with all CreativeWorks.
Property |
Definition |
Type |
parentItem |
The parent of a question, answer or item in general. |
Comment |
downvoteCount |
The number of downvotes this question, answer or comment has received from the community. |
Integer |
upvoteCount |
The number of upvotes this question, answer or comment has received from the community. |
Integer |
SpeakableSpecification
A SpeakableSpecification indicates (typically via [[xpath]] or [[cssSelector]]) sections of a document that are highlighted as particularly [[speakable]]. Instances of this type are expected to be used primarily as values of the [[speakable]] property.
Property |
Definition |
Type |
xpath |
An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element". |
Text |
cssSelector |
A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element". |
Text |
MediaSubscription
A subscription which allows a user to access media including audio, video, books, etc.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
expectsAcceptanceOf |
An Offer which must be accepted before the user can perform the Action. For example, the user may need to buy a movie before being able to watch it. |
Offer |
authenticator |
The Organization responsible for authenticating the user's subscription. For example, many media apps require a cable/satellite provider to authenticate your subscription before playing media. |
Organization |
Photograph
A photograph.
Property |
Definition |
Type |
workTranslation |
A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
CreativeWork |
educationalLevel |
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
Text |
associatedMedia |
A media object that encodes this CreativeWork. This property is a synonym for encoding. |
MediaObject |
exampleOfWork |
A creative work that this work is an example/instance/realization/derivation of. |
CreativeWork |
releasedEvent |
The place and time the release was issued, expressed as a PublicationEvent. |
PublicationEvent |
version |
The version of the CreativeWork embodied by a specified resource. |
Numeric |
locationCreated |
The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. |
Place |
acquireLicensePage |
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
CreativeWork |
thumbnailUrl |
A thumbnail image relevant to the Thing. |
URI |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
expires |
Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. |
Date |
contentLocation |
The location depicted or described in the content. For example, the location in a photograph or painting. |
Place |
educationalUse |
The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
DefinedTerm |
copyrightHolder |
The party holding the legal copyright to the CreativeWork. |
Organization |
accessibilityControl |
Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the approved vocabulary. |
Text |
maintainer |
A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
Person |
educationalAlignment |
An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. |
AlignmentObject |
spatial |
The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. |
Place |
publisher |
The publisher of the creative work. |
Organization |
keywords |
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. |
URI |
assesses |
The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
DefinedTerm |
reviews |
Review of the item. |
Review |
isBasedOn |
A resource from which this work is derived or from which it is a modification or adaption. |
URI |
mentions |
Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. |
Thing |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
contributor |
A secondary contributor to the CreativeWork or Event. |
Organization |
license |
A license document that applies to this content, typically indicated by URL. |
URI |
citation |
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
CreativeWork |
accessibilitySummary |
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." |
Text |
award |
An award won by or for this item. |
Text |
commentCount |
The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. |
Integer |
temporalCoverage |
The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
URI |
dateCreated |
The date on which the CreativeWork was created or the item was added to a DataFeed. |
DateTime |
discussionUrl |
A link to the page containing the comments of the CreativeWork. |
URI |
copyrightNotice |
Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. |
Text |
learningResourceType |
The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
DefinedTerm |
awards |
Awards won by or for this item. |
Text |
accessModeSufficient |
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the approved vocabulary. |
ItemList |
review |
A review of the item. |
Review |
conditionsOfAccess |
Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". |
Text |
interactivityType |
The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
Text |
abstract |
An abstract is a short description that summarizes a [[CreativeWork]]. |
Text |
fileFormat |
Media type, typically MIME format (see IANA site) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
Text |
interpretedAsClaim |
Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]]. |
Claim |
text |
The textual content of this CreativeWork. |
Text |
archivedAt |
Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content. |
WebPage |
alternativeHeadline |
A secondary title of the CreativeWork. |
Text |
creditText |
Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. |
Text |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
workExample |
Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book. |
CreativeWork |
about |
The subject matter of the content. |
Thing |
encodings |
A media object that encodes this CreativeWork. |
MediaObject |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
video |
An embedded video object. |
VideoObject |
isPartOf |
Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
URI |
pattern |
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. |
DefinedTerm |
editor |
Specifies the Person who edited the CreativeWork. |
Person |
dateModified |
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
DateTime |
translationOfWork |
The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”. |
CreativeWork |
creativeWorkStatus |
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
DefinedTerm |
isBasedOnUrl |
A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
URI |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
contentReferenceTime |
The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. |
DateTime |
correction |
Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
URI |
sdDatePublished |
Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] |
Date |
comment |
Comments, typically from users. |
Comment |
countryOfOrigin |
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. |
Country |
timeRequired |
Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. |
Duration |
typicalAgeRange |
The typical expected age range, e.g. '7-9', '11-'. |
Text |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
producer |
The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.). |
Organization |
schemaVersion |
Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. 10.0 as a simple string, or more explicitly via URL, https://schema.org/docs/releases.html#v10.0 . There may be situations in which other schemas might usefully be referenced this way, e.g. http://dublincore.org/specifications/dublin-core/dces/1999-07-02/ but this has not been carefully explored in the community. |
URI |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
encoding |
A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. |
MediaObject |
publisherImprint |
The publishing division which published the comic. |
Organization |
accessibilityAPI |
Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the approved vocabulary. |
Text |
sdPublisher |
Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The |
Organization |
audio |
An embedded audio object. |
MusicRecording |
accessibilityFeature |
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the approved vocabulary. |
Text |
spatialCoverage |
The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. |
Place |
accessMode |
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the approved vocabulary. |
Text |
editEIDR |
An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
URI |
usageInfo |
The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
URI |
position |
The position of an item in a series or sequence of items. |
Text |
encodingFormat |
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
URI |
copyrightYear |
The year during which the claimed copyright for the CreativeWork was first asserted. |
Numeric |
mainEntity |
Indicates the primary entity described in some page or other CreativeWork. |
Thing |
creator |
The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
Person |
teaches |
The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
DefinedTerm |
temporal |
The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
DateTime |
size |
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. |
DefinedTerm |
translator |
Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
accountablePerson |
Specifies the Person that is legally accountable for the CreativeWork. |
Person |
accessibilityHazard |
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the approved vocabulary. |
Text |
contentRating |
Official rating of a piece of content—for example, 'MPAA PG-13'. |
Text |
recordedAt |
The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. |
Event |
publication |
A publication event associated with the item. |
PublicationEvent |
sdLicense |
A license document that applies to this structured data, typically indicated by URL. |
CreativeWork |
headline |
Headline of the article. |
Text |
materialExtent |
undefined |
QuantitativeValue |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
datePublished |
Date of first broadcast/publication. |
DateTime |
offers |
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. |
Demand |
hasPart |
Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). |
CreativeWork |
sourceOrganization |
The Organization on whose behalf the creator was working. |
Organization |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
character |
Fictional person connected with a creative work. |
Person |
GeoCoordinates
The geographic coordinates of a place or event.
Property |
Definition |
Type |
longitude |
The longitude of a location. For example -122.08585 (WGS 84). |
Text |
elevation |
The elevation of a location (WGS 84). Values may be of the form 'NUMBER UNIT_OF_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') while numbers alone should be assumed to be a value in meters. |
Numeric |
addressCountry |
The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code. |
Country |
postalCode |
The postal code. For example, 94043. |
Text |
address |
Physical address of the item. |
Text |
latitude |
The latitude of a location. For example 37.42242 (WGS 84). |
Numeric |
ReturnMethodEnumeration
Enumerates several types of product return methods.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
MerchantReturnPolicySeasonalOverride
A seasonal override of a return policy, for example used for holidays.
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
returnPolicyCategory |
Specifies an applicable return policy (from an enumeration). |
MerchantReturnEnumeration |
merchantReturnDays |
Specifies either a fixed return date or the number of days (from the delivery date) that a product can be returned. Used when the [[returnPolicyCategory]] property is specified as [[MerchantReturnFiniteReturnWindow]]. |
DateTime |
startDate |
The start date and time of the item (in ISO 8601 date format). |
DateTime |
endDate |
The end date and time of the item (in ISO 8601 date format). |
DateTime |
AdultOrientedEnumeration
Enumeration of considerations that make a product relevant or potentially restricted for adults only.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
OfferShippingDetails
OfferShippingDetails represents information about shipping destinations.Multiple of these entities can be used to represent different shipping rates for different destinations:One entity for Alaska/Hawaii. A different one for continental US. A different one for all France.Multiple of these entities can be used to represent different shipping costs and delivery times.Two entities that are identical but differ in rate and time:E.g. Cheaper and slower: $5 in 5-7 daysor Fast and expensive: $15 in 1-2 days.
Property |
Definition |
Type |
width |
The width of the item. |
Distance |
shippingSettingsLink |
Link to a page containing [[ShippingRateSettings]] and [[DeliveryTimeSettings]] details. |
URI |
depth |
The depth of the item. |
QuantitativeValue |
shippingDestination |
indicates (possibly multiple) shipping destinations. These can be defined in several ways, e.g. postalCode ranges. |
DefinedRegion |
shippingLabel |
Label to match an [[OfferShippingDetails]] with a [[ShippingRateSettings]] (within the context of a [[shippingSettingsLink]] cross-reference). |
Text |
height |
The height of the item. |
QuantitativeValue |
doesNotShip |
Indicates when shipping to a particular [[shippingDestination]] is not available. |
Indicator |
weight |
The weight of the product or person. |
QuantitativeValue |
deliveryTime |
The total delay between the receipt of the order and the goods reaching the final customer. |
ShippingDeliveryTime |
shippingOrigin |
Indicates the origin of a shipment, i.e. where it should be coming from. |
DefinedRegion |
transitTimeLabel |
Label to match an [[OfferShippingDetails]] with a [[DeliveryTimeSettings]] (within the context of a [[shippingSettingsLink]] cross-reference). |
Text |
shippingRate |
The shipping rate is the cost of shipping to the specified destination. Typically, the maxValue and currency values (of the [[MonetaryAmount]]) are most appropriate. |
MonetaryAmount |
DefinedRegion
A DefinedRegion is a geographic area defined by potentially arbitrary (rather than political, administrative or natural geographical) criteria. Properties are provided for defining a region by reference to sets of postal codes.Examples: a delivery destination when shopping. Region where regional pricing is configured.Requirement 1:Country: USStates: "NY", "CA"Requirement 2:Country: USPostalCode Set: { [94000-94585], [97000, 97999], [13000, 13599]}{ [12345, 12345], [78945, 78945], }Region = state, canton, prefecture, autonomous community...
Property |
Definition |
Type |
postalCodePrefix |
A defined range of postal codes indicated by a common textual prefix. Used for non-numeric systems such as UK. |
Text |
addressCountry |
The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code. |
Country |
postalCodeRange |
A defined range of postal codes. |
Code |
postalCode |
The postal code. For example, 94043. |
Text |
addressRegion |
The region in which the locality is, and which is in the country. For example, California or another appropriate first-level Administrative division. |
Text |
Code
Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.
Property |
Definition |
Type |
workTranslation |
A work that is a translation of the content of this work. E.g. 西遊記 has an English workTranslation “Journey to the West”, a German workTranslation “Monkeys Pilgerfahrt” and a Vietnamese translation Tây du ký bình khảo. |
CreativeWork |
educationalLevel |
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
Text |
associatedMedia |
A media object that encodes this CreativeWork. This property is a synonym for encoding. |
MediaObject |
exampleOfWork |
A creative work that this work is an example/instance/realization/derivation of. |
CreativeWork |
releasedEvent |
The place and time the release was issued, expressed as a PublicationEvent. |
PublicationEvent |
version |
The version of the CreativeWork embodied by a specified resource. |
Numeric |
locationCreated |
The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork. |
Place |
acquireLicensePage |
Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item. |
CreativeWork |
thumbnailUrl |
A thumbnail image relevant to the Thing. |
URI |
provider |
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. |
Organization |
expires |
Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date. |
Date |
contentLocation |
The location depicted or described in the content. For example, the location in a photograph or painting. |
Place |
educationalUse |
The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
DefinedTerm |
copyrightHolder |
The party holding the legal copyright to the CreativeWork. |
Organization |
accessibilityControl |
Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the approved vocabulary. |
Text |
maintainer |
A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. |
Person |
educationalAlignment |
An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency. |
AlignmentObject |
spatial |
The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate. |
Place |
publisher |
The publisher of the creative work. |
Organization |
keywords |
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. |
URI |
assesses |
The item being described is intended to assess the competency or learning outcome defined by the referenced term. |
DefinedTerm |
reviews |
Review of the item. |
Review |
isBasedOn |
A resource from which this work is derived or from which it is a modification or adaption. |
URI |
mentions |
Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept. |
Thing |
publishingPrinciples |
The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. |
CreativeWork |
contributor |
A secondary contributor to the CreativeWork or Event. |
Organization |
license |
A license document that applies to this content, typically indicated by URL. |
URI |
citation |
A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
CreativeWork |
accessibilitySummary |
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." |
Text |
award |
An award won by or for this item. |
Text |
commentCount |
The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere. |
Integer |
temporalCoverage |
The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in ISO 8601 time interval format. In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated. |
URI |
dateCreated |
The date on which the CreativeWork was created or the item was added to a DataFeed. |
DateTime |
discussionUrl |
A link to the page containing the comments of the CreativeWork. |
URI |
copyrightNotice |
Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work. |
Text |
learningResourceType |
The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
DefinedTerm |
awards |
Awards won by or for this item. |
Text |
accessModeSufficient |
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the approved vocabulary. |
ItemList |
review |
A review of the item. |
Review |
conditionsOfAccess |
Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.\n\nFor example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ". |
Text |
interactivityType |
The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
Text |
abstract |
An abstract is a short description that summarizes a [[CreativeWork]]. |
Text |
fileFormat |
Media type, typically MIME format (see IANA site) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
Text |
interpretedAsClaim |
Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]]. |
Claim |
text |
The textual content of this CreativeWork. |
Text |
archivedAt |
Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content. |
WebPage |
alternativeHeadline |
A secondary title of the CreativeWork. |
Text |
creditText |
Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. |
Text |
funding |
A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]]. |
Grant |
interactionStatistic |
The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. |
InteractionCounter |
workExample |
Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book. |
CreativeWork |
about |
The subject matter of the content. |
Thing |
encodings |
A media object that encodes this CreativeWork. |
MediaObject |
funder |
A person or organization that supports (sponsors) something through some kind of financial contribution. |
Organization |
video |
An embedded video object. |
VideoObject |
isPartOf |
Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of. |
URI |
pattern |
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. |
DefinedTerm |
editor |
Specifies the Person who edited the CreativeWork. |
Person |
dateModified |
The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
DateTime |
translationOfWork |
The work that this work has been translated from. E.g. 物种起源 is a translationOf “On the Origin of Species”. |
CreativeWork |
creativeWorkStatus |
The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. |
DefinedTerm |
isBasedOnUrl |
A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html. |
URI |
isFamilyFriendly |
Indicates whether this content is family friendly. |
Indicator |
isAccessibleForFree |
A flag to signal that the item, event, or place is accessible for free. |
Indicator |
author |
The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
Organization |
contentReferenceTime |
The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event. |
DateTime |
correction |
Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document. |
URI |
sdDatePublished |
Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]] |
Date |
comment |
Comments, typically from users. |
Comment |
countryOfOrigin |
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. |
Country |
timeRequired |
Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'. |
Duration |
typicalAgeRange |
The typical expected age range, e.g. '7-9', '11-'. |
Text |
genre |
Genre of the creative work, broadcast channel or group. |
Text |
producer |
The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.). |
Organization |
schemaVersion |
Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. 10.0 as a simple string, or more explicitly via URL, https://schema.org/docs/releases.html#v10.0 . There may be situations in which other schemas might usefully be referenced this way, e.g. http://dublincore.org/specifications/dublin-core/dces/1999-07-02/ but this has not been carefully explored in the community. |
URI |
audience |
An intended audience, i.e. a group for whom something was created. |
Audience |
encoding |
A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. |
MediaObject |
publisherImprint |
The publishing division which published the comic. |
Organization |
accessibilityAPI |
Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the approved vocabulary. |
Text |
sdPublisher |
Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The |
Organization |
audio |
An embedded audio object. |
MusicRecording |
accessibilityFeature |
Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the approved vocabulary. |
Text |
spatialCoverage |
The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York. |
Place |
accessMode |
The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the approved vocabulary. |
Text |
editEIDR |
An EIDR (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description. |
URI |
usageInfo |
The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses. |
URI |
position |
The position of an item in a series or sequence of items. |
Text |
encodingFormat |
Media type typically expressed using a MIME format (see IANA site and MDN reference), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry. |
URI |
copyrightYear |
The year during which the claimed copyright for the CreativeWork was first asserted. |
Numeric |
mainEntity |
Indicates the primary entity described in some page or other CreativeWork. |
Thing |
creator |
The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. |
Person |
teaches |
The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term. |
DefinedTerm |
temporal |
The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate. |
DateTime |
size |
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. |
DefinedTerm |
translator |
Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event. |
Organization |
aggregateRating |
The overall rating, based on a collection of reviews or ratings, of the item. |
AggregateRating |
accountablePerson |
Specifies the Person that is legally accountable for the CreativeWork. |
Person |
accessibilityHazard |
A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the approved vocabulary. |
Text |
contentRating |
Official rating of a piece of content—for example, 'MPAA PG-13'. |
Text |
recordedAt |
The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event. |
Event |
publication |
A publication event associated with the item. |
PublicationEvent |
sdLicense |
A license document that applies to this structured data, typically indicated by URL. |
CreativeWork |
headline |
Headline of the article. |
Text |
materialExtent |
undefined |
QuantitativeValue |
inLanguage |
The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. See also [[availableLanguage]]. |
Text |
material |
A material that something is made from, e.g. leather, wool, cotton, paper. |
Product |
datePublished |
Date of first broadcast/publication. |
DateTime |
offers |
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. |
Demand |
hasPart |
Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense). |
CreativeWork |
sourceOrganization |
The Organization on whose behalf the creator was working. |
Organization |
sponsor |
A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
Organization |
character |
Fictional person connected with a creative work. |
Person |
ShippingDeliveryTime
ShippingDeliveryTime provides various pieces of information about delivery times for shipping.
Property |
Definition |
Type |
cutoffTime |
Order cutoff time allows merchants to describe the time after which they will no longer process orders received on that day. For orders processed after cutoff time, one day gets added to the delivery time estimate. This property is expected to be most typically used via the [[ShippingRateSettings]] publication pattern. The time is indicated using the ISO-8601 Time format, e.g. "23:30:00-05:00" would represent 6:30 pm Eastern Standard Time (EST) which is 5 hours behind Coordinated Universal Time (UTC). |
DateTime |
transitTime |
The typical delay the order has been sent for delivery and the goods reach the final customer. Typical properties: minValue, maxValue, unitCode (d for DAY). |
QuantitativeValue |
handlingTime |
The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup. Typical properties: minValue, maxValue, unitCode (d for DAY). This is by common convention assumed to mean business days (if a unitCode is used, coded as "d"), i.e. only counting days when the business normally operates. |
QuantitativeValue |
businessDays |
Days of the week when the merchant typically operates, indicated via opening hours markup. |
OpeningHoursSpecification |
EducationalOccupationalCredential
An educational or occupational credential. A diploma, academic degree, certification, qualification, badge, etc., that may be awarded to a person or other entity that meets the requirements defined by the credentialer.
Property |
Definition |
Type |
educationalLevel |
The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators. |
Text |
competencyRequired |
Knowledge, skill, ability or personal attribute that must be demonstrated by a person or other entity in order to do something such as earn an Educational Occupational Credential or understand a LearningResource. |
Text |
recognizedBy |
An organization that acknowledges the validity, value or utility of a credential. Note: recognition may include a process of quality assurance or accreditation. |
Organization |
validFor |
The duration of validity of a permit or similar thing. |
Duration |
validIn |
The geographic area where a permit or similar thing is valid. |
AdministrativeArea |
credentialCategory |
The category or type of credential being described, for example "degree”, “certificate”, “badge”, or more specific term. |
URI |
Occupation
A profession, may involve prolonged training and/or a formal qualification.
Property |
Definition |
Type |
occupationLocation |
The region/country for which this occupational description is appropriate. Note that educational requirements and qualifications can vary between jurisdictions. |
AdministrativeArea |
skills |
A statement of knowledge, skill, ability, task or any other assertion expressing a competency that is desired or required to fulfill this role or to work in this occupation. |
Text |
experienceRequirements |
Description of skills and experience needed for the position or Occupation. |
OccupationalExperienceRequirements |
qualifications |
Specific qualifications required for this role or Occupation. |
EducationalOccupationalCredential |
educationRequirements |
Educational background needed for the position or Occupation. |
EducationalOccupationalCredential |
estimatedSalary |
An estimated salary for a job posting or occupation, based on a variety of variables including, but not limited to industry, job title, and location. Estimated salaries are often computed by outside organizations rather than the hiring organization, who may not have committed to the estimated value. |
MonetaryAmount |
occupationalCategory |
A category describing the job, preferably using a term from a taxonomy such as BLS O*NET-SOC, ISCO-08 or similar, with the property repeated for each applicable value. Ideally the taxonomy should be identified, and both the textual label and formal code for the category should be provided.\nNote: for historical reasons, any textual label and formal code provided as a literal may be assumed to be from O*NET-SOC. |
Text |
responsibilities |
Responsibilities associated with this role or Occupation. |
Text |
OccupationalExperienceRequirements
Indicates employment-related experience requirements, e.g. [[monthsOfExperience]].
Property |
Definition |
Type |
potentialAction |
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
Action |
mainEntityOfPage |
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
URI |
subjectOf |
A CreativeWork or Event about this Thing. |
Event |
url |
URL of the item. |
URI |
alternateName |
An alias for the item. |
Text |
sameAs |
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. |
URI |
description |
A description of the item. |
Text |
disambiguatingDescription |
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. |
Text |
identifier |
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. |
PropertyValue |
image |
An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. |
URI |
name |
The name of the item. |
Text |
additionalType |
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
URI |
monthsOfExperience |
Indicates the minimal number of months of experience required for a position. |
Numeric |
GenderType
An enumeration of genders.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
EventAttendanceModeEnumeration
An EventAttendanceModeEnumeration value is one of potentially several modes of organising an event, relating to whether it is online or offline.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Schedule
A schedule defines a repeating time period used to describe a regularly occurring [[Event]]. At a minimum a schedule will specify [[repeatFrequency]] which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the day(s) of the week or month when the recurring event will take place, in addition to its start and end time. Schedules may also have start and end dates to indicate when they are active, e.g. to define a limited calendar of events.
Property |
Definition |
Type |
endTime |
The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
startTime |
The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.\n\nNote that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions. |
DateTime |
exceptDate |
Defines a [[Date]] or [[DateTime]] during which a scheduled [[Event]] will not take place. The property allows exceptions to a [[Schedule]] to be specified. If an exception is specified as a [[DateTime]] then only the event that would have started at that specific date and time should be excluded from the schedule. If an exception is specified as a [[Date]] then any event that is scheduled for that 24 hour period should be excluded from the schedule. This allows a whole day to be excluded from the schedule without having to itemise every scheduled event. |
DateTime |
repeatFrequency |
Defines the frequency at which [[Event]]s will occur according to a schedule [[Schedule]]. The intervals between events should be defined as a [[Duration]] of time. |
Text |
scheduleTimezone |
Indicates the timezone for which the time(s) indicated in the [[Schedule]] are given. The value provided should be among those listed in the IANA Time Zone Database. |
Text |
byMonthWeek |
Defines the week(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-5. For clarity, byMonthWeek is best used in conjunction with byDay to indicate concepts like the first and third Mondays of a month. |
Integer |
duration |
The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. |
Duration |
byDay |
Defines the day(s) of the week on which a recurring [[Event]] takes place. May be specified using either [[DayOfWeek]], or alternatively [[Text]] conforming to iCal's syntax for byDay recurrence rules. |
Text |
byMonthDay |
Defines the day(s) of the month on which a recurring [[Event]] takes place. Specified as an [[Integer]] between 1-31. |
Integer |
repeatCount |
Defines the number of times a recurring [[Event]] will take place. |
Integer |
byMonth |
Defines the month(s) of the year on which a recurring [[Event]] takes place. Specified as an [[Integer]] between 1-12. January is 1. |
Integer |
startDate |
The start date and time of the item (in ISO 8601 date format). |
DateTime |
endDate |
The end date and time of the item (in ISO 8601 date format). |
DateTime |
EventStatusType
EventStatusType is an enumeration type whose instances represent several states that an Event may be in.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
StatusEnumeration
Lists or enumerations dealing with status types.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
AboutPage
Web page type: About page.
Property |
Definition |
Type |
significantLink |
One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most. |
URI |
specialty |
One of the domain specialities to which this web page's content applies. |
Specialty |
reviewedBy |
People or organizations that have reviewed the content on this web page for accuracy and/or completeness. |
Organization |
lastReviewed |
Date on which the content on this web page was last reviewed for accuracy and/or completeness. |
Date |
relatedLink |
A link related to this web page, for example to other related web pages. |
URI |
breadcrumb |
A set of links that can help a user understand and navigate a website hierarchy. |
BreadcrumbList |
significantLinks |
The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most. |
URI |
mainContentOfPage |
Indicates if this web page element is the main subject of the page. |
WebPageElement |
speakable |
Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.The speakable property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:1.) id-value URL references - uses id-value of an element in the page being annotated. The simplest use of speakable has (potentially relative) URL values, referencing identified sections of the document concerned.2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the speakable property. |
SpeakableSpecification |
primaryImageOfPage |
Indicates the main image on the page. |
ImageObject |
Article
An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.\n\nSee also blog post.
Property |
Definition |
Type |
pageEnd |
The page on which the work ends; for example "138" or "xvi". |
Integer |
wordCount |
The number of words in the text of the Article. |
Integer |
articleSection |
Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc. |
Text |
articleBody |
The actual body of the article. |
Text |
speakable |
Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.The speakable property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:1.) id-value URL references - uses id-value of an element in the page being annotated. The simplest use of speakable has (potentially relative) URL values, referencing identified sections of the document concerned.2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the speakable property. |
SpeakableSpecification |
backstory |
For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc. |
CreativeWork |
pagination |
Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". |
Text |
pageStart |
The page on which the work starts; for example "135" or "xiii". |
Integer |
NonprofitType
NonprofitType enumerates several kinds of official non-profit types of which a non-profit organization can be.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
ActionStatusType
The status of an Action.
Property |
Definition |
Type |
supersededBy |
Relates a term (i.e. a property, class or enumeration) to one that supersedes it. |
Class |
Classification
A classification scheme and code / name representing a category value for a product, entity, or facility.
Property |
Definition |
Type |
id |
The globally unique URI representing the specific classifier value - for example https://vocabulary.uncefact.org/unlocode?country=au#AUSYD is the gloabl URI representing the UN/LOCODE for Sydney Australia. |
URI |
classificationSchemeID |
Classification scheme - eg https://unstats.un.org/unsd/classifications/Econ/cpc |
URI |
classificationSchemeName |
The name of the classificaiotn schema - eg United Nations Central Product Classification |
Text |
classifierValue |
classifier value within the scheme - eg "01211" in UN CPC |
Text |
classifierName |
Name of the classifier - eg "Asparagus" for code "01211" in UNCPC |
Text |
Identifier
An identifier of a party, product, or facility that is defined by an identifier scheme and idenfier value.
Property |
Definition |
Type |
id |
A linked data URL for the entity (product, facility, or organisation) that is identified by this identifier - eg https://abr.business.gov.au/ABN/View?abn=90664869327 |
URI |
idScheme |
the identifier scheme as defined by the registrar that manages the identifier registry. Eg abr.busines.gov.au If the identifier scheme is registered with UNTP then this URI can use used to dicsover the resolution method (to get more data) and the verification method (to prove ownership). |
URI |
idSchemeName |
The identifier scheme name (eg Australian Business Number or GS1 Global Trade Item Number)) |
Text |
idValue |
The value of the identifier within the scheme (eg 90664869327) |
Text |
Attestation
A conformity attestation issued by a competent body that defines one or more assessments (eg carbon intensity) about a product (eg batttery) against a specification (eg LCA method) defined in a standard or regulation.
Property |
Definition |
Type |
id |
The globally unique ID of this conformity attestation. |
URI |
assessorLevel |
Assurance code pertaining to assessor (relation to the object under assessment) |
Code (assessorAssuranceCode) |
assessmentLevel |
Assurance pertaining to assessment (any authority or support for the assessment process) |
Code (assessmentAssuranceCode) |
attestationType |
The type of criterion (optional or mandatory). |
Code (attestationTypeCode) |
attestationDescription |
A textual description of the scope or purpose of this confomrity attestation |
Text |
issuedTo |
The party to whom the conformity attestation was issued. |
PartyID |
accreditation |
The accreditation from a competent authority (ag NATA) that confirms the issuers authorised scope of assessments. |
Authorisation |
conformityCertificate |
A reference to the human / printable version of this conformity attestation - typically represented as a PDF document. The document may have more details than are represented in the digital attestation. |
BinaryFile |
auditableEvidence |
Auditable evidence supporting this assessment such as raw measurements, supporting documents. This is usally private data and would normally be encrypted. |
SecureBinaryFile |
Authorisation
The authority under which a conformity claim is issued. For example a national accrediation authority may accredit a test lab to issue test certificates about a product against a standard.
Property |
Definition |
Type |
id |
The globally unique URI for this authorisation. Use idScheme/idValue if not otherwise defined by the issuing authority |
URI |
idScheme |
A globally unique ID for the authorisation scheme. use issuer authority domainName/schemeName if not otherwise specified. |
URI |
idSchemeName |
The name given to this authoristion scheme. |
Text |
idValue |
the authorisation number such as an accreditation number |
Text |
trustmark |
The trust mark image awarded by the AB to the CAB to indicate accrediation. |
BinaryFile |
issuingAuthority |
The competent authority that issued the accreditation. |
PartyID |
accreditationCertificate |
The evidence that supports the authroty under which the attestation is issued - eg an accreditation certificate. |
URI |
AuthorisationID
The ID and Name of an authorisation. Used for lightweight links from other classes.
Property |
Definition |
Type |
id |
The globally unique URI for this authorisation. Use idScheme/idValue if not otherwise defined by the issuing authority |
URI |
idScheme |
A globally unique ID for the authorisation scheme. use issuer authority domainName/schemeName if not otherwise specified. |
URI |
idSchemeName |
The name given to this authoristion scheme. |
Text |
idValue |
the authorisation number such as an accreditation number |
Text |
BinaryFile
A file representing a data snapshot that is used to infomr the conformity assessment.
Property |
Definition |
Type |
id |
GLobally unique ID for the binary file - usually it's location as a URL. |
URI |
fileName |
A name for referenced binary file |
Text |
fileType |
The type of file, represented as a MIME type. |
Code (mimeType) |
SecureBinaryFile
A binary file that is hashed ()for tamper evidence) and optionally encrypted (for confidentiality).
Property |
Definition |
Type |
id |
GLobally unique ID for the binary file - usually it's location as a URL. |
URI |
fileName |
A name for referenced binary file |
Text |
fileType |
The type of file, represented as a MIME type. |
Code (mimeType) |
fileHash |
The MD5 hash of the file. |
Text |
hashMethod |
The hashing algorithm used to create the file hash. SHA-265 is the recommedned standard |
Code (hashMethodCode) |
encryptionMethod |
The symmetric encryption algorithm used to encrypt this binary file. AES is the recommended standard |
Code (encryptionMethodCode) |
Standard
A standard (eg ISO 14000) that specifies the criteria for conformance.
Property |
Definition |
Type |
id |
The globally unique ID of the standard - eg https://www.iso.org/standard/60857.html |
URI |
standardName |
The name of the standard (eg ISO 14001:2015 Environmental management system) |
Text |
issuingBody |
The party that issued the standard (ID and Name reference only) |
PartyID |
issueDate |
The date when the standard was issued. |
Date |
StandardID
The ID and Name of a conformity standard. Used for lightweight links from other classes.
Property |
Definition |
Type |
id |
The globally unique ID of the standard - eg https://www.iso.org/standard/60857.html |
URI |
standardName |
The name of the standard (eg ISO 14001:2015 Environmental management system) |
Text |
Declaration
A specific assessment about the product or facility against a specific specification. Eg the carbon intensity of a given product or batch.
Property |
Definition |
Type |
id |
A unique identifier for the standard (eg https://www.iso.org/standard/60857.html). |
URI |
referenceStandard |
The reference to the standard that defines the specification / criteria |
Standard |
referenceRegulation |
The reference to the regulation that defines the assessment criteria |
Regulation |
assessmentCriterion |
The specification against which the assessment is made. |
Criteria |
declaredValues |
The list of specific values measured as part of this assessment (eg tensile strength) |
Metric |
compliance |
An indicator of whether or not the assessment meets the specification. |
Indicator |
conformityTopic |
The conformity topic category for this assessment (eg vocabulary.uncefact.org/sustainability/emissions) |
Code (conformityTopicCode) |
Regulation
A regulation (eg EU deforestation regulation) that defines the criteria for assessment.
RegulationID
The ID and Name of an act or regulation. Used for lightweight links from other classes.
Criteria
A specific rule or criterion within a standard or regulation. eg a carbon intensity calculation rule within an emissions standard.
Property |
Definition |
Type |
id |
A unique identifier for the criterion - managed by the standards uthority or regulator. |
URI |
criteriName |
A name that describes this criteria (eg tensile strength) |
Text |
thresholdValues |
A conformity threshold defined by the specification (eg minimum compressive strength) |
Metric |
Metric
A specific measure of performance against the criteria that governs the claim. Expressed as an array of metric (ie unit of emasure) / value (ie the actual numeric value) pairs.
Property |
Definition |
Type |
metricName |
A human readable name for this metric (for example "Tensile strength") |
Text |
metricValue |
A numeric value and unit of measure for this metric. Could be a measured value or a specified threshold. |
Measure |
accuracy |
A percentage represented as a numeric between 0 and 1 indicating the rage of accuracy of the claimed value (eg 0.05 means that the actual value is within 5% of the claimed value.) |
Numeric |
Measure
The measure class defines a numeric measured value (eg 10) and a coded unit of measure (eg KG).
Property |
Definition |
Type |
value |
The numeric value of the measure |
Numeric |
unit |
Unit of measure drawn from the UNECE rec20 measure code list. |
Code (unitOfMeasure) |
ProductID
The ID and Name of a product. Used for lightweight links from other classes.
Property |
Definition |
Type |
id |
The globally unique ID of the product. eg )https://id.gs1.org/01/09520123456788/21/12345 |
URI |
idScheme |
The scheme used for the product identifier. Eg )https://id.gs1.org/01 |
URI |
idSchemeName |
The scheme name of the product identifier - eg SGTIN |
Text |
idValue |
The value of the identifier within the scheme - eg )09520123.456788.12345 |
Text |
productName |
The name of the product - eg ACME Tinned Beans 500g |
Text |
FacilityID
The ID and Name of a facility. Used for lightweight links from other classes.
Property |
Definition |
Type |
id |
|
URI |
idScheme |
remove because did already contains a scheme (ie it is a did:web) |
URI |
idSchemeName |
removed because this is defiend to be a DID |
Text |
idValue |
removed because the id is the did value. |
Text |
facilityName |
The name of this facility |
Text |
Code Tables
PostalCodeRangeSpecification
countryCode
Country code list.
Code values for this table can be found here:
https://vocabulary.uncefact.org/CountryId
assessorAssuranceCode
Code that describes the assurance level of the conformity assessment
Name |
Description |
Self |
self-assessment |
Commercial |
conformity assessment by related body or under commercial contract |
Buyer |
conformity assessment by potential purchaser |
Membership |
conformity assessment by industry representative body or membership body |
Unspecified |
conformity assessment by party with unspecified relationship |
3rdParty |
3rd party (independent) conformity assessment |
assessmentAssuranceCode
Name |
Description |
GovtApproval |
conformity assessment delivered under authority granted by national government |
GlobalMLA |
conformity assessment delivered under authority granted by IAF/ILAC signatory body |
Accredited |
conformity assessment delivered under an independent accreditation |
Verified |
conformity assessment externally verified |
Validated |
conformity assessment externally validated |
Unspecified |
conformity assessment claiming no external authority or else unspecified |
attestationTypeCode
A code for the type of the attestation credential
Code |
Description |
certification |
A formal third party certification of conformity |
declaration |
A self assessed declaration of conformity |
inspection |
An Inspection report |
testing |
A test report |
verification |
A verification report |
validation |
A validation report |
calibration |
An equipment calibration report |
mimeType
Code values for this table can be found here:
https://mimetype.io/all-types
hashMethodCode
Name |
Value |
Description |
SHA-256 |
Secure Hash Algorithm 256 bits |
|
encryptionMethodCode
Name |
Value |
Description |
none |
|
no encryption |
AES |
|
AES standard |
unitOfMeasure
UNECE Recommendation 20 Unit of Measure codelist
Code values for this table can be found here:
https://vocabulary.uncefact.org/UnitMeasureCode
conformityTopicCode
A high level category scheme for product and facility conformity declarations (claims or attestations)
Name |
Description |
environment.energy |
claims supporting clean energy transition |
environment.emissions |
claims supporting GHG emissions reduction |
environment.water |
claims supporting minimising water usage impact |
environment.waste |
claims supporting waste processing and reduction |
environment.deforestation |
claims supporting native forest restoration |
environment.biodiversity |
claims supporting improved biodiversity outcomes |
circularity.content |
claims supporting the use of recycled content in products |
circularity.design |
claims supporting product design for circularity outcomes |
social.labour |
claims supporting labour rights including fair wages |
social.rights |
claims supporting human rights and anti-discrimination |
social.community |
claims supporting local community development |
social.safety |
claims supporting process and product safety |
governance.ethics |
claims supporting ethical conduct and corporate governance |
governance.compliance |
claims supporting regulatory compliance including taxation and community protection |
governance.transparency |
claims supporting transparency and traceability |
Imported Domains
- [untp] - unece/untp-core:0.2.1