Skip to main content

YouTube

The YouTube integration provides access to the videos you manage through YouTube. When you identify a video to use, you import it into Brightspot and then add it to assets such as articles and galleries.

This section describes how to configure the YouTube integration in Brightspot, and how to perform an integrated search.

Including YouTube in a build​

The following table lists the dependencies to include in your build configuration.

ArtifactDescription
com.psddev:google-youtubeExposes the external type YouTubeVideo and fields in Edit Site to configure and run integrated search with YouTube.

Runtime prerequisites​

  • Developer configuration—Brightspot provides a standard converter YoutubeUrlVideoConverter. Developers can deploy custom converter classes by extending ExternalItemConverter and overriding the convert(YouTubeVideo youTubeVideo) method.
  • Ops configuration—Configure an API key in your YouTube console. For details, see Obtaining authorization credentials.
  • CMS configuration—Configure the site interfacing with YouTube. For details, see Configuration.

Configuration​

You can configure this integrated search at the Global level or the site level. Global configurations are inherited by all sites, and site-level configurations override Global configurations. The following procedure explains how to configure this integrated search at the Global level.

To configure the YouTube integration:

  1. Obtain the following from your YouTube console:

  2. Go to Admin > Settings.

  3. Expand Integrations > YouTube.

  4. From the YouTube API Client list, click Create New.

  5. In the Name field, enter an internal name. Brightspot uses this name in selection fields.

  6. In the API Key field, paste the API key from step 1.

  7. (Optional) In the Channel ID field, enter the channel ID from step 1.

  8. Click Save.

  9. Click Back.

  10. From the YouTube API Client list, select the client you created.

  11. Click Save.

Importing a YouTube video​

Use the following procedure to search for and use a video from YouTube.

To search for and use a YouTube video:

  1. Open the search panel.

  2. Set the content types filter to YouTube Video.

    Note

    The external type Video (YouTube) is not the same as YouTube Video. If YouTube Video is not available as an external type, the integration with YouTube is not configured. See Configuration.

  3. Add other filters or search text. For additional information, see Search filters. Brightspot lists any matching videos.

  4. Click on the video.

  5. In the content edit form, click Import.

Brightspot imports the video's metadata and displays it in a content edit form. You can modify the title, description, or other metadata, and then use the video in an asset.

For additional information about importing external assets, see Importing external videos.

See also:

Uploading YouTube videos individually​

The following procedure explains how to upload YouTube videos to Brightspot.

For a wireframe example of what this content type can look like on your site, see YouTube video URL design.

tip

Before beginning these steps, in your YouTube console, obtain the URL or ID of the video you want to upload to Brightspot.

To upload a video from YouTube:

  1. In the header, click .
  2. From the Create list, select Video (YouTube URL).
  3. Using the following table as a reference, complete the fields as needed.
  4. Complete your site's workflow and publish the video.

After you save your video, you can use it in assets such as articles and playlists. You can also add videos to text you compose in the rich-text editor.

FieldDescription
YouTube URL or IDEnter the URL or ID of the YouTube video you want to upload.
TitleEnter a title. When you add the video to another asset, the title is visible to visitors to your site.
Internal NameEnter an internal name for this asset. Brightspot uses this name internally, such as in the search panel and recent activity widget. This name is not visible to visitors to your site.
DescriptionEnter a description. This description is not visible to visitors to your site.
PreviewA preview of the YouTube video you are uploading.
Thumbnail ImageClick and select an image. This image is not visible to visitors to your site; it appears in Brightspot widgets, such as the search panel. (If you don't select a thumbnail image, Brightspot uses the video's first frame as the thumbnail.)
Default MuteSelect Enabled to have the video muted by default.
Default AutoplaySelect Enabled to have the video play automatically when the page is visited.
TagsSelect the tags associated with this asset. This selection is visible to visitors to your site.

For information about creating a tag, see Tag.
Metadata
FieldDescription
DurationUpdates with the duration of the uploaded video file.
Aspect RatioUpdates with the aspect ratio of the uploaded video file.
DimensionsUpdates with the dimensions of the uploaded video file.