Search
Clear search
Close search
Google apps
Main menu

Not available in DFP Small Business.

MRSS feed elements for DFP Video

This is the new version of the MRSS feed specification for DFP Video.
This version simplifies the ingestion of MRSS content sources, and allows for improved error handling and syncing. The table lists all of the fields that DFP Video recognizes (and in some cases, expects) in your XML feed. Only these elements are recognized.

Jump to a specific element in the list


Required elements
<atom:link>
<item>
<dfpvideo:contentId>
<dfpvideo:lastModifiedDate>
<title>

Recommended and optional elements
<dfpvideo:cuepoints>
<dfpvideo:keyvalues>
<dfpvideo:thirdPartyContentId>
<dfpvideo:owner>
<media:content>
<media:description>
<media:status>
<media:thumbnail>
<pubDate>

Dynamic Ad Insertion elements

These elements are specific to Dynamic Ad Insertion, and should be used in combination with the elements above.

<dfpvideo:ingestUrl>
<dfpvideo:lastMediaModifiedDate>
<dfpvideo:closedCaptionUrl>
<dfpvideo:fw_caid>

 See an example of the elements in context in the sample feed.

For all elements of the feed, DFP ignores case upon ingestion. This is especially important for <dfpvideo:contentId>. If character case is the only thing that differentiates two or more content IDs, they are considered duplicates, and the metadata from the last <item> overrides that of the previous <item>.

Required elements

<atom:link> <channel> Required
Description
Identifies the feed's paging information. DFP reads this element for two attributes: rel and href.
  • rel indicates how the URL in the href attribute relates to the feed's result set.
    • rel='next': Indicates that the href URL points to the next page of the feed's result set. If the feed contains an <atom:link> tag with rel='next', this indicates that there's another page of results. Otherwise, the current page is the last page in the result set.
  • href specifies a URL that identifies the resource in the <atom:link> tag.
Example:
<atom:link rel='next' href='http://www.feedprovider.com/video/account/vids?page3'/>

Important notes:

  • When DFP first creates a content source, it expects that the feed URL set returns the first result-set of the feed. A result-set of 100 items (100 items per page) is recommended.
  • If the <atom:link> element is absent from a page of the feed, DFP considers that page the last page of the feed.

back to top 

Element Child element of Requirement
<item> <channel> Required
Description
Identifies a single video in the feed. A DFP video feed may contain one or more <item> entries. Each of them are required to contain three elements for proper metadata ingestion:

<dfpvideo:contentId>, <dfpvideo:lastModifiedDate> and <title>

back to top 

Element Child element of Requirement
<dfpvideo:contentId> <item> Required
Description
Stored as the CMS content ID in DFP, this is an important request parameter, formed as a part of the ad request to identify which ads DFP can serve against the corresponding video. This value can be used for the vid parameter on a video ad request. It can be numeric or alphanumeric.

Example:
<dfpvideo:contentId>sdjfbadfb8w3489y</dfpvideo:contentId>

back to top 

Element Child element of Requirement
<dfpvideo:lastModifiedDate> <item> Required
Description

Indicates when any aspect of the video or its metadata was last modified.

In order for DFP to ingest modified content as quickly as possible, the lastModifiedDate should be specified and the feed must be ordered by most recently modified at the top.

All time stamps must conform to RFC 822 specification or follow IS0 8601 format.


Examples:
<dfpvideo:lastModifiedDate>2006-02-19T04:22:39+05:00</dfpvideo:lastModifiedDate>
<dfpvideo:lastModifiedDate>Sun, 19 Feb 2006 09:22:39 +0000
</dfpvideo:lastModifiedDate>

 
See examples of each date format

RFC 822 examples


  • Wed, 31 Oct 2016 08:00:00 EST
  • Wed, 31 Oct 2016 13:00:00 GMT
  • Wed, 31 Oct 2016 15:00:00 +0200
 

ISO 8601 examples


  • 20161031
  • 2016-10-31
  • 2016-10-31T08:00:00+01:00

back to top 

Element Child element of Requirement
<title> <item> Required
Description

The name of the video entry.


Example:
<title>My video</title>

back to top 

Recommended and optional elements

Element Child element of Requirement
<dfpvideo:cuepoints> <item> Varies *
Description

* Required if the video contains mid-roll ad breaks.

Identifies the cue points in seconds, separated by commas. Cue points are places in time where an ad can be inserted in the video.

Fractional seconds are supported for up to 3 digits (for example, 55.532 seconds). Additional digits beyond 3 are truncated.


Example:
<dfpvideo:cuepoints>0,55.532,109</dfpvideo:cuepoints>

