Listen Actions' common properties

  • Listen Actions require specific action markup properties, including potentialAction.@type set to ListenAction and a target object that maps deep links to Google platforms.

  • The target object for Listen Actions requires a urlTemplate for deep linking and actionPlatform to specify supported platforms like web, Android, iOS, and Chromecast.

  • Listen Actions utilize an expectsAcceptanceOf container for offer details, specifying the content access requirement (category), availability dates (availabilityStarts, availabilityEnds), and eligible regions (eligibleRegion).

  • Image markup for Listen Actions requires an image.@type of ImageObject and a contentUrl pointing to the image URL.

This section provides the details of the common properties of Listen Actions.

Action markup properties

Property Expected type Description
potentialAction.@type Text Required - Always set to ListenAction.
target EntryPoint Required - A target object that provides the mapping of deep links to various Google platforms.
target.@type Text Required - Always set to EntryPoint.
target.urlTemplate URL Required - A deep link that takes users to your app or platform and initiates playback of the content.
target.actionPlatform Text Required - The platforms that are mapped to urlTemplate. Media Actions support the following:
  • http://schema.org/DesktopWebPlatform: Search platform on desktop web browsers.
  • http://schema.org/MobileWebPlatform: Search platform on mobile web browsers.
  • http://schema.org/AndroidPlatform: Search and PlayGuide platforms on Android app.
  • http://schema.org/AndroidTVPlatform: Android TV platform on Android TV app.
  • http://schema.org/IOSPlatform: Search platform on iOS app.
  • http://schema.googleapis.com/GoogleVideoCast: Cast and Home platforms on a Chromecast device.
  • http://schema.googleapis.com/GoogleAudioCast: Cast and Home platforms on a Chromecast device (Listen Actions only).
See the Platform types section for requirements.
expectsAcceptanceOf Offer Required - A container for the offer object.
expectsAcceptanceOf.@type Text Required - Always set to Offer.
expectsAcceptanceOf.category Text Required - An access requirement for the content. Use one of the following:
  • nologinrequired: The content does not require purchase or login.
  • free: The content requires users to be logged in and does not require a paid subscription.
  • subscription: The content requires users to be logged in with a paid subscription.
expectsAcceptanceOf.availabilityStarts Date Date after which the action is available, in ISO 8601 format (including timezone). Can be a date in the future. Use this property to limit action availability by date/time. If not included, we assume that action has no time limitation.
expectsAcceptanceOf.availabilityEnds Date Date after which the action is no longer available, in ISO 8601 format (including timezone). Use this property to limit action availability by date/time. If not included, we assume that action has no time limitation.
expectsAcceptanceOf.eligibleRegion Country Required - Countries where the action is available.
expectsAcceptanceOf.eligibleRegion.@type Text Required - Always set to Country.
expectsAcceptanceOf.eligibleRegion.name Text Required - The countries where the offer is allowed. Specify countries in ISO 3166 format.

Check out the following pages for the topics related to these properties:

Image markup properties

Property Expected type Description
image.@type ImageObject Required - Always set to ImageObject.
contentUrl URL Required - The URL to the image.
dateModified Date The date on which the image was most recently modified/changed, in ISO 8601 format (including timezone)
regionsAllowed Place The countries where the media is allowed. Specify countries in ISO 3166 format.
  • If not specified, then it's assumed the image is allowed to displayed in all locales.
  • To submit different images per region, add multiple ImageObjects; each with its own set of countries and a corresponding image url.

Check out the following pages for the topics related to these properties: