LinkRole
Defined in the pending.schema.org extension.Canonical URL: http://schema.org/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.
Usage: Fewer than 10 domains
| Property | Expected Type | Description |
|---|---|---|
| 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 | 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 | The start date and time of the item (in ISO 8601 date format). |
| Properties from Thing | ||
additionalType
|
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. 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. |
alternateName
|
Text | An alias for the item. |
description
|
Text | 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. |
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, Freebase page, or official website. |
url
|
URL | URL of the item. |
Source
https://github.com/schemaorg/schemaorg/issues/1045
Examples
A restaurant has links to reserve tables. One caters to Japanese speakers.
Example is JSON-LD only.
Example is JSON-LD only.
<script type="application/ld+json">
{
"@context": "http://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>
A restaurant has links to reserve tables. One caters to Japanese speakers.
Example is JSON-LD only.
Example is JSON-LD only.
<script type="application/ld+json">
An article is available using AMP HTML.
Example is JSON-LD only.
Example is JSON-LD only.
<script type="application/ld+json">
{
"@context": "http://schema.org/",
"@type": "Article",
"url": [
"http://www.example.com/article",
{
"@type": "LinkRole",
"url": "http://www.example.com/article-amp",
"linkRelationship": "amphtml"
}
]
}
</script>
Schema Version 3.0