Listen Actions - Examples

The following is a list of examples of some common scenarios for Listen Actions to guide you in your feed development. Many of the examples have omitted details of some of the properties to keep them concise

Example 1 - Simple example

Artist with the same universal link across all platforms with the same access requirements. Streaming service can serve both artist exclusive content and an artist based mix with the exclusive content available only to subscribers.

    {
      "@context":"http://schema.googleapis.com/",
      "@type":"MusicGroup",
      "@id":"http://www.example.com/artist/Katy-Perry/",
      "url":"http://www.example.com/artist/Katy-Perry/",
      "name":"Katy Perry",
      "sameAs":"http://www.katyperry.com",
      "description":"Katy Perry is a pop music artist.",
      "potentialAction": {
        "@type":"ListenAction",
        "target": {
          "@type":"EntryPoint",
          "urlTemplate":"http://www.example.com/artist/Katy-Perry?autoplay=true",
          "actionPlatform":[
            "http://schema.org/DesktopWebPlatform",
            "http://schema.org/IOSPlatform",
            "http://schema.org/AndroidPlatform",
            "http://schema.googleapis.com/GoogleAudioCast",
            "http://schema.googleapis.com/GoogleVideoCast"
          ]
        },
        "expectsAcceptanceOf":{
          "@type":"Offer",
          "category":"subscription",
          "eligibleRegion": {
            "@type":"Country",
            "name":"US"
          }
        }
      },
      "subjectOf": {
        "@type":"MusicPlaylist",
        "@id":"http://www.example.com/artist_mix/Katy-Perry/",
        "url":"http://www.example.com/artist_mix/Katy-Perry/",
        "name":"Katy Perry Mix",
        "description":"A mix of music similar to Katy Perry",
        "potentialAction":{
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist_mix/Katy-Perry?autoplay=true",
            "actionPlatform":[
              "http://schema.org/DesktopWebPlatform",
              "http://schema.org/IOSPlatform",
              "http://schema.org/AndroidPlatform",
              "http://schema.googleapis.com/GoogleAudioCast",
              "http://schema.googleapis.com/GoogleVideoCast"
            ]
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"free",
            "eligibleRegion": {
              "@type":"Country",
              "name":"US"
            }
          }
        }
      }
    }

Example 2 - Service does not have exclusive content

Artist with the same universal link across all platforms with the same access requirements. Streaming service can only serve artist based mix.

    {
      "@context":"http://schema.googleapis.com/",
      "@type":"MusicGroup",
      "@id":"http://www.example.com/artist/Katy-Perry/",
      "url":"http://www.example.com/artist/Katy-Perry/",
      "name":"Katy Perry",
      "sameAs":"http://www.katyperry.com",
      "description":"Katy Perry is a pop music artist.",
      "subjectOf": {
        "@type":"MusicPlaylist",
        "@id":"http://www.example.com/artist_mix/Katy-Perry/",
        "url":"http://www.example.com/artist_mix/Katy-Perry/",
        "name":"Katy Perry Mix",
        "description":"A mix of music similar to Katy Perry",
        "potentialAction":{
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist_mix/Katy-Perry?autoplay=true",
            "actionPlatform":[
              "http://schema.org/DesktopWebPlatform",
              "http://schema.org/IOSPlatform",
              "http://schema.org/AndroidPlatform",
              "http://schema.googleapis.com/GoogleAudioCast",
              "http://schema.googleapis.com/GoogleVideoCast"
            ]
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"free",
            "eligibleRegion": {
              "@type":"Country",
              "name":"US"
            }
          }
        }
      }
    }

Example 3 - Service has different use cases on different platforms

