Note: You are viewing the development version of Schema.org. See how we work for more details.

LinkRole

A Schema.org Type

This term is in the "new" area - implementation feedback and adoption from applications and websites can help improve our definitions.
A Role that represents a Web link, e.g. as expressed via the 'url' property. Its linkRelationship property can indicate URL-based and plain textual link types, e.g. those in IANA link registry or others such as 'amphtml'. This structure provides a placeholder where details from HTML's link element can be represented outside of HTML, e.g. in JSON-LD feeds.
PropertyExpected TypeDescription
Properties from LinkRole
inLanguage Language  or
Text
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. Supersedes language.
linkRelationship Text Indicates the relationship type of a Web link.
Properties from Role
endDate Date  or
DateTime
The end date and time of the item (in ISO 8601 date format).
roleName Text  or
URL
A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might play in the position named 'Quarterback'. Supersedes namedPosition.
startDate Date  or
DateTime
The start date and time of the item (in ISO 8601 date format).
Properties from Thing
additionalType Text  or
URL
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. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
alternateName Text An alias for the item.
description Text  or
TextObject
A description of the item.
disambiguatingDescription Text 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.
identifier PropertyValue  or
Text  or
URL
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.
image ImageObject  or
URL
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
Inverse property: mainEntity
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL 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.
subjectOf CreativeWork  or
Event
A CreativeWork or Event about this Thing.
Inverse property: about
url URL URL of the item.

Source

https://github.com/schemaorg/schemaorg/issues/1045


Examples

Example 1
Copied
Example notes or example HTML without markup.
A restaurant has links to reserve tables. One caters to Japanese speakers.
Example encoded as JSON-LD in a HTML script tag.
<script type="application/ld+json">
{
 "@context": "https://schema.org/",
 "@type": "Restaurant",
 "potentialAction": {
   "@type": "ReserveAction",
   "target": [
     "http://www.example.com/Reserve",
     {
       "@type": "LinkRole",
       "target": "http://www.example.com/Reserve-JP",
       "inLanguage": "jp",
       "linkRelationship": "alternate"
     }
   ]
 }
}
</script>
Structured representation of the JSON-LD example.
Example 2
Copied
Example notes or example HTML without markup.
An article is available using AMP HTML.
Example encoded as JSON-LD in a HTML script tag.
<script type="application/ld+json">
{
 "@context": "https://schema.org/",
 "@type": "Article",
 "url": "http://www.example.com/article",
 "url": {
     "@type": "LinkRole",
     "url": "http://www.example.com/article-amp",
     "linkRelationship": "amphtml"
   }
}
</script>
Structured representation of the JSON-LD example.