RSS Spec

For text-based articles, MAZ can process most standard RSS feeds as-is. In order to include advertisements, image galleries and/or video content, there are certain modifications that must be made to a standard RSS feed.

___

A complete sample feed is also included at the bottom of this document.
___

Item Type: Article

The article item uses a standard format familiar to most article-based RSS feeds. MAZ will extract the body of the article, including images and formatting, directly from the <link> URL.

Sample: Article Item

<item>
   <title>Meet Lynx, An App For Sharing Links With Friends</title>
   <link>http://techcrunch.com/2015/07/07/meet-lynx-an-app-for-sharing-links-with-friends/</link>
   <guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efb6a</guid>
   <media:content url="https://tctechcrunch2011.files.wordpress.com/2015/07/lynx2.png" />
   <pubDate>Mon, 30 Nov 2015 09:29:47 -0800</pubDate>
   <description>Some text.</description>
   <author>john@example.com (John)</author>
</item>

___

Optional tags per item:

Item captions

For image captions, please add <figure> and <figcaption> tags inside CDATA.

<content:encoded>

<![CDATA[

<figure><img src="https://http://example.com/image-caption.jpg" /> <figcaption> This caption does a really great job at concisely explaining this awesome image!</figcaption></figure>

Modified timestamp

“<maz:modified>1514038421</maz:modified>”

This represents the timestamp of the last modification to the item. This should be in epoch time format represented in seconds and stored as integer. MAZ heavily relies on this value and will compare this value from its previous value and will reprocess the article if the newer timestamp is greater than the previous one, otherwise will ignore reprocessing. If this field is missing from the feed, the article will be processed only the first time.

Templates

If the template name is not available, it will default to what is selected in the MAZ dashboard. 

Multiple Templates

“<maz:template>[custom template name]</maz:template>”

<maz:template>feature</maz:template>

<maz:template>news</maz:template>

<maz:template>web</maz:template>

If template == “web”, MAZ will not create article templates for those articles, they will open the source website instead of templates. If not passed, the default MAZ template will be applied.

Item Type: Gallery

The gallery item uses a format similar to the article item, but it has some specific tags that apply only to galleries. Galleries can consist of both photos and videos. The gallery specific tags are:

<maz:type>

Specifies what type of item it is.

<maz:galleryCover>

The image asset to be displayed as the thumbnail for the gallery.

<maz:galleryItem>

Specifies a single gallery item. If it is an image, no type is required. If the item is a video then you must specify the type parameter as ‘video’ (e.g. type=”video”). The gallery items will be displayed in the order by which they appear in the feed.

<maz:galleryAsset>

The source image/video to be displayed in the gallery. This can be a URL in the event of an image/video file, or an HTML video embedded using the CDATA tag.

<maz:galleryCaption>

Text that will be displayed on the screen along with the current gallery image. This tag supports the inclusion of HTML content/formatting by using the CDATA tag.

<maz:textUpper>

Optional text that will be displayed on the screen above the gallery asset thumbnail. This tag supports the inclusion of HTML content/formatting by using the CDATA tag.

<maz:textLower>

Optional text that will be displayed on the screen below the gallery asset thumbnail. This tag supports the inclusion of HTML content/formatting by using the CDATA tag.

Sample: Gallery Item

<item>
   <title>This Startup Run By Ex-Apple Designers Is About To Change The Entire Publishing Industry</title>
   <link>http://www.domain.com/link-to-an-article/</link>
   <guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</guid>
   <media:content url="http://static4.domain.com/image/5009d3a3e/ex-apple-maz.jpg" />
   <pubDate>Mon, 23 Nov 2015 09:29:47 -0800</pubDate>
   <author>john@example.com (John)</author>
   <maz:type>gallery</maz:type>
   <maz:galleryCover url="http://example.com/gallery-cover1.jpg"/>

<maz:galleryItem>     <maz:galleryAsset>http://example.com/image1.jpg</maz:galleryAsset>
<maz:galleryCaption>Description of first image. It's optional and will display below this image.</maz:galleryCaption>
</maz:galleryItem>

<maz:galleryItem>     <maz:galleryAsset>http://example.com/image2.jpg</maz:galleryAsset>
<maz:galleryCaption><![CDATA[This is the caption which can include <a href="http://link.com">links</a> and </br> line breaks and such.]]></maz:galleryCaption>
</maz:galleryItem>

<maz:galleryItem>
<maz:galleryAsset type=”video”><![CDATA[<iframe width="560" height="315" src="https://www.youtube.com/embed/_MfXYPBJ0bw" frameborder="0" allowfullscreen></iframe>]]>
</maz:galleryAsset>
<maz:galleryCaption></maz:galleryCaption>
</maz:galleryItem>

<maz:galleryItem>      <maz:galleryAsset>http://example.com/image4.jpg</maz:galleryAsset>
<maz:galleryCaption>Fourth image of gallery!</maz:galleryCaption>
</maz:galleryItem>

<maz:textUpper>This text shows above the gallery, and it's optional.</maz:textUpper>
<maz:textLower>This text shows below the gallery, and it's optional.</maz:textLower>

</item>

Item Type: Video

The video item is similar to the article item, but it has some specific tags that apply only to videos. These tags are:

<maz:type>

Specifies what type of item it is.

<maz:video>

The source URL (Sample #1) of the video to be displayed. There can be only one video per <item>.

Direct video URLs (or Streaming URLs) which are natively supported on iOS devices are preferable.

<maz:videoImage>

The image asset to be displayed as the thumbnail for the video.

<maz:videoEmbedCode>

The HTML embed code (Sample #2) of the video to be displayed. There can be only one video per <item>. Please note that when using an embed code it must be nested within a CDATA tag. For mobile device displays, max width should be 350px.

<maz:textUpper>

Optional text that will be displayed on the screen above the video thumbnail. This tag supports the inclusion of HTML content/formatting by using the CDATA tag.

<maz:textLower>

Optional text that will be displayed on the screen below the video thumbnail. This tag supports the inclusion of HTML content/formatting by using the CDATA tag.

Sample #1: Video Item (URL)

<item>
    <title>MAZ introduces Wear, its Apple Watch solution for publishers</title>
    <link>http://www.talkingnewmedia.com/2015/12/03/maz-introduces-wear/</link>
    <guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344edf5b</guid>
    <media:content url="http://www.domain.com/uploads/2015/12/Maz-Wear-580.jpg" />
    <pubDate>Fri, 20 Nov 2015 14:28:16 -0800</pubDate>
    <maz:type>video</maz:type>
    <maz:video url="https://s3.amazonaws.com/help.dev.mazdigital.com/yk/Media/1.mp4"/>
    <maz:videoImage url="https://s3.amazonaws.com/help.dev.mazdigital.com/yk/Media/1.jpg"/>
<maz:textUpper>This text shows above the video, and it's optional.</maz:textUpper>
    <maz:textLower>This text shows below the video, and it's optional.</maz:textLower>
</item>

Sample #2: Video Item (Embed Code)

<item>
    <title>MAZ introduces Wear, its Apple Watch solution for publishers</title>
    <link>http://www.talkingnewmedia.com/2015/12/03/maz-introduces-wear/</link>
    <guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344edf5b</guid>
    <media:content url="http://www.domain.com/uploads/2015/12/Maz-Wear-580.jpg" />
    <pubDate>Fri, 20 Nov 2015 14:28:16 -0800</pubDate>
    <maz:type>video</maz:type>
    <maz:videoEmbedCode><![CDATA[<iframe width="560" height="315" src="https://www.youtube.com/embed/_MfXYPBJ0bw" frameborder="0" allowfullscreen></iframe>]]></maz:videoEmbedCode>
    <maz:textUpper>This text shows above the video, and it's optional.</maz:textUpper>
    <maz:textLower> This text shows below the video, and it's optional.</maz:textLower>
</item>

The advertisement item is displayed only when a user is swiping between articles in the article view of the app. Advertisements consist of a URL to an image asset, and can include an optional URL for the user to be directed to when they tap on an advertisement. The advertisement specific tags are:

<maz:type>

Specifies what type of item it is.

<guid>

A unique identifier for the ad

Sample: Advertisement Item

<item>

<title>Porsche Advertisement</title>

<media:content url="http://www.domain.com/advertisments/2016/1/Advertisement.jpg" />

<link>http://www.porsche.com/</link>

<pubDate>Fri, 1 Jan 2016 11:21:13 -0800</pubDate>

<maz:type>advertisement</maz:type>

<guid isPermaLink="false">578748e064aaf92fb3eb8717</guid>

</item>

Recommended advertisement image size: 2208 pixels wide by 1242 pixels high for optimal display on the highest resolution screens for devices currently on the market. In the event that your advertisement assets do not match those dimensions exactly, making them 2208 pixels wide should be the priority (over the height). For any assets that do not fill the screen exactly, we will ‘letterbox’ them with black borders when displaying in the app. The advertisements will appear in the app in the same order that they appear in the feed (between the articles)

Item Type: Heading

The heading specific tags are:

<maz:type>

Specifies what type of item it is.

<guid>

A unique identifier for the heading

<title>

The heading text that will be displayed in the app. We recommend that it should be less than or equal to 20 characters in length so that is shows up correctly across all devices.

Sample: Heading Item

<item>
   <title>Breaking News!</title>
   <maz:type>heading</maz:type>
   <guid isPermaLink="false">578748e064aaf92fb3eb8719</guid>
</item>

Item Type: Image

The image specific tags are:

<maz:type>

Specifies what type of item it is.

<guid>

A unique identifier for the image

Sample: Image Item

<item>

<title>Meet Lynx, An App For Sharing Links With Friends</title> <link>http://lynxthat.com/assets/lynx_og_image.png</link>

<guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efb6a</guid>

<description>Some text.</description>

<maz:type>image</maz:type>

</item>

___

Complete Sample Feed

<?xml version="1.0" encoding="utf-8"?>

<rss xmlns:media="http://search.yahoo.com/mrss/" xmlns:maz="http://www.mazdigital.com/media/" version="2.0"> <channel> <title>Example Phoenix Feed</title> <description>Insert witty or insightful remark here</description> <link>http://example.org/</link> <lastBuildDate>Fri, 04 Dec 2015 18:30:02 GMT</lastBuildDate> <managingEditor>johndoe@example.com (John Doe)</managingEditor>

<item>

<title>Breaking News!</title>

<maz:type>heading</maz:type>

<guid isPermaLink="false">578748e064aaf92fb3eb8719</guid>

</item>

<item>

<title>Meet Lynx, An App For Sharing Links With Friends</title> <link>http://techcrunch.com/2015/07/07/meet-lynx-an-app-for-sharing-links-with-friends/</link>

<guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efb6a</guid>

<media:content url="https://tctechcrunch2011.files.wordpress.com/2015/07/lynx2.png"/>

<pubDate>Mon, 30 Nov 2015 09:29:47 -0800</pubDate>

<description>Some text.</description>

<author>john@example.com (John)</author>

</item>

<item>

<title>Porsche Advertisement</title>

<media:content url="http://www.domain.com/advertisments/2016/1/Advertisement.jpg" />

<link>http://www.porsche.com/</link>

<pubDate>Fri, 1 Jan 2016 11:21:13 -0800</pubDate>

<maz:type>advertisement</maz:type>

</item>

<item>

<title>This Startup Run By Ex-Apple Designers Is About To Change The Entire Publishing Industry</title>

<link>http://www.businessinsider.com/this-startup-run-by-ex-apple-designers-is-about-to-change-the-entire-publishing-industry-2012-7</link>

<guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</guid>

<media:content url="http://static4.businessinsider.com/image/5009d3a3eab8eaf13e000011-400-/paul-canetti-ex-apple-maz.jpg"/>

<pubDate>Mon, 23 Nov 2015 09:29:47 -0800</pubDate>

<description>Some text.</description>

<author>john@example.com (John)</author>

<maz:type>gallery</maz:type>

<maz:galleryCover url="http://example.com/gallery-cover1.jpg"/>

<maz:galleryItem> <maz:galleryAsset>http://example.com/image1.jpg</maz:galleryAsset>

<maz:galleryCaption>Description of first image. It's optional and will display below this image.</maz:galleryCaption>

</maz:galleryItem>

<maz:galleryItem> <maz:galleryAsset>http://example.com/image2.jpg</maz:galleryAsset>

<maz:galleryCaption>Second image of gallery!</maz:galleryCaption>

</maz:galleryItem>

<maz:galleryItem> <maz:galleryAsset>http://example.com/image3.jpg</maz:galleryAsset>

<maz:galleryCaption></maz:galleryCaption>

</maz:galleryItem>

<maz:galleryItem> <maz:galleryAsset>http://example.com/image4.jpg</maz:galleryAsset>

<maz:galleryCaption><![CDATA[This is the caption which can include <a href="http://link.com">links</a> and </br> line breaks and such.]]></maz:galleryCaption>

</maz:galleryItem>

<maz:textUpper>This text shows above the gallery, and it's optional.</maz:textUpper>

<maz:textLower>This text shows below the gallery, and it's optional.</maz:textLower>

</item>

<item>

<title>Video Gallery Sample</title>

<link>http://www.example.com/video-gallery-sample</link>

<guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-acva-80da344efa6a</guid>

<media:content url="http://example.com/video_cover_image.jpg"/>

<pubDate>Mon, 23 Nov 2015 09:29:47 -0800</pubDate>

<description>Some text.</description>

<author>john@example.com (John)</author>

<maz:type>videoGallery</maz:type>

<maz:galleryCover url="http://example.com/gallery-cover2.jpg"/>

<maz:galleryItem>

<maz:galleryAsset type="video">http://example.com/video1.mp4</maz:galleryAsset>

<maz:galleryCaption>Description of first video. It's optional and will display below this video.</maz:galleryCaption>

</maz:galleryItem>

<maz:galleryItem>

<maz:galleryAsset type="video">http://example.com/video2.mp4</maz:galleryAsset>

<maz:galleryCaption>Second video of gallery!</maz:galleryCaption>

</maz:galleryItem>

<maz:galleryItem>

<maz:galleryAsset type="video"><![CDATA[<iframe width="560" height="315" src="https://www.youtube.com/embed/_MfXYPBJ0bw" frameborder="0" allowfullscreen></iframe>]]></maz:galleryAsset>

<maz:galleryCaption></maz:galleryCaption>

</maz:galleryItem>

<maz:galleryItem>

<maz:galleryAsset type="video">http://example.com/video4.mp4</maz:galleryAsset>

<maz:galleryCaption><![CDATA[This is the caption which can include <a href="http://link.com">links</a> and </br> line breaks and such.]]></maz:galleryCaption>

</maz:galleryItem>

<maz:textUpper>This text shows above the gallery, and it's optional.</maz:textUpper>

<maz:textLower>This text shows below the gallery, and it's optional.</maz:textLower>

</item>

<item>

<title>BMW Advertisement</title>

<media:content url="http://www.domain.com/advertisments/2016/1/BMW_ad.jpg" />

<link>http://www.bmw.com/</link>

<pubDate>Fri, 1 Jan 2016 11:21:13 -0800</pubDate>

<maz:type>advertisement</maz:type>

<guid isPermaLink="false">578748e064aaf92fb3eb8717</guid>

</item>

<item>

<title>MAZ introduces Wear, its Apple Watch solution for publishers</title> <link>http://www.talkingnewmedia.com/2015/12/03/maz-introduces-wear-its-apple-watch-solution-for-publishers/</link>

<guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344edf5b</guid>

<media:content url="http://www.talkingnewmedia.com/wp-content/uploads/2015/12/Maz-Wear-580.jpg"/>

<pubDate>Fri, 20 Nov 2015 14:28:16 -0800</pubDate>

<author>john@example.com (John)</author>

<maz:type>video</maz:type>

<maz:videoEmbedCode><![CDATA[<iframe width="560" height="315" src="https://www.youtube.com/embed/_MfXYPBJ0bw" frameborder="0" allowfullscreen></iframe>]]></maz:videoEmbedCode>

<maz:textUpper>This text shows above the video, and it's optional.</maz:textUpper>

<maz:textLower>This text shows below the video, and it's optional.</maz:textLower>

</item>

<item>

<title>Video with direct file URL.</title> <link>http://www.mazdigital.com/phoenix</link>

<guid isPermaLink="false">urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344edf5c</guid>

<media:content url="http://www.talkingnewmedia.com/wp-content/uploads/2015/12/Maz-Wear-580.jpg"/>

<pubDate>Fri, 20 Nov 2015 14:38:16 -0800</pubDate>

<description>Some text.</description>

<author>john@example.com (John)</author>

<maz:type>video</maz:type>

<maz:video url="https://s3.amazonaws.com/help.dev.mazdigital.com/yk/Media/1.mp4"/>

<maz:videoImage url="https://s3.amazonaws.com/help.dev.mazdigital.com/yk/Media/1.jpg"/>

<maz:textUpper>This text shows above the video, and it's optional.</maz:textUpper>

<maz:textLower>This text shows below the video, and it's optional.</maz:textLower>

</item>

</channel>

</rss>


Feed Processing

Feed processing times usually depend on various factors like:

  • Number of articles in the feed
  • The content of the articles
  • Load on MAZ Servers

If you're seeing a delay in the appearance of articles in the app, it is probably because of the above reasons.

Feed Processing Failures

There can be a few cases where a few articles may fail during processing by the third-party article extraction tool we use ie. Diffbot. Diffbot is used to extract the body, images, headings, byline, etc. from articles that allows MAZ to create templatized versions of the articles with the templates applied based on your choice in the MAZ dashboard.

A few examples of Diffbot errors when processing articles:

  • Could Not Download Page
  • Automatic Page Concatenation Exceeded Timeout
  • Error Downloading URL

And more can be found here.


In case of these failures, MAZ will load the original source URL of the article in a web view in the app instead of loading the templatized article ie. such articles will open to the actual article on your website without any MAZ template applied.

Did this answer your question?