Schema.org - Actions

Schema.org - Actions
OC Working Group – 16.06.2014
Anton Evangelatov
©www.sti-innsbruck.at
Copyright 2008 STI INNSBRUCK www.sti-innsbruck.at
2
Overview
Introduction – what is Schema.org
Introduction – what is Schema.org Actions
Overview of Schema.org Actions

ActionStatus

potentialAction

EntryPoint

I/O constraints
Questions
www.sti-innsbruck.at
3
What is Schema.org?
Launched in June, 2011.
An initiative by Bing, Google, Yahoo and Yandex.
Schema.org is a common set of schemas for structured data markup on web
pages.
Such markup can be recognized by search engine spiders and other
parsers, thus gaining access to the meaning of the sites.
www.sti-innsbruck.at
4
What is Schema.org Actions?
A vocabulary that enables websites to describe the actions they enable and
how these actions can be invoked.
Before 2014 http://schema.org/Action was used to describe past
Actions.
Now is also features the capability to perform an action in the future, as well
as the definition of how that capability can be exercised.
For example:



making a reservation
watching a movie
commenting on a post
www.sti-innsbruck.at
5
Overview – http://schema.org/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.
www.sti-innsbruck.at
6
Overview – http://schema.org/Action
<!-- John listened to Pink with Steve at Anna's apartment on his iPod. -->
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "ListenAction",
"agent": {
"@type": "Person",
"name": "John"
},
"object": {
"@type": "MusicGroup",
"name": "Pink!"
},
"participant": {
"@type": "Person",
"name": "Steve"
},
"location": {
"@type": "Residence",
"name": "Ann's apartment"
},
"instrument": {
"@type": "Product",
"name": "iPod"
}
}
</script>
www.sti-innsbruck.at
7
Overview – http://schema.org/Action
<!-- John created an exercise plan with Steve. -->
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "CreateAction",
"agent": {
"@type": "Person",
"name": "John"
},
"result": {
"@type": "ExercisePlan",
"name": "John's weight loss plan"
},
"participant": {
"@type": "Person",
"name": "Steve"
}
}
</script>
www.sti-innsbruck.at
8
http://schema.org/Action - ActionStatus
Action status
Indicates the current disposition of the Action.
A mechanism for differentiating potential actions from actions that have
actually taken place or are even still in-progress
Enumeration members



PotentialActionStatus - A description of an action that is supported
ActiveActionStatus - An in-progress action (e.g., while watching the movie,
or driving to a location)
CompletedActionStatus - An action that has already taken place
www.sti-innsbruck.at
9
http://schema.org/Action - potentialAction
Connecting Actions to Things
Frequently actions are taken or offered in the context of an object (e.g.,
watch this movie, review this article, share this webpage, etc.).
We introduce a new property called potentialAction for describing the
"prototype" of an action that can be taken on that Thing.
<!-- describing that this Thing can be watched -->
{
"@context": "http://schema.org",
"@type": "Movie",
"name": "Footloose",
"potentialAction":
{
"@type": "WatchAction"
}
}
www.sti-innsbruck.at
10
http://schema.org/Action - EntryPoint
Action EntryPoints
Potential actions are materialized via execution against the target EntryPoint
of an Action.
{
"@context": "http://schema.org",
"@type": "Movie",
"name": "Footloose",
"potentialAction":
{
"@type": "WatchAction",
"target" : "http://example.com/player?id=123"
}
}
www.sti-innsbruck.at
11
http://schema.org/Action - I/O constraints
Input and Output constraints
Additional information is often required from a user or client in order to
formulate a complete request. To facilitate this process we need the ability to
describe within a potential action how to construct these inputs.
{
"@context": "http://schema.org",
"@type": "WebSite",
"name": "Example.com",
"potentialAction":
{
"@type": "SearchAction",
"target": "http://example.com/search?q={q}",
"query-input": "required maxlength=100 name=q"
}
}
www.sti-innsbruck.at
12
Thank you for your attention
Questions?
Additional information:



http://blog.schema.org/2014/04/announcing-schemaorg-actions.html
https://www.w3.org/wiki/images/1/10/PotentialActionsApril11.pdf
http://en.wikipedia.org/wiki/JSON-LD
www.sti-innsbruck.at