Listen Actions feed examples

AI-generated Key Takeaways

• Listen Actions demonstrate how to represent different availability scenarios for music content.

• Content can have varying accessibility based on factors like subscription status, platform, and region.

• Examples illustrate how to define Listen Actions for exclusive subscriber content and publicly available playlists.

• The code shows how to specify accessibility based on platforms and eligible regions within the ListenAction schema.

• It's important to differentiate between the language used for schema values (@language) and the language in which the content is available (contentLanguage).

The following examples demonstrate some of the common scenarios for Listen Actions. To simplify, these examples omit the details of some properties.

Base case

A streaming service provides an artist's exclusive content, which is only available to subscribers (subscribe), and an artist-based playlist, which is available to everyone (free):

{
  "@context":["http://schema.googleapis.com/", {"@language": "en"}],
  "@type":"MusicGroup",
  "@id":"http://www.example.com/artist/my_favorite_artist/",
  "url":"http://www.example.com/artist/my_favorite_artist/",
  "sameAs": "http://www.my_favorite_artist.com",
  "name":"My Favorite Artist",
  "description":"This is my favorite artist.",
  "potentialAction": {
    "@type":"ListenAction",
    "target": {
      "@type":"EntryPoint",
      "urlTemplate":"http://www.example.com/artist/my_favorite_artist?autoplay=true",
      "actionPlatform":[
        "http://schema.org/DesktopWebPlatform",
        "http://schema.org/IOSPlatform",
        "http://schema.org/AndroidPlatform",
        "http://schema.org/AndroidTVPlatform",
        "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/my_favorite_artist/",
    "url":"http://www.example.com/artist_mix/my_favorite_artist/",
    "name":"My Favorite Artist Mix",
    "description":"A playlist of songs similar to My Favorite Artist.",
    "potentialAction":{
      "@type":"ListenAction",
      "target": {
        "@type":"EntryPoint",
        "urlTemplate":"http://www.example.com/artist_mix/my_favorite_artist?autoplay=true",
        "actionPlatform":[
          "http://schema.org/DesktopWebPlatform",
          "http://schema.org/IOSPlatform",
          "http://schema.org/AndroidPlatform",
          "http://schema.org/AndroidTVPlatform",
          "http://schema.googleapis.com/GoogleAudioCast",
          "http://schema.googleapis.com/GoogleVideoCast"
        ]
      },
      "expectsAcceptanceOf":{
        "@type":"Offer",
        "category":"free",
        "eligibleRegion": {
          "@type":"Country",
          "name":"US"
        }
      }
    }
  }
}

Playlist only

A streaming service provides only a playlist:

{
  "@context":["http://schema.googleapis.com/", {"@language": "en"}],
  "@type":"MusicGroup",
  "@id":"http://www.example.com/artist/my_favorite_artist/",
  "url":"http://www.example.com/artist/my_favorite_artist/",
  "sameAs": "http://www.my_favorite_artist.com",
  "name":"My Favorite Artist",
  "description":"This is my favorite artist.",
  "subjectOf": {
    "@type":"MusicPlaylist",
    "@id":"http://www.example.com/artist_mix/my_favorite_artist/",
    "url":"http://www.example.com/artist_mix/my_favorite_artist/",
    "name":"My Favorite Artist Mix",
    "description":"A playlist of songs similar to My Favorite Artist.",
    "potentialAction":{
      "@type":"ListenAction",
      "target": {
        "@type":"EntryPoint",
        "urlTemplate":"http://www.example.com/artist_mix/my_favorite_artist?autoplay=true",
        "actionPlatform":[
          "http://schema.org/DesktopWebPlatform",
          "http://schema.org/IOSPlatform",
          "http://schema.org/AndroidPlatform",
          "http://schema.org/AndroidTVPlatform",
          "http://schema.googleapis.com/GoogleAudioCast",
          "http://schema.googleapis.com/GoogleVideoCast"
        ]
      },
      "expectsAcceptanceOf":{
        "@type":"Offer",
        "category":"free",
        "eligibleRegion": {
          "@type":"Country",
          "name":"US"
        }
      }
    }
  }
}

Multiple platform-based accessibility requirements

The base case but now the artist's content is available for everyone on the desktop platform:

{
  "@context":["http://schema.googleapis.com/", {"@language": "en"}],
  "@type":"MusicGroup",
  "@id":"http://www.example.com/artist/my_favorite_artist/",
  "url":"http://www.example.com/artist/my_favorite_artist/",
  "sameAs": "http://www.my_favorite_artist.com",
  "name":"My Favorite Artist",
  "description":"This is my favorite artist.",
  "potentialAction": [
    {
      "@type":"ListenAction",
      "target": {
        "@type":"EntryPoint",
        "urlTemplate":"http://www.example.com/artist/my_favorite_artist?autoplay=true",
        "actionPlatform":[
          "http://schema.org/IOSPlatform",
          "http://schema.org/AndroidPlatform",
          "http://schema.org/AndroidTVPlatform",
          "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/my_favorite_artist?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/my_favorite_artist/",
    "url":"http://www.example.com/artist_mix/my_favorite_artist/",
    "name":"My Favorite Artist Mix",
    "description":"A playlist of songs similar to My Favorite Artist.",
    "potentialAction":{
      "@type":"ListenAction",
      "target": {
        "@type":"EntryPoint",
        "urlTemplate":"http://www.example.com/artist_mix/my_favorite_artist?autoplay=true",
        "actionPlatform":[
          "http://schema.org/DesktopWebPlatform",
          "http://schema.org/IOSPlatform",
          "http://schema.org/AndroidPlatform",
          "http://schema.org/AndroidTVPlatform",
          "http://schema.googleapis.com/GoogleAudioCast",
          "http://schema.googleapis.com/GoogleVideoCast"
        ]
      },
      "expectsAcceptanceOf":{
        "@type":"Offer",
        "category":"free",
        "eligibleRegion": {
          "@type":"Country",
          "name":"US"
        }
      }
    }
  }
}

Multiple regional accessibility requirements

The base case but now the artist's content is available for everyone on all platforms in Canada:

{
  "@context":["http://schema.googleapis.com/", {"@language": "en"}],
  "@type":"MusicGroup",
  "@id":"http://www.example.com/artist/my_favorite_artist/",
  "url":"http://www.example.com/artist/my_favorite_artist/",
  "sameAs": "http://www.my_favorite_artist.com",
  "name":"My Favorite Artist",
  "description":"This is my favorite artist.",
  "potentialAction": [
    {
      "@type":"ListenAction",
      "target": {
        "@type":"EntryPoint",
        "urlTemplate":"http://www.example.com/artist/my_favorite_artist?autoplay=true",
        "actionPlatform":[
          "http://schema.org/DesktopWebPlatform",
          "http://schema.org/IOSPlatform",
          "http://schema.org/AndroidPlatform",
          "http://schema.org/AndroidTVPlatform",
          "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/my_favorite_artist?autoplay=true",
        "actionPlatform":[
          "http://schema.org/DesktopWebPlatform",
          "http://schema.org/IOSPlatform",
          "http://schema.org/AndroidPlatform",
          "http://schema.org/AndroidTVPlatform",
          "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/my_favorite_artist/",
    "url":"http://www.example.com/artist_mix/my_favorite_artist/",
    "name":"My Favorite Artist Mix",
    "description":"A playlist of songs similar to My Favorite Artist.",
    "potentialAction":{
      "@type":"ListenAction",
      "target": {
        "@type":"EntryPoint",
        "urlTemplate":"http://www.example.com/artist_mix/my_favorite_artist?autoplay=true",
        "actionPlatform":[
          "http://schema.org/DesktopWebPlatform",
          "http://schema.org/IOSPlatform",
          "http://schema.org/AndroidPlatform",
          "http://schema.org/AndroidTVPlatform",
          "http://schema.googleapis.com/GoogleAudioCast",
          "http://schema.googleapis.com/GoogleVideoCast"
        ]
      },
      "expectsAcceptanceOf":{
        "@type":"Offer",
        "category":"free",
        "eligibleRegion": [
          {
            "@type":"Country",
            "name":"US"
          },
          {
            "@type":"Country",
            "name":"CA"
          }
        ]
      }
    }
  }
}

Multiple regions and languages

An entity is available in multiple regions and languages:

Note: @language denotes the langauge used for @value; it does not mean availability of the content in that language or in that region. For example, pt-br in @language does not mean that the content is available in Portuguese in Brazil; it identifies the language used in @value is in Brazilian Portuguese. Use eligibleRegion to specify where the content is available and use contentLanguage to specify the language that users can consume the content in.

{
  "@context": ["http://schema.googleapis.com/", {"@language": "en"}],
  "@type": "MusicRecording",
  "@id": "https://example.com/us/recording/24335345",
  "url": "https://example.com/us/recording/24335345",
  "name": [
    {
      "@language": "fr-fr",
      "@value": "Amour"
    },
    {
      "@language": "en-us",
      "@value": "Love"
    }
  ],
  "byArtist": [
    {
      "@type": "MusicGroup",
      "@id": "https://example.com/us/artist/43265436",
      "name": [
        {
          "@language": "fr-fr",
          "@value": "Mon Artiste Préféré"
        },
        {
          "@language": "en-us",
          "@value": "My Favorite Artist"
        }
      ]
    }
  ],
  "inAlbum": [
    {
      "@type": "MusicAlbum",
      "@id": "https://example.com/us/album/24335345",
      "name": [
        {
          "@language": "fr-fr",
          "@value": "Mon Album Préféré"
        },
        {
          "@language": "en-us",
          "@value": "My Favorite Album"
        }
      ]
    }
  ],
  "potentialAction": [
    {
      "@type": "ListenAction",
      "target": [
        {
          "@type": "EntryPoint",
          "inLanguage": "en-us",
          "urlTemplate": "https://example.com/us/album/24335345",
          "actionPlatform": [
            "http://schema.org/DesktopWebPlatform",
            "http://schema.googleapis.com/GoogleVideoCast",
            "http://schema.googleapis.com/GoogleAudioCast"
          ]
        },
        {
          "@type": "EntryPoint",
          "inLanguage": "en-us",
          "urlTemplate": "https://example.com/us/album/ios/24335345",
          "actionPlatform": [
            "http://schema.org/IOSPlatform"
          ]
        },
        {
          "@type": "EntryPoint",
          "inLanguage": "en-us",
          "urlTemplate": "android-app://com.example.android.music/https/example.com/us/24335345",
          "actionPlatform": [
            "http://schema.org/AndroidPlatform",
            "http://schema.org/AndroidTVPlatform"
          ]
        }
      ],
      "expectsAcceptanceOf": [
        {
          "@type": "Offer",
          "eligibleRegion": [
            {
              "@type": "Country",
              "name": "US"
            }
          ],
          "category": "subscription",
          "name": "Example Music",
          "price": 9.99,
          "priceCurrency": "USD",
          "seller": {
            "@type": "Organization",
            "name": "Example seller",
            "sameAs": "http://www.example.com"
          }
        }
      ]
    },
    {
      "@type": "ListenAction",
      "target": [
        {
          "@type": "EntryPoint",
          "inLanguage": "fr-fr",
          "urlTemplate": "https://example.com/fr/album/24335345",
          "actionPlatform": [
            "http://schema.org/DesktopWebPlatform",
            "http://schema.googleapis.com/GoogleVideoCast",
            "http://schema.googleapis.com/GoogleAudioCast"
          ]
        },
        {
          "@type": "EntryPoint",
          "inLanguage": "fr-fr",
          "urlTemplate": "https://example.com/fr/album/ios/24335345",
          "actionPlatform": [
            "http://schema.org/IOSPlatform"
          ]
        },
        {
          "@type": "EntryPoint",
          "inLanguage": "fr-fr",
          "urlTemplate": "android-app://com.example.android.music/https/example.com/fr/24335345",
          "actionPlatform": [
            "http://schema.org/AndroidPlatform",
            "http://schema.org/AndroidTVPlatform"
          ]
        }
      ],
      "expectsAcceptanceOf": [
        {
          "@type": "Offer",
          "eligibleRegion": [
            {
              "@type": "Country",
              "name": "FR"
            }
          ],
          "category": "subscription",
          "name": "Example Music",
          "price": 5.99,
          "priceCurrency": "EUR",
          "seller": {
            "@type": "Organization",
            "name": "Example Seller",
            "sameAs": "http://www.example.com"
          }
        }
      ]
    }
  ]
}