back to top 

Element Child element of Requirement
<dfpvideo:keyvalues> <item> Optional
Description
Identifies any custom metadata for the video. It has the following attributes: key, value, and type. Possible values for type are int, long, string, and timestamp. If the type is timestamp, then the value must be provided in milliseconds since epoch, January 1, 1970 00:00:00.000 GMT.

Examples:
<dfpvideo:keyvalues key="episode" value="5" type="int"/>
<dfpvideo:keyvalues key="season" value="2" type="int"/>
<dfpvideo:keyvalues key="title" value="Example Title" type="string"/>

<dfpvideo:keyvalues key="recommended count" value="5" type="int"/>
<dfpvideo:keyvalues key="description" value="A lot of text here" type="string"/>
<dfpvideo:keyvalues key="last view time" value="5838943899" type="timestamp"/>

back to top 

Element Child element of Requirement
<dfpvideo:thirdPartyContentId> <item> Optional
Description

Defines the content ID of the video in a third-party CMS, such as YouTube, Brightcove or Ooyala. If this element is present, DFP considers the video from the third-party CMS to be a duplicate of the video in your MRSS feed and links this third-party content ID with the <dfpvideo:contentId>.

The metadata from your MRSS feed overrides the metadata from the third-party CMS.


Example:
<dfpvideo:thirdPartyContentId id='FlU56m6G3DM'/>

You can add up to three thirdPartyContentId elements per video. This may be necessary if you syndicate the video to multiple third-party CMSes, so you can link them to the <dfpvideo:contentId> from your MRSS feed and define the necessary metadata only in one place (the MRSS feed). The video IDs from each CMS are unique globally. For example, two YouTube videos can never have the same ID.

back to top 

Element Child element of Requirement
<dfpvideo:owner> <item> Optional
Description
Identifies the content owner to be linked to a content partner in DFP.

Example:
<dfpvideo:owner name=”ContentPartnerName”/>

Learn more about dfpvideo:owner

This optional element identifies the content owner that should be linked to a content partner in DFP. Only one content owner can be assigned to an item. If a feed defines more than one owner for an item, DFP considers only the last defined owner.

DFP maps content owners from the CMS to content partners in DFP using the content source mapping functionality. The following rules apply:

  • User-defined content owner: You can assign a content owner to a video on the video content details page in DFP. Such an assignment is referred to as a “user-defined” content owner. If such a content owner exists for a video, DFP ignores any content owner information in the feed.
  • Mapping-defined content owner: You can assign a content owner to a set of videos through the mapping screen in DFP. If a user-defined content owner already exists, it will not be overridden. Mapping-defined content owners are updated as the feed changes.

back to top 

Element Child element of Requirement
<media:content> <item> Recommended
Description

This element has attributes that provide useful metadata information, such as the source URL and duration. It is an optional sub-element of <item>.

DFP can read the following attributes of the <media:content> element:

  • "duration" attribute: DFP only recognizes one duration entry per <item>. If more than one is specified, the duration is chosen from an entry at random, which may be unexpected.

    The duration value should be in seconds (whole numbers, no decimals).

  • "url" attribute: The direct URL of the video resource, used only to show a link in the content details within the DFP interface.

Example:
<media:content url='http://www.feedprovider.com/video?8eqe7e' duration='39'/>

back to top 

Element Child element of Requirement
<media:description> <media:content> or
<item>
Optional
Description
The description of the video entry.

Example:
<media:description>This is the description of the video.</media:description>

back to top 

Element Child element of Requirement
<media:status> <media:content> or
<item>
Optional
Description
Determines whether the video is marked as active, deleted, or inactive in DFP. If this element is absent, the default status is active. Values are case insensitive and may include the following state:
  • active (marked "Active" in DFP)
  • deleted (marked "Archived" in DFP; new "deleted" videos are not ingested)
  • blocked (marked "Inactive" in DFP)
If a user changes the status for a video within DFP, any subsequent status changes from the feed are ignored. A user can remove the override by clicking "Use source setting" in the DFP UI, after which DFP will resume using status updates from the feed.

Examples:
<media:status state="blocked" reason="http://www.reasonforblocking.com"/>
<media:status state="deleted"/>
<media:status state="active"/>

(DFP does not ingest the reason attribute.)

back to top 

Element Child element of Requirement
<media:thumbnail> <media:content> or
<item>
Recommended
Description
Allows the thumbnail of the video to appear in the DFP interface. DFP currently only needs the URL attribute of this element, but you can provide additional attributes if desired: height, width, and time (the offset at which the frame shown in the thumbnail appears in the video).

