LinkRole

Status: Pending

Breadcrumb: Thing > Intangible > Role > LinkRole

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.

Parent types

Role

Properties

Properties for LinkRole

Property	Expected type	Defined on	Description
inLanguage	Language, Text	LinkRole	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.
linkRelationship	Text	LinkRole	Indicates the relationship type of a Web link.

Inherited properties

Property	Expected type	Inherited from	Description
additionalType	Text, URL	Thing	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	Thing	An alias for the item.
description	Text, TextObject	Thing	A description of the item.
disambiguatingDescription	Text	Thing	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.
endDate	Date, DateTime	Role	The end date and time of the item (in ISO 8601 date format).
identifier	PropertyValue, Text, URL	Thing	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, URL	Thing	An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage	CreativeWork, URL	Thing	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
name	Text	Thing	The name of the item.
namedPosition	Text, URL	Role	A position played, performed or filled by a person or organization, as part of an organization. For example, an athlete in a SportsTeam might play in the position named 'Quarterback'.
owner	Organization, Person	Thing	A person or organization who owns this Thing.
potentialAction	Action	Thing	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
roleName	Text, URL	Role	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'.
sameAs	URL	Thing	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.
startDate	Date, DateTime	Role	The start date and time of the item (in ISO 8601 date format).
subjectOf	CreativeWork, Event	Thing	A CreativeWork or Event about this Thing.
url	URL	Thing	URL of the item.

Example

json

{
  "@context": "https://schema.org",
  "@type": "LinkRole",
  "name": "Example Name",
  "description": "A short description.",
  "url": "/example",
  "inLanguage": "Example value",
  "linkRelationship": "Example value"
}

LinkRole ​

Parent types ​

Properties ​

Properties for LinkRole ​