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. Specific action sub-type documentation specifies the exact expectation of each argument/role. See also blog post and Actions overview document.
Build Action JSON-LD
Loading the builder…
More specific types
Use the most specific type that fits. Each accepts every property of Action.
Properties (26)
| Property | Expects | Description |
|---|---|---|
| actionProcess | HowTo | Description of the process by which the action was performed. |
| actionStatus | ActionStatusType | Indicates the current disposition of the Action. |
| agent | Organization, Person | The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book. |
| endTime | DateTime, Time | 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 | Thing | For failed actions, more information on the cause of the failure. Consider using the Error type. |
| instrument | Thing | The object that helped the agent perform the action. E.g. John wrote a book with *a pen*. |
| location | Place, PostalAddress, Text, VirtualLocation | The location of, for example, where an event is happening, where an organization is located, or where an action takes place. |
| object | Thing | 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 | Organization, Person | Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*. |
| provider | Organization, Person | 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 | Thing | The result produced in the action. E.g. John wrote *a book*. |
| startTime | DateTime, Time | 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. |
| target | EntryPoint, URL | Indicates a target EntryPoint, or url, for an Action. |
Where Action is used as a value
These properties expect a Action: interactionType, potentialAction.