Skip to content

YouTube collections


YouTube is a social media site focused on video sharing.

Please note that your usage of Funnelback to gather content from YouTube must comply with YouTube's terms of service.

Getting API key

To be able to gather content from YouTube you must first use your Google account to create an API key. Google provides instructions on creating an API key which will provide the most up-to-date instructions for creating the key.

Configuration options

YouTube collections support the following settings:

Metadata mappings

YouTube collections includes a number of default YouTube specific metadata mappings:

Class ID Type Behaviour Explanation Metadata fields included
author text content /
authorUrl text display /
c text content Description /
category text content /
commentCount number N/A /
d date date Date /
dislikeCount number N/A /
duration text display /
durationInSeconds number N/A /
favoriteCount number N/A /
identifier text display /
imageSmall text display Image URL - small /
imageMedium text display Image URL - medium /
imageLarge text display Image URL - large /
latLong geospatial x/y co-ordinate N/A /
likeCount number N/A /
t text content Title /
viewCount number N/A /

Use the -SF query processor option to access these metadata fields on the search response and in the templates (i.e. -SF=[author,viewCount]).


Please note that YouTube applies limits to the volume of content which can be retrieved from their APIs, and so in the case of large channels Funnelback may be unable to gather all historical content.

Working with the fetched data

Funnelback will crawl YouTube and convert responses into XML. You can use the metadata customisation tool to map elements to metadata classes.

Note: To preview the crawled records please enable debug mode by setting youtube.debug=true in collection.cfg file.

The XML that Funnelback generates for a YouTube collection is as follows:

  <title>some title</title>
  <description>some description</description>
      <thumbNailUrlExtras class="linked-list"/>
      <thumbNailUrlExtras class="linked-list"/>
      <thumbNailUrlExtras class="linked-list"/>
      <thumbNailUrlExtras class="linked-list"/>
      <thumbNailUrlExtras class="linked-list"/>
  <embedHtml>&lt;iframe width=&quot;480&quot; height=&quot;270&quot; src=&quot;//; frameborder=&quot;0&quot; allow=&quot;autoplay; encrypted-media&quot; allowfullscreen&gt;&lt;/iframe&gt;</embedHtml>
  <extras class="linked-list"/>


Funnelback logo