Setting Up Video Sitemap Feed with Outbound Feeds
The Video Sitemap feed uses the sitemap-video block which is an out-of-the-box template that uses custom fields to quickly and easily set up, configure and manage your feed.
Feed Setup
The Video Sitemap feed is a platform level Arc feed block with configurable and customizable parameters. It’s the sitemap with the addition of a video tag that can display a single video encoding that you can specify with a customField.
Steps to configure the Video Sitemap feed.
Sitemap Configuration
1. Video Title
ANS field to be used for the <video:title>
field.
default: headlines.basic
2. Description
ANS field to be used for the <video:description>
field.
default: description.basic || subheadlines.basic
3. Video Encoding
Criteria to be used to match a video encoding. Only one video encoding will be displayed in the sitemap. Your videos may not be encoded with the default bitrate or stream_type
. Use this custom field to select which video encoding should be included in the video sitemap.
default: { bitrate: 5400, stream_type: ‘mp4’ }
4. Last Modified Date
ANS date field
Select one: created_date
, display_date
, first_publish_date
, last_updated_date
, or publish_date
default: last_updated_date
5. Priority
Sitemap priority is a hint to the consumer of how important these links are in the website. This is just a suggestion and has no impact on how long the page is cached.
Select one: numbers from 0.0 to 1.0
default: 0.5
6. Change Frequency
Denotes the suggested frequency bots should revisit the sitemap for updates. This is just a suggestion and has no impact on how long the page is cached.
Select one: always
, hourly
, daily
, weekly
, monthly
, yearly
, never
, Exclude field
default: always
Featured Image
1. Include Promo Images
Used to determine whether to include an image in the sitemap or not. true
/false
default: true
2. Path to promo_items
ANS field to use for the featured image, supports a JMESPath statement.
default: promo_items.basic || promo_items.lead_art
3. Image height and or width
A set of key value pairs where you can set an integer height and or width to resize all images. Zero means no resizing will be performed.
default: height: 0, width: 0
Resolver Configuration
Each feed template needs to have a resolver applied. To Create A Resolver, you’ll want to configure these fields.
1. Resolver Name
Unique name given to the resolver, for example, sitemap-video
.
2. Resolver Priority
Number to indicate priority order (1 to 100). Lower numbers are evaluated first.
3. Regex Pattern
^/arc/outboundfeeds/sitemap-video/?$|^/arc/outboundfeeds/sitemap-video/category/(.*)/?$|^/arc/outboundfeeds/sitemap-video/author/(.*)/?$|^/arc/outboundfeeds/sitemap-video/keyword/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags_slug/(.*)/?$
4. URL Parameters
5. Websites
all
6. Content Source
feeds-content-api
There are other content sources available out-of-the-box. See Content Sources with Outbound Feeds.
7. Patterns
These positions come from the regex pattern. There are a number of ways to pass a section (or author, keyword or tag) to the content source from the resolver. All of them use a grouping () in the regex.
Section - Pattern 1
^/arc/outboundfeeds/sitemap-video/?$|^/arc/outboundfeeds/sitemap-video/category/(.*)/?$|^/arc/outboundfeeds/sitemap-video/author/(.*)/?$|^/arc/outboundfeeds/sitemap-video/keyword/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags_slug/(.*)/?$
Author - Pattern 2
^/arc/outboundfeeds/sitemap-video/?$|^/arc/outboundfeeds/sitemap-video/category/(.*)/?$|^/arc/outboundfeeds/sitemap-video/author/(.*)/?$|^/arc/outboundfeeds/sitemap-video/keyword/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags_slug/(.*)/?$
Keywords - Pattern 3
^/arc/outboundfeeds/sitemap-video/?$|^/arc/outboundfeeds/sitemap-video/category/(.*)/?$|^/arc/outboundfeeds/sitemap-video/author/(.*)/?$|^/arc/outboundfeeds/sitemap-video/keyword/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags_slug/(.*)/?$
Tags - Text - Pattern 4
^/arc/outboundfeeds/sitemap-video/?$|^/arc/outboundfeeds/sitemap-video/category/(.*)/?$|^/arc/outboundfeeds/sitemap-video/author/(.*)/?$|^/arc/outboundfeeds/sitemap-video/keyword/(.*)/?$|^/arc/outboundfeeds/sitemap/-video/tags/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags_slug/(.*)/?$
Tags - Slug - Pattern 5
^/arc/outboundfeeds/sitemap-video/?$|^/arc/outboundfeeds/sitemap-video/category/(.*)/?$|^/arc/outboundfeeds/sitemap-video/author/(.*)/?$|^/arc/outboundfeeds/sitemap-video/keyword/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags/(.*)/?$|^/arc/outboundfeeds/sitemap-video/tags_slug/(.*)/?$
Include - Terms
Modify the query used by the content source. More information on queries can be found in How to Create a Custom Query with Outbound Feeds.
[{“term”:{“type”:“video”}}, {“range”:{“last_updated_date”:{“gte”:“now-2d”,“lte”:“now”}}}]
We need to modify the default query to only return videos. Which ever date field you chose to display is probably the date field that should be used in the query.
Exclude - Terms
Modify the query used by the content source. More information on queries can be found in How to Create a Custom Query with Outbound Feeds.
Exclude - Sections
You can enter a comma separated list of sections to exclude. For example /premium,/paid-content
.
Feed - Size
Integer 1 to 100. Defaults to 100. If you added a size URL parameter, select the parameter option and select size and enter a default value.
Feed - Offset
Integer. Defaults to 0. If you added a from URL parameter, select the parameter option and select from and enter a default value.
Sort - last_updated_date:desc
If left blank it will default to publish_date:desc
. Which ever date field you selected to display for the Last Modified Date is the date you should enter here. The format is date_field + “:” + sort order (desc or asc). Valid date fields are created_date
, display_date
, first_publish_date
, last_updated_date
, or publish_date
.
Source - Exclude - A comma separated list of ANS fields to remove from the default list of ANS fields. See the default list in Content Sources with Outbound Feeds - Included Data.
Source - Include - A comma separated list of ANS fields to add to the default list of ANS fields. See the default list in Content Sources with Outbound Feeds - Included Data.
Include - Distributor - Name
If you only want content from a single distributor, enter the name here. You may only populate one distributor field.
Exclude - Distributor - Name
If you want to exclude content from a single distributor, enter the name here. You may only populate one distributor field.
Include - Distributor - Category
If you only want content from a single distributor category, enter the name here. You may only populate one distributor field.
Exclude - Distributor - Category
If you want to exclude content from a single distributor category, enter the name here. You may only populate one distributor field.
8. Default Template
Select the template you just created sitemap-video to use with this resolver.
9. Default output type
Select xml
10. Content Mapped Template
blank
Video Sitemap URL
To preview your Video Sitemap XML, modify the URL below with the your client org and website name.
https://outboundfeeds.CLIENTORG.arcpublishing.com/pf/arc/outboundfeeds/sitemap-video/?\_website=CLIENTWEBSITE NAME
Additional Information
All sitemaps adhere to the Standard Sitemap Protocol and implement Google’s extensions for both Images and Videos.
- Steps to create and manage Outbound Feeds.
- Optional Content Sources For OBF.
- Using Jmespath To Map To CustomFields ANS Values.
- More details on Resolvers.
- Regex Debugger.