The DFP UI never displays a thumbnail larger than 280 pixels wide and 190 pixels high. If the url links to a larger image, DFP links to the original version but visually scales the image with inline CSS for display in the UI.


Example:
<media:thumbnail url='http://www.myfeed.com/account/sdjfbadfb8w3489y/bigtn.jpg' width='280' height='190'/>

back to top 

Element Child element of Requirement
<pubDate> <item> Optional
Description

Identifies the date on which the content was published. This element is only used for DFP video ad rules.

All timestamps must conform to RFC 822 specification or follow IS0 8601 format.


Examples:
<pubDate>2006-02-19T04:22:39+05:00</pubDate>
<pubDate>Sun, 19 Feb 2006 09:22:39 +0000</pubDate>
 
See examples of each date format

RFC 822 examples


  • Wed, 31 Oct 2016 08:00:00 EST
  • Wed, 31 Oct 2016 13:00:00 GMT
  • Wed, 31 Oct 2016 15:00:00 +0200
 

ISO 8601 examples


  • 20161031
  • 2016-10-31
  • 2016-10-31T08:00:00+01:00

back to top 

Elements specific to Dynamic Ad Insertion

Element Child element of Requirement
<dfpvideo:ingestUrl> <item> Required *
Description

* Required for Dynamic Ad Insertion.

Node for specifying the video ingest URL to the master m3u8 file used for conditioning and playlist generation.

  • "type" attribute: should be set to HLS (application/x-mpegURL).
  • "preconditioned" attribute: should be set to true or false to indicate if the ingestURL for this content is already conditioned for mid-roll ads, which means that your segments are already split at the time of ad breaks. This attribute defaults to false if not explicitly set.

    Content is considered conditioned if the video segments in your stream are timed precisely for cue points to insert ads. If so, there should be a #EXT-X-PLACEMENT-OPPORTUNITY marker in the HLS stream to indicate to DFP that an ad break should be inserted at this point in the video content.

    Learn more about conditioned and preconditioned content for mid-roll ad insertion.


Example:
<dfpvideo:ingestUrl type="application/x-mpegURL"  preconditioned="false">https://cdn.akamai.com/?v=123.m3u8</dfpvideo:ingestUrl>
 
The use of secure (https) ingest URLs is encouraged, to reduce the risk of playback problems in modern web browsers. This is especially important if the video might play on a secure (https) web page.

back to top 

Element Child element of Requirement
<dfpvideo:lastMediaModifiedDate> <item> Recommended
Description

Indicates when the video file referenced in <dfpvideo:ingestUrl> was last modified. If this value is ever updated in the feed the lastModifiedDate for the content also needs to be updated.

All timestamps must conform to RFC 822 specification or follow IS0 8601 format.


Examples:
<dfpvideo:lastMediaModifiedDate>2006-02-19T04:22:39+05:00</dfpvideo:lastMediaModifiedDate>
<dfpvideo:lastMediaModifiedDate>Sun, 19 Feb 2006 09:22:39
+0000</dfpvideo:lastMediaModifiedDate>

 
See examples of each date format

RFC 822 examples


  • Wed, 31 Oct 2016 08:00:00 EST
  • Wed, 31 Oct 2016 13:00:00 GMT
  • Wed, 31 Oct 2016 15:00:00 +0200
 

ISO 8601 examples


  • 20161031
  • 2016-10-31
  • 2016-10-31T08:00:00+01:00

back to top 

Element Child element of Requirement
<dfpvideo:closedCaptionUrl> <item> Varies *
Description

* Required only when you have activated subtitles in the interface.

Node for specifying the URL to the closed caption/subtitle file. All available closed captions files should be provided in the feed as multiple closedCaptionUrl elements -- one caption file per language.

The formats supported are TTML/DXFP (application/ttaf+xml) and WebVTT (text/vtt).

  • "language" attribute: should be set to the language of the caption file. This attribute is used similar to the xml:lang attribute detailed in the XML.
  • "type" attribute: should be set to the MIME type of the caption files.
Example:
<dfpvideo:closedCaptionUrl language="en" type="text/vtt">http://cdn.com/subtitle.vtt</dfpvideo:closedCaptionUrl>

back to top 

Element Child element of Requirement
<dfpvideo:fw_caid> <item> Varies *
Description

* Required only for Freewheel users.

Node for specifying Freewheel custom asset ID used for ad targeting.

Example:
<dfpvideo:fw_caid>621160003648<dfpvideo:fw-caid>

back to top 

Was this article helpful?
How can we improve it?