ActionAccessSpecification

A Schema.org Type

Thing > Intangible > ActionAccessSpecification

[more...]

Canonical URL: https://schema.org/ActionAccessSpecification
Check for open issues.

A set of requirements that must be fulfilled in order to perform an Action.

Property	Expected Type	Description
Properties from ActionAccessSpecification
`availabilityEnds`	Date or DateTime or Time	The end of the availability of the product or service included in the offer.
`availabilityStarts`	Date or DateTime or Time	The beginning of the availability of the product or service included in the offer.
`category`	CategoryCode or PhysicalActivityCategory or Text or Thing or URL	A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
`eligibleRegion`	GeoShape or Place or Text	The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid. See also ineligibleRegion.
`expectsAcceptanceOf`	Offer	An Offer which must be accepted before the user can perform the Action. For example, the user may need to buy a movie before being able to watch it.
`ineligibleRegion`	GeoShape or Place or Text	The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed. See also eligibleRegion.
`requiresSubscription`	Boolean or MediaSubscription	Indicates if use of the media require a subscription (either paid or free). Allowed values are `true` or `false` (note that an earlier version had 'yes', 'no').
Properties from Thing
`additionalType`	Text or 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. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
`alternateName`	Text	An alias for the item.
`description`	Text or TextObject	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.
`identifier`	PropertyValue or Text or URL	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`	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, Wikidata entry, or official website.
`subjectOf`	CreativeWork or Event	A CreativeWork or Event about this Thing. Inverse property: about
`url`	URL	URL of the item.

Instances of ActionAccessSpecification may appear as a value for the following properties

Property	On Types	Description
actionAccessibilityRequirement	ConsumeAction	A set of requirements that must be fulfilled in order to perform an Action. If more than one value is specified, fulfilling one set of requirements will allow the Action to be performed.

Source

https://github.com/schemaorg/schemaorg/issues/1741

Examples

Example 1

No Markup JSON-LD Structure

Example notes or example HTML without markup.

See JSON example.

Example encoded as JSON-LD in a HTML script tag.

<script type="application/ld+json">
{
  "@context": "https://schema.org/",
  "@type": "MusicRecording",
  "potentialAction": {
    "@type": "ListenAction",
    "actionAccessibilityRequirement": {
      "@type": "ActionAccessSpecification",
      "availabilityStarts": "2017-01-01T00:00",
      "availabilityEnds": "2017-12-31T00:00",
      "eligibleRegion": {
        "@type": "Country",
        "sameAs": "https://www.wikidata.org/wiki/Q166433",
        "name": "US"
      },
      "requiresSubscription": {
        "@type": "MediaSubscription",
        "name": "ACME streaming music monthly subscription",
        "authenticator": {
          "@type": "Organization",
          "name": "ACME Media"
        }
      },
      "expectsAcceptanceOf": {
        "@type": "Offer",
        "itemOffered": {
          "@type": "MusicRecording",
          "name": "Song I want to stream that is only available for streaming after I buy it."
        }
      }
    }
  }
}
</script>

Structured representation of the JSON-LD example.