Action Schema Generator and Guide

Action

Schema.org Type

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. Specific action sub-type documentation specifies the exact expectation of each argument/role.

See also blog post and Actions overview document.

Generate this schema

We Can Help

Action schema is a sub type of:

This schema has more specific sub types.
Would you like to generate a more specific type of Action schema?

Action Schema Generator in JSON-LD

Create Knowledge Graph

Action schema code:

This Schema can take the following complex properties:


How to Create a Action Schema

Step 1: Fill out the form above as much as possible.

Note:Use this Schema.org based structured data generator tool to easily create Action schema.
The properties are the description of your entity. You don't have to fill in all the properties on this page. Provide what is available and leave what is not. To learn more about each property in your schema type please check Action schema properties


Step 2: When complete click the Copy Code button to get your JSON-LD code

Notes:To check if your code is eligible for featured snippets (rich snippets or rich results) test your code with the Rich Results Test tool to learn more about which schema are qualified for rich results check out Google’s search gallery.
To validate your markup code, check your JSON-LD code with the Schema Markup Validator


Step 3: To add a sub-schema, click on the Create Knowledge Graph button

Important Notes: to describe the relationship between your entities you must design a custom schema, this is where the 'creation of knowledge graph' is needed.
For example: if you have a local business and you want to add a service catalogue, or if you have a recipe schema and you want to add a HowTo steps, or if you have a product and you want to add a FAQ about it, to learn more watch this semantic SEO workshop




Generate this schema

Hire Us


Action Schema Properties

Action has 24 properties:

  • actionStatus Indicates the current disposition of the Action.
  • additionalType 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.
  • agent The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book.
  • alternateName An alias for the item.
  • description A description of the item.
  • disambiguatingDescription 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.
  • endTime The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the end of a clip within a larger file.

    Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
  • error For failed actions, more information on the cause of the failure.
  • identifier 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 An image of the item. This can be a URL or a fully described ImageObject.
  • instrument The object that helped the agent perform the action. e.g. John wrote a book with a pen.
  • location The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
  • mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
  • name The name of the item.
  • object The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book.
  • participant Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve.
  • potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
  • provider The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
  • result The result produced in the action. e.g. John wrote a book.
  • sameAs 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.
  • startTime The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.

    Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
  • subjectOf A CreativeWork or Event about this Thing.
  • target Indicates a target EntryPoint for an Action.
  • url URL of the item.