YouTube
Bundles contain custom components that support specific third-party integrations with Orbis Studio.
This page describes the components that are available in the YouTube bundle.
These components use the YouTube Data API v3. Most require a YouTube Data API key from Google Cloud Console.
YouTube Search
The YouTube Search component searches YouTube for videos matching a query and returns video metadata as a list of Data records.
YouTube Search parameters
Some parameters are hidden by default in the visual editor. You can modify all component parameters through the component inspection panel that appears when you select a component.
| Name | Type | Description |
|---|---|---|
| query | String | Input parameter. The search query to look for on YouTube. |
| api_key | SecretString | Input parameter. Your YouTube Data API key. |
| max_results | Integer | Input parameter. Maximum number of results to return. |
| order | String | Input parameter. Sort order for search results. Options: relevance, date, rating, viewCount. |
| include_metadata | Boolean | Input parameter. Include video metadata such as description and view statistics. |
YouTube Search outputs
| Name | Type | Description |
|---|---|---|
| results | JSON | Output parameter. Video search results as Data records. |
YouTube Channel
The YouTube Channel component retrieves detailed information and statistics about a YouTube channel.
YouTube Channel parameters
Some parameters are hidden by default in the visual editor. You can modify all component parameters through the component inspection panel that appears when you select a component.
| Name | Type | Description |
|---|---|---|
| channel_url_or_id | String | Input parameter. The channel URL or channel ID. |
| api_key | SecretString | Input parameter. Your YouTube Data API key. |
| include_statistics | Boolean | Input parameter. Include subscriber count, view count, and video count. |
YouTube Channel outputs
| Name | Type | Description |
|---|---|---|
| dataframe | Table | Output parameter. Channel information and statistics as a DataFrame. |
YouTube Playlist
The YouTube Playlist component extracts all video URLs from a YouTube playlist.
YouTube Playlist parameters
Some parameters are hidden by default in the visual editor. You can modify all component parameters through the component inspection panel that appears when you select a component.
| Name | Type | Description |
|---|---|---|
| playlist_url | String | Input parameter. The URL of the YouTube playlist. |
YouTube Playlist outputs
| Name | Type | Description |
|---|---|---|
| video_urls | JSON | Output parameter. List of video URLs from the playlist. |
YouTube Comments
The YouTube Comments component retrieves and returns comments from a YouTube video.
YouTube Comments parameters
Some parameters are hidden by default in the visual editor. You can modify all component parameters through the component inspection panel that appears when you select a component.
| Name | Type | Description |
|---|---|---|
| video_url | String | Input parameter. The URL of the YouTube video. |
| api_key | SecretString | Input parameter. Your YouTube Data API key. |
| max_results | Integer | Input parameter. Maximum number of comments to retrieve. |
YouTube Comments outputs
| Name | Type | Description |
|---|---|---|
| data | JSON | Output parameter. Video comments as Data records. |