Profile: has-premium-audio

Profile Schema

The has-premium-audio profile designates a document that has premium audio assets.

Premium Audio

The premiumAudio array contains a set of links to audio assets intended for a “premium” experience. The premiumAudio array must meet the following constraints:

  • If present, premiumAudio must contain one or more links
  • The links in premiumAudio must start with #/
  • The links in premiumAudio must have at least one valid item in the rels array

The rel value of the link indicates the intended audience of the premiumAudio. Valid rels for premiumAudio links are listed below; invalid rels will be rejected.

  • npr-plus - the audio is intended for the NPR Plus audience; presently this includes listeners who subscribe via Supporting Cast (i.e., plus.npr.org)
  • amazon-music - the audio is intended for the Amazon Music audience (i.e., users subscribed to premium content by way of Amazon Prime)

Example has-premium-audio document

{
  "id": "12345",
  "profiles": [
    {
      "href": "/v1/profiles/has-premium-audio"
    },
    {
      "href": "/v1/profiles/document"
    }
  ],

  "assets": {
    "5678": {
      "id": "5678",
      "profiles": [
        {
          "href": "/v1/profiles/audio"
        }
      ],

      "title": "Hero or Menace? We sit down with J. Jonah Jameson and find out.",
      "enclosures": [
        {
          "href": "https://npr-audio-host.org/spiderman-podcast/episode-1.mp3",
          "rels": [
            "tracked",
            "premium"
          ],
          "type": "audio/mpeg"
        }
      ]
    }
  },

  "copyright": "Copyright 2021 NPR",
  "episodeGuid": "00000000-0000-0000-0000-000000000000",
  "episodePermalink": {
    "href": "/2021/01/012345/episode-1"
  },
  "episodeNumber": 1,
  "seasonNumber": 1,
  "explicit": false,
  "episodeType": "full",
  "itunes": {
    "block": false
  },
  "feedEpisodeTitle": "Hero or Menace?",
  "premiumAudio": [
    {
      "href": "#/assets/5678",
      "rels": ["npr-plus"]
    }
  ]
}

© 2024 npr