This section provides the details of the content markup properties for the Event
related entity type.
SportsEvent specification table
Property
Expected Type
Description
@context
Required- Always set to
["http://schema.org", {"@language": "xx"}]
- Replace
xxwith the entity's language code in BCP 47 format format, for example, "en".
@id
Required- The content's identifier in URI format; for example, https://example.com/1234abc
.
@id
must meet the following requirements:- Globally unique across your catalog
- Static; The ID should be stable and not change over time (even if the url property of the show changes). It will be treated as an opaque string and does not have to be a working link.
- In the form of Unified Resource Identifier (URI)
- The domain used for the @id value must be owned by your organization.
url
meets all the requirements as an identifier, we recommend you use an entity's url
as @id
. See the Identifier
section for more details.name
Required- The name of this event.
- Use an array to list the names in different languages. See the Multiple regions and languages example.
- Note that only one name is supported per locale (language-country pair).
description
The description of this event. 300-character limist. Use an array to include the descriptions in multiple languages and lengths.
startDate
Required- The start time of the event in ISO 8601 format
with time zone. Please note that this is the actual start time of event, instead of when the event is aired on TV.
homeTeam.sameAs
Highly Recommended Why?
A URL to a reference web page that can identify the team; for example, the Wikipedia page of the team.
homeTeam.parentOrganization.name
RequiredThe name of the sports league that the team is part of. For example, National Basketball Association or Major League Baseball. Note that this field should not be used for the team's conference.
homeTeam.parentOrganization.sameAs
Highly Recommended Why?
A URL to a reference web page that can identify the league of the team; for example, the Wikipedia page of the league.
awayTeam
Highly Recommended Why?
The away team of the event. The properties are the same as
SportsEvent.homeTeam
.competitor
Highly Recommended Why?
If the home or away team is not applicable (e.g., a boxing match, the Olympics), specify the participants as competitors. If
SportsTeam
, the properties are the same as SportsEvent.homeTeam
. If Person
, the properties are the same as other Person
objects; for instance, an actor in Movie
.location.address
Required if location @type is Place- The address of the location. This shouldn't be used if location @type is City
image
Required for Google TV- The image(s) related to the event. Recommended to be the official poster or banner art for the event. For more details on the required and optional properties to include with
image
, see Image properties
.potentialAction
Required if applicable- The deep link that plays the recording of this sports event on Video on Demand. To specify the deep link for a live event, use the
publishedOn
or potentialAction
property in BroadcastEvent
instead.identifier
Highly Recommended Why?
- External or other ID that unambiguously identifies this entity. Multiple identifiers are allowed. See the Identifier properties
section for details.
SportsEvent examples
Team Sport Example
{
"@context"
:
[
"http://schema.org"
,
{
"@language"
:
"en"
}],
"@type"
:
"SportsEvent"
,
"@id"
:
"http://example.com/basketball/professional/final_game_6"
,
"name"
:
"2019 Professional Basketball Finals, Game 6: Team A at Team B"
,
"sport"
:
"https://en.wikipedia.org/wiki/Basketball"
,
"description"
:
[
{
"@language"
:
"en"
,
"@value"
:
"Game 6 of the 2019 Professional Basketball Finals. Team A leads the series 3-2 against Team B."
},
{
"@language"
:
"en"
,
"@value"
:
"2019 Professional Basketball, Game 6. Team A at Team B."
}
],
"startDate"
:
"2018-09-16T21:10-08:00"
,
"homeTeam"
:{
"@type"
:
"SportsTeam"
,
"name"
:
"Team B"
,
"sport"
:
"https://en.wikipedia.org/wiki/Basketball"
,
"parentOrganization"
:{
"@type"
:
"SportsOrganization"
,
"name"
:
"Professional Basketball League"
,
"sameAs"
:
"http://www.example.com/professional_basketball_league"
}
"athlete"
:[
{
"@type"
:
"Person"
,
"name"
:
"John doe"
}
]
},
"awayTeam"
:{
"@type"
:
"SportsTeam"
,
"name"
:
"Team A"
,
"sport"
:
"https://en.wikipedia.org/wiki/Basketball"
,
"athlete"
:[
{
"@type"
:
"Person"
,
"name"
:
"Jane Doe"
}
]
},
"location"
:{
"@type"
:
"Place"
,
"name"
:
"Example Stadium"
,
"address"
:{
"@type"
:
"PostalAddress"
,
"streetAddress"
:
"1600 Amphitheatre Pkwy"
,
"addressLocality"
:
"Mountain View"
,
"addressRegion"
:
"CA"
,
"postalCode"
:
"94043"
,
"addressCountry"
:
"US"
}
}
"identifier"
:
[
{
"@type"
:
"PropertyValue"
,
"propertyID"
:
"TMS_ID"
,
"value"
:
"TMS ID of this game"
}
]
}
Individual Sports Example
{
"@context"
:
[
"http://schema.org"
,
{
"@language"
:
"en"
}],
"@type"
:
"SportsEvent"
,
"@id"
:
"http://example.com/boxing/johndoe_vs_janedoe_2019"
,
"name"
:
"2019 Professional Boxing - John Doe vs Jane Doe"
,
"sport"
:
"https://en.wikipedia.org/wiki/Boxing"
"description"
:
"World champion Jane Doe fights undefeated John Doe at the Example Arena in Mountain View, California."
,
"startDate"
:
"2019-07-12T21:10-08:00"
,
"competitor"
:[
{
"@type"
:
"Person"
,
"name"
:
"Jane Doe"
,
"birthDate"
:
"1977-12-14"
,
"gender"
:
"F"
,
"nationality"
:
"US"
},
{
"@type"
:
"Person"
,
"name"
:
"John Doe"
,
"birthDate"
:
"1978-10-17"
,
"gender"
:
"M"
,
"nationality"
:
"GB"
}
],
"location"
:{
"@type"
:
"Place"
,
"name"
:
"Example Arena"
,
"address"
:{
"@type"
:
"PostalAddress"
,
"streetAddress"
:
"1600 Amphitheatre Pkwy"
,
"addressLocality"
:
"Mountain View"
,
"addressRegion"
:
"CA"
,
"postalCode"
:
"94043"
,
"addressCountry"
:
"US"
}
}
}
SportsEvent with GeoShape restrictions
{
"@context"
:
[
"http://schema.org"
,
{
"@language"
:
"en"
}],
"@type"
:
"SportsEvent"
,
"@id"
:
"http://example.com/basketball/professional/final_game_6"
,
"name"
:
"2019 Professional Basketball Finals, Game 6: Team A at Team B"
,
"sport"
:
"https://en.wikipedia.org/wiki/Basketball"
,
"description"
:
[
{
"@language"
:
"en"
,
"@value"
:
"Game 6 of the 2019 Professional Basketball Finals. Team A leads the series 3-2 against Team B."
},
{
"@language"
:
"en"
,
"@value"
:
"2019 Professional Basketball, Game 6. Team A at Team B."
}
],
"startDate"
:
"2018-09-16T21:10-08:00"
,
"homeTeam"
:{
"@type"
:
"SportsTeam"
,
"name"
:
"Team B"
,
"sport"
:
"https://en.wikipedia.org/wiki/Basketball"
,
"parentOrganization"
:{
"@type"
:
"SportsOrganization"
,
"name"
:
"Professional Basketball League"
,
"sameAs"
:
"http://www.example.com/professional_basketball_league"
}
"athlete"
:[
{
"@type"
:
"Person"
,
"name"
:
"John doe"
}
]
},
"awayTeam"
:{
"@type"
:
"SportsTeam"
,
"name"
:
"Team A"
,
"sport"
:
"https://en.wikipedia.org/wiki/Basketball"
,
"athlete"
:[
{
"@type"
:
"Person"
,
"name"
:
"Jane Doe"
}
]
},
"location"
:{
"@type"
:
"Place"
,
"name"
:
"Example Stadium"
,
"address"
:{
"@type"
:
"PostalAddress"
,
"streetAddress"
:
"1600 Amphitheatre Pkwy"
,
"addressLocality"
:
"Mountain View"
,
"addressRegion"
:
"CA"
,
"postalCode"
:
"94043"
,
"addressCountry"
:
"US"
}
}
"identifier"
:
[
{
"@type"
:
"PropertyValue"
,
"propertyID"
:
"TMS_ID"
,
"value"
:
"TMS ID of this game"
}
]
"potentialAction"
:
[
{
"@type"
:
"WatchAction"
,
"target"
:
{
"@type"
:
"EntryPoint"
,
"urlTemplate"
:
"http://www.example.com/my_favorite_movie?autoplay=true"
,
"inLanguage"
:
"en"
,
"actionPlatform"
:
[
"http://schema.org/DesktopWebPlatform"
,
"http://schema.org/MobileWebPlatform"
,
"http://schema.org/AndroidPlatform"
,
"http://schema.org/IOSPlatform"
,
http
:
//schema.googleapis.com/GoogleVideoCast
]
},
"actionAccessibilityRequirement"
:
{
"@type"
:
"ActionAccessSpecification"
,
"category"
:
"free"
,
"availabilityStarts"
:
"2019-01-01T10:35:29Z"
,
"availabilityEnds"
:
"2020-05-31T10:35:29Z"
,
"eligibleRegion"
:
{
"@type"
:
"Country"
,
"name"
:
"US"
}
}
},
{
"@type"
:
"WatchAction"
,
"target"
:
{
"@type"
:
"EntryPoint"
,
"urlTemplate"
:
"http://www.example.com/my_favorite_movie?autoplay=true"
,
"inLanguage"
:
"en"
,
"actionPlatform"
:
"http://schema.org/AndroidTVPlatform"
,
},
"actionAccessibilityRequirement"
:
{
"@type"
:
"ActionAccessSpecification"
,
"category"
:
"subscription"
,
"availabilityStarts"
:
"2019-01-01T10:35:29Z"
,
"availabilityEnds"
:
"2020-05-31T10:35:29Z"
,
"requiresSubscription"
:
{
"@type"
:
"MediaSubscription"
,
"name"
:
"Example Package"
,
"commonTier"
:
true
,
"@id"
:
"http://www.example.com/example_package"
},
"eligibleRegion"
:
[{
"@type"
:
"GeoShape"
,
"@id"
:
"http://example.com/area1"
,
"addressCountry"
:
"US"
,
"postalCode"
:
[
"94118"
,
"94119"
]
},
{
"@type"
:
"GeoShape"
,
"@id"
:
"http://example.com/area2"
,
"addressCountry"
:
"US"
,
"postalCode"
:
[
"94120"
,
"94121"
]
},
]
}
}
]
}
MusicEvent specification table
Property
Expected Type
Description
@context
Required- Always set to
["http://schema.org", {"@language": "xx"}]
- Replace
xxwith the entity's language code in BCP 47 format format, for example, "en".
@id
Required- The content's identifier in URI format; for example, https://example.com/1234abc
.
@id
must meet the following requirements:- Globally unique across your catalog
- Static
- In the form of Unified Resource Identifier (URI)
url
meets all the requirements as an identifier, we recommend you use an entity's url
as @id
. See the Identifier
section for more details.name
Required- The name of this event.
- Use an array to list the names in different languages. See the Multiple regions and languages example.
- Note that only one name is supported per locale (language-country pair).
description
The description of the event. 300-character limist. Use an array to include the descriptions in multiple languages and lengths.
composer
The person or organization who wrote a composition, or who is the composer of a work performed at some event.
performer
Required- A performer at the event—for example, a presenter, a musician, musical group or actor.
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.
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.
location.address
Required if location @type is Place- The address of the location. This should not be used if location @type is City.
workPerformed
A work performed in some event, for example a play performed in a TheaterEvent.
MusicEvent example
MusicEvent
{
"@context"
:
"http://schema.org"
,
"@type"
:
"MusicEvent"
,
"@id"
:
"http://example.com/music/my_favortie_artist/2019_tour"
,
"name"
:
"My Favorite Artist’s 2019 Homecoming Tour"
,
"description"
:
"After 8 years off the music scene, My Favorite Artist is back with the Homecoming Tour."
,
"startDate"
:
"2014-10-12T21:10-08:00"
,
"location"
:{
"@type"
:
"Place"
,
"name"
:
"Example Arena"
,
"address"
:{
"@type"
:
"PostalAddress"
,
"streetAddress"
:
"1600 Amphitheatre Pkwy"
,
"addressLocality"
:
"Mountain View"
,
"addressRegion"
:
"CA"
,
"postalCode"
:
"94043"
,
"addressCountry"
:
"US"
}
},
"performer"
:
{
"@type"
:
"Person"
,
"name"
:
"My Favorite Artist"
,
"birthDate"
:
"1977-02-24"
,
"gender"
:
"F"
,
"nationality"
:
"CA"
}
}
Event specification table
Property
Expected Type
Description
@context
Required- Always set to
["http://schema.org", {"@language": "xx"}]
- Replace
xxwith the entity's language code in BCP 47 format format, for example, "en".
@id
Required- The content's identifier in URI format; for example, https://example.com/1234abc
.
@id
must meet the following requirements:- Globally unique across your catalog
- Static
- In the form of Unified Resource Identifier (URI)
url
meets all the requirements as an identifier, we recommend you use an entity's url
as @id
. See the Identifier
section for more details.name
Required- The name of this event.
- Use an array to list the names in different languages. See the Multiple regions and languages example.
- Note that only one name is supported per locale (language-country pair).
description
The description of the event. 300-character limist. Use an array to include the descriptions in multiple languages and lengths.
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.
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.
releasedEvent
Highly Recommended Why?
- A
Additionally, use
See the example section for details and examples.
PublicationEvent
is used to specify the original (global or local) release of content by a publisher, such as the original theatrical release date of a movie.Additionally, use
FeaturedEvent
to indicate that your service markets this content as either an original, featured, special, and so forth.ExclusiveEvent
specifies that your service has exclusive distribution rights and includes where and when.See the example section for details and examples.
releasedEvent.@type
Required- Be sure to always set this property to one of the following:
-
PublicationEvent -
ExclusiveEvent -
FeaturedEvent
releasedEvent.location
Required- The regions that are associated with this event.
For a
For
Use ISO 3166 codes for countries. To indicate everywhere in the world, set to
For a
PublicationEvent
, this is the region where the content was published.For
FeaturedEvent
and ExclusiveEvent
, this is the region where the content is featured or exclusive.Use ISO 3166 codes for countries. To indicate everywhere in the world, set to
EARTH
.releasedEvent.startDate
Recommended- Required for
For a
For
ExclusiveEvent
- The start date of the entity's publication.For a
PublicationEvent
, this denotes the initial release date of this entity, such as the date a movie was first released in theaters.For
ExclusiveEvent
and FeaturedEvent
, this represents the start date of when the entity is exclusive or featured.releasedEvent.endDate
Recommended- Required for
For
For
If the content is perpetually exclusive or featured, set the
ExclusiveEvent
- This is only applicable to the ExclusiveEvent
and FeaturedEvent
types.For
ExclusiveEvent
, this represents the date when the rights to the content expire.For
FeaturedEvent
, this represents the last date when the provider features the entity.If the content is perpetually exclusive or featured, set the
endDate
to 20 years from the current date.releasedEvent.publishedBy
Optional- The organization or person that published this entity.
location
Required- The location of the event. Note that you can provide
Place
in City
level.location.address
Required if location @type is Place- The address of the location. This should not be used if location @type is City
workPerformed
A work performed in some event, for example a play performed in a TheaterEvent.
Event example
Event
{
"@context"
:
"http://schema.org"
,
"@type"
:
"Event"
,
"@id"
:
"http://example.com/keynote/google_io_2019"
,
"name"
:
"Google I/O 2019 keynote"
,
"description"
:
"Google’s annual developer conference keynote event."
,
"startDate"
:
"2019-05-07T10:00-08:00"
,
"location"
:{
"@type"
:
"Place"
,
"name"
:
"Example Arena"
,
"address"
:{
"@type"
:
"PostalAddress"
,
"streetAddress"
:
"1600 Amphitheatre Pkwy"
,
"addressLocality"
:
"Mountain View"
,
"addressRegion"
:
"CA"
,
"postalCode"
:
"94043"
,
"addressCountry"
:
"US"
}
},
"attendee"
:
{
"@type"
:
"Person"
,
"name"
:
"My Favorite Speaker"
,
"birthDate"
:
"1971-12-02"
,
"gender"
:
"F"
,
"nationality"
:
"IN"
}
}