Artist exclusive content is available for free on desktop, but requires subscription on other platforms. Free users on non-desktop platforms can access artist based mix.

    {
      "@context":"http://schema.googleapis.com/",
      "@type":"MusicGroup",
      "@id":"http://www.example.com/artist/Katy-Perry/",
      "url":"http://www.example.com/artist/Katy-Perry/",
      "name":"Katy Perry",
      "sameAs":"http://www.katyperry.com",
      "description":"Katy Perry is a pop music artist.",
      "potentialAction": [
        {
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist/Katy-Perry?autoplay=true",
            "actionPlatform":[
              "http://schema.org/IOSPlatform",
              "http://schema.org/AndroidPlatform",
              "http://schema.googleapis.com/GoogleAudioCast",
              "http://schema.googleapis.com/GoogleVideoCast"
            ]
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"subscription",
            "eligibleRegion": {
              "@type":"Country",
              "name":"US"
            }
          }
        },
        {
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist/Katy-Perry?autoplay=true",
            "actionPlatform": "http://schema.org/DesktopWebPlatform"
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"free",
            "eligibleRegion": {
              "@type":"Country",
              "name":"US"
            }
          }
        }
      ],
      "subjectOf": {
        "@type":"MusicPlaylist",
        "@id":"http://www.example.com/artist_mix/Katy-Perry/",
        "url":"http://www.example.com/artist_mix/Katy-Perry/",
        "name":"Katy Perry Mix",
        "description":"A mix of music similar to Katy Perry",
        "potentialAction":{
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist_mix/Katy-Perry?autoplay=true",
            "actionPlatform":[
              "http://schema.org/DesktopWebPlatform",
              "http://schema.org/IOSPlatform",
              "http://schema.org/AndroidPlatform",
              "http://schema.googleapis.com/GoogleAudioCast",
              "http://schema.googleapis.com/GoogleVideoCast"
            ]
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"free",
            "eligibleRegion": {
              "@type":"Country",
              "name":"US"
            }
          }
        }
      }
    }

Example 4 - Service has different use cases depending on user location

Artist exclusive content is available for free on all platforms in Canada, but requires subscription in the US. The artist based mix is available to all users in both the US and Canada.

    {
      "@context":"http://schema.googleapis.com/",
      "@type":"MusicGroup",
      "@id":"http://www.example.com/artist/Katy-Perry/",
      "url":"http://www.example.com/artist/Katy-Perry/",
      "name":"Katy Perry",
      "sameAs":"http://www.katyperry.com",
      "description":"Katy Perry is a pop music artist.",
      "potentialAction": [
        {
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist/Katy-Perry?autoplay=true",
            "actionPlatform":[
              "http://schema.org/DesktopWebPlatform",
              "http://schema.org/IOSPlatform",
              "http://schema.org/AndroidPlatform",
              "http://schema.googleapis.com/GoogleAudioCast",
              "http://schema.googleapis.com/GoogleVideoCast"
            ]
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"free",
            "eligibleRegion": {
              "@type":"Country",
              "name":"CA"
            }
          }
        },
        {
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist/Katy-Perry?autoplay=true",
            "actionPlatform":[
              "http://schema.org/DesktopWebPlatform",
              "http://schema.org/IOSPlatform",
              "http://schema.org/AndroidPlatform",
              "http://schema.googleapis.com/GoogleAudioCast",
              "http://schema.googleapis.com/GoogleVideoCast"
            ]
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"subscription",
            "eligibleRegion": {
              "@type":"Country",
              "name":"US"
            }
          }
        }
      ],
      "subjectOf": {
        "@type":"MusicPlaylist",
        "@id":"http://www.example.com/artist_mix/Katy-Perry/",
        "url":"http://www.example.com/artist_mix/Katy-Perry/",
        "name":"Katy Perry Mix",
        "description":"A mix of music similar to Katy Perry",
        "potentialAction":{
          "@type":"ListenAction",
          "target": {
            "@type":"EntryPoint",
            "urlTemplate":"http://www.example.com/artist_mix/Katy-Perry?autoplay=true",
            "actionPlatform":[
              "http://schema.org/DesktopWebPlatform",
              "http://schema.org/IOSPlatform",
              "http://schema.org/AndroidPlatform",
              "http://schema.googleapis.com/GoogleAudioCast",
              "http://schema.googleapis.com/GoogleVideoCast"
            ]
          },
          "expectsAcceptanceOf":{
            "@type":"Offer",
            "category":"free",
            "eligibleRegion": [
              {
                "@type":"Country",
                "name":"US"
              },
              {
                "@type":"Country",
                "name":"CA"
              }
            ]
          }
        }
      }
    }