kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
Merge pull request #291 from benjaminbellamy/patch-13
Minor <podcast:recommendations> correctionspull/294/head
Dave Jones
GitHub
commit
69e5ed876b
|
|
@ -1,6 +1,6 @@
|
|||
# The "podcast:recommendations" Specification
|
||||
|
||||
<small>Version 1.2 by Benjamin Bellamy - 2021.08.31</small>
|
||||
<small>Version 1.0 by Benjamin Bellamy - 2021.08.31</small>
|
||||
|
||||
<br>
|
||||
|
||||
|
|
@ -11,11 +11,11 @@ That comes with a huge drawback: finding and being found can be harsh.
|
|||
Podcast creators struggle to be found while podcast listeners struggle to find content.
|
||||
Several platforms are now implementing recommendation engines, but these features are expensive and unattainable for small players. Moreover they are slowly creating closed silos and removing power from content creators.
|
||||
This specification is about giving control to content creators on the content they want to recommend, and at the same time providing a free recommendation system to all players.
|
||||
- Version 1.1 adds:
|
||||
- Adding:
|
||||
- `GUID` support for channel element,
|
||||
- a `motive` tag that explains why a specific recommendation was included,
|
||||
- a `medium` tag so that this can work with any feed, including non-podcast medium. (See \<podcast:medium> for more information.)
|
||||
- Version 1.2 brings minor corrections.
|
||||
|
||||
All this was heavily inspired by all the work previously done by the Fellowship of the PodcastIndex on the chapters and soundbite tags. May they be thanked for it.
|
||||
GO PODCASTING!!!
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ Example:
|
|||
|
||||
```json
|
||||
{
|
||||
"version": "1.2",
|
||||
"version": "1.0",
|
||||
"title": "Podnews podcasting news",
|
||||
"feed": "https://podnews.net/rss",
|
||||
"guid": "9b024349-ccf0-5f69-a609-6b82873eab3c"
|
||||
|
|
@ -73,7 +73,7 @@ The "recommendation" object takes this basic form:
|
|||
|
||||
```json
|
||||
{
|
||||
"link-type": "generic",
|
||||
"linkType": "generic",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting"
|
||||
|
|
@ -82,12 +82,12 @@ The "recommendation" object takes this basic form:
|
|||
|
||||
There are 4 required attributes:
|
||||
|
||||
- `link-type` (required - string) The link type of this recommended content, it can be:
|
||||
- `linkType` (required - string) The link type of this recommended content, it can be:
|
||||
- 'generic',
|
||||
- 'feed',
|
||||
- 'feed-item',
|
||||
- 'none'
|
||||
- `medium` (required - string) The medium kind. It can be:
|
||||
- `medium` (required - string) The medium type. It can be:
|
||||
- `podcast`,
|
||||
- `audiobook`,
|
||||
- `music`,
|
||||
|
|
@ -109,14 +109,14 @@ There are 4 required attributes:
|
|||
- `startTime` (optional - float) The start time (in seconds) of this recommended content. Applies to *"feed-item"* type only.
|
||||
- `duration` (optional - float) The duration (in seconds) of this recommended content. Applies to *"feed-item"* type only.
|
||||
- `motive` (optional - string) The reason why this content is recommended. It can be:
|
||||
- `references`,
|
||||
- `additional content`,
|
||||
- `acknowledgment`,
|
||||
- `advertising`,
|
||||
- `audience exchange`,
|
||||
- `similar content`,
|
||||
- `also liked by the audience`,
|
||||
- `made by the same people`
|
||||
- `references` (content that was used when creating this podcast, similar to the Wikipedia References paragraph),
|
||||
- `additional content` (content that provides extra information),
|
||||
- `acknowledgment` (thanking people),
|
||||
- `advertising` (sponsored content),
|
||||
- `audience exchange` (exchanging audiences between podcasts),
|
||||
- `content-based recommendation` (content related thanks to semantic indexation),
|
||||
- `audience-based recommendation` (people who liked this also liked…),
|
||||
- `made by the same people` (the creators of this podcast also made that…)
|
||||
- `relevance` (optional - float) The relevance of this recommended content regarding this Channel or Item. Number must be in [0…1]. 0 is for irrelevant content, 1 is for contents that match perfectly.
|
||||
|
||||
## Basic example
|
||||
|
|
@ -125,17 +125,17 @@ Here is what a very basic recommendations file may look like:
|
|||
|
||||
```json
|
||||
{
|
||||
"version": "1.2",
|
||||
"version": "1.0",
|
||||
"recommendations":
|
||||
[
|
||||
{
|
||||
"link-type": "none",
|
||||
"linkType": "none",
|
||||
"medium": "text",
|
||||
"title": "Eat five vegetables every day.",
|
||||
"motive": "advertising"
|
||||
},
|
||||
{
|
||||
"link-type": "generic",
|
||||
"linkType": "generic",
|
||||
"medium": "html",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
|
|
@ -143,7 +143,7 @@ Here is what a very basic recommendations file may look like:
|
|||
"motive": "additional content"
|
||||
},
|
||||
{
|
||||
"link-type": "feed",
|
||||
"linkType": "feed",
|
||||
"medium": "podcast",
|
||||
"title": "Podcasting 2.0",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
|
|
@ -152,7 +152,7 @@ Here is what a very basic recommendations file may look like:
|
|||
"motive": "audience exchange"
|
||||
},
|
||||
{
|
||||
"link-type": "item",
|
||||
"linkType": "item",
|
||||
"medium": "podcast",
|
||||
"title": "Episode 26: Manning Battlestations",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
|
|
@ -161,7 +161,7 @@ Here is what a very basic recommendations file may look like:
|
|||
"guid": "PC2026"
|
||||
},
|
||||
{
|
||||
"link-type": "item",
|
||||
"linkType": "item",
|
||||
"medium": "podcast",
|
||||
"title": "GO PODCASTING!!!",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
|
|
@ -179,14 +179,14 @@ Here is what a very basic recommendations file may look like:
|
|||
|
||||
```json
|
||||
{
|
||||
"version": "1.2",
|
||||
"version": "1.0",
|
||||
"title": "Podnews podcasting news",
|
||||
"feed": "https://podnews.net/rss",
|
||||
"guid": "9b024349-ccf0-5f69-a609-6b82873eab3c",
|
||||
"recommendations":
|
||||
[
|
||||
{
|
||||
"link-type": "none",
|
||||
"linkType": "none",
|
||||
"medium": "text",
|
||||
"title": "Eat five vegetables every day.",
|
||||
"motive": "advertising"
|
||||
|
|
@ -194,18 +194,18 @@ Here is what a very basic recommendations file may look like:
|
|||
{
|
||||
"displayStartTime": 0.0,
|
||||
"displayDuration": 120.0,
|
||||
"link-type": "generic",
|
||||
"linkType": "generic",
|
||||
"medium": "html",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting",
|
||||
"motive": "do you want to know more",
|
||||
"motive": "additional content",
|
||||
"relevance": 0.8
|
||||
},
|
||||
{
|
||||
"displayStartTime": 120.50,
|
||||
"displayDuration": 60.0,
|
||||
"link-type": "feed",
|
||||
"linkType": "feed",
|
||||
"medium": "podcast",
|
||||
"title": "Podcasting 2.0",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
|
|
@ -217,7 +217,7 @@ Here is what a very basic recommendations file may look like:
|
|||
{
|
||||
"displayStartTime": 240.60,
|
||||
"displayDuration": 180.0,
|
||||
"link-type": "feed-item",
|
||||
"linkType": "feed-item",
|
||||
"medium": "podcast",
|
||||
"title": "Episode 26: Manning Battlestations",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
|
|
@ -229,7 +229,7 @@ Here is what a very basic recommendations file may look like:
|
|||
{
|
||||
"displayStartTime": 3600.10,
|
||||
"displayDuration": 60.0,
|
||||
"link-type": "item",
|
||||
"linkType": "item",
|
||||
"medium": "podcast",
|
||||
"title": "GO PODCASTING!!!",
|
||||
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",
|
||||
|
|
@ -238,7 +238,7 @@ Here is what a very basic recommendations file may look like:
|
|||
"guid": "PC2026",
|
||||
"startTime": 4737.0,
|
||||
"duration": 5.0,
|
||||
"motive": "do you want to know more",
|
||||
"motive": "additional content",
|
||||
"relevance": 0.9
|
||||
}
|
||||
]
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue