YouTube Source Provider
The YouTube Source feeds data from YouTube supporting Videos, My Channel, My Channel Video, My Channel Videos, My Channel Playlist, My Channel Playlist Videos, My Playlist Video and My Playlist Videos queries.
Settings
| Setting | Description | Default |
|---|---|---|
| Name | The name that will identify this source instance. | |
| Default Cache Time | The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration. | 3600 |
If the source is based on a YouTube channel or playlist an oAuth authentication is required.
| Setting | Description |
|---|---|
| Account | The Google Account which to authenticate with. |
| Channel | The YouTube Channel from which to create the source. |
| Playlist | The YouTube Playlist from which to create the source. |
If the source is based on YouTube videos an API Key is required instead.
| Setting | Description |
|---|---|
| API Key | The Google API Key which to authenticate with. |
Videos Query
Fetches public videos with advanced query params resolving to a list of Video Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Videos ID | Restricts the results to videos created by a specific channel ID. | ✓ | |
| Channel ID | Restricts the results to videos created by a specific channel ID. | ✓ | |
| Query Term | The list of terms the videos should be associated with. Use the Boolean NOT (-) and OR (|) operators to exclude or find videos that are associated with one of several search terms. For example, to match either "boating" or "sailing", set as boating|sailing. Similarly, to exclude "fishing", set as boating|sailing -fishing. | ✓ | |
| Since/Until | Restricts the results to videos that have been published within the specified range of dates. | ✓ | |
| Location/Radius | Location in conjunction with radius, defines a circular geographic area to which to restrict the videos. The location points the center of the area with latitude/longitude coordinates e.g. 37.42307,-122.08427, while the radius is the maximum distance from the location in m, km, ft, or mi units, e.g 5km. | ✓ | |
| Region | Restricts the results to videos that can be viewed in the specified country. The value is an ISO 3166-1 alpha-2 country code, e.g ES. | ✓ | |
| Language | Restricts the results to videos that are most relevant to the specified language. The value is typically an ISO 639-1 two-letter language code, however, you should use the values zh-Hans for simplified Chinese and zh-Hant for traditional Chinese. Note that results in other languages will still be returned if they are highly relevant to the search query term. | ✓ | |
| Definition | Restricts the results based on the videos quality, either High Definition, Standard Definition, or Any. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. | Any | |
| Duration | Restricts the results based on the videos duration, either Long, longer than 20 minutes, Medium, between four and 20 minutes, Short, less than four minutes, or Any. | Any | |
| Start | The starting point, e.g of a list of 20 videos start from the number 2. | 1 | ✓ |
| Quantity | The maximum amount of videos to retrieve. | 20 | ✓ |
| Order | The order in which the videos will be returned, within Date, reverse chronological order based on the date the videos were created, Rating, from highest to lowest rating, Relevance, based on their relevance to the search query, Title, alphabetically by title, or View Count, from highest to lowest number of views. | Relevance | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
My Channel Query
Fetches the channel content resolving to a Channel Type.
| Setting | Description | Default |
|---|---|---|
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
My Channel Video Query
Fetches a single video from the channel resolving to a Video Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Video | The playlist video which content to fetch. | ✓ | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
My Channel Videos Query
Fetches videos from the channel resolving to a list of Video Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Start | The starting position to retrieve the videos at. | 1 | ✓ |
| Quantity | The maximum amount of videos to fetch. | 20 | ✓ |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
My Channel Playlist Query
Fetches a single playlist from the channel resolving to a Playlist Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Playlist | The YouTube Playlist which content to fetch. | ✓ | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 | |
| Multi Items | The related multi-items content to query instead with Videos as the only option. |
My Channel Playlist Videos Query
Fetches videos from the playlist resolving to a list of Video Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Start | The starting position to retrieve the videos at. | 1 | ✓ |
| Quantity | The maximum amount of videos to fetch. | 20 | ✓ |
My Playlist Video Query
Fetches a single video from the playlist resolving to a Video Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Video | The playlist video which content to fetch. | ✓ | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
My Playlist Videos Query
Fetches videos from the playlist resolving to a list of Video Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Start | The starting position to retrieve the videos at. | 1 | ✓ |
| Quantity | The maximum amount of videos to fetch. | 20 | ✓ |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Video Type
Defines the mapping options of a YouTube Video object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | The unique identifier of this video. | String | |
| Title | The title of this video. | String | Limit |
| Description | The description of this video. | String | Limit |
| URL | The YouTube public URL, e.g. www.youtube.com/watch?v=c2pz2mlSfXA. | String | |
| Iframe Player | Generates an HTML embed video player with several configuration settings. | String | |
| Published At | The date this video was published. | String | Date |
| Thumbnail URL | The URL to this video thumbnail with different size options, Low, Medium (default), High Resolution, Standard, and `Max Resolution* | String | |
| Thumbnail Width | The width of this video thumbnail with same size options as for URL. | String | |
| Thumbnail Height | The height of this video thumbnail with same size options as for URL. | String | |
| Total Views | Number of times this video has been viewed. | Int | |
| Total Comments | Number of comments for this video. | Int | |
| Total Likes | Number of users that have indicated they like this video. | Int | |
| Total Dislikes | Number of users that have indicated they dislike this video. | Int |
Channel Type
Defines the mapping options of a YouTube Channel object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | The unique identifier of this channel. | String | |
| Title | The title of this channel. | String | Limit |
| Description | The description of this channel. | String | Limit |
| Country | The country with which this channel is associated. | String | |
| Published At | The date this channel was published. | String | Date |
| Thumbnail URL | The URL to this channel thumbnail with different size options, Low, Medium (default), High Resolution, Standard, and Max Resolution | String | |
| Thumbnail Width | The width of this channel thumbnail with same size options as for URL. | String | |
| Thumbnail Height | The height of this channel thumbnail with same size options as for URL. | String | |
| Total Views | Number of times this channel has been viewed. | Int | |
| Total Videos | Number of public videos uploaded to this channel. | Int | |
| Total Subscribers | Number of subscribers this channel has, the value is rounded down to three significant figures. | Int |
Playlist Type
Defines the mapping options of a YouTube Playlist object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | The unique identifier of this playlist. | String | |
| Title | The title of this playlist. | String | Limit |
| Description | The description of this playlist. | String | Limit |
| Iframe Player | Generates an HTML embed playlist player with several configuration settings. | String | |
| Published At | The date this playlist was published. | String | Date |
| Thumbnail URL | The URL to this playlist thumbnail with different size options, Low, Medium (default), High Resolution, Standard, and Max Resolution | String | |
| Thumbnail Width | The width of this playlist thumbnail with same size options as for URL. | String | |
| Thumbnail Height | The height of this playlist thumbnail with same size options as for URL. | String |