The YouTube platform lets Appkit pull results from YouTube, which is often useful for presenting ‘related videos’. The search can be scoped to a particular YouTube Channel if required.

​
Setup

To add YouTube connectors to a Maven project, you must add this dependency to your project’s pom.xml file: 
<dependency>
    <groupId>twigkit</groupId>
    <artifactId>twigkit.youtube</artifactId>
    <version>${project.parent.version}</version>
</dependency>

​
Usage

This example shows how to configure a Yotube search endpoint. You can define the search endpoint through a configuration node (say conf/platforms/youtube.conf). For this you must include name: twigkit.search.youtube.YouTube, as shown here: 
name: twigkit.web.youtube.YouTube
apiKey: foo
channelId: bar

​
Required attributes

  • apiKey (java.lang.String) API Key for the application to access YouTube.

​
Optional attributes

  • channelId (java.lang.String) The ID of the channel to restrict the search to.

​
Attributes shared across platforms

  • host (java.lang.String) The URI of the platform. Must be specified using the full URI (for example, http://localhost:1234; localhost:1234 will not work).
  • name (java.lang.String) The display name of this Platform instance. Used for identifying different platforms in the user interface.
  • aliases (java.lang.String) Manage mappings from field names to aliases (use a comma-separated list). All references to the field (via this platform) in results, facets, filters, and query strings are mapped. For example, to refer to a field in the index named firstnamelastname as name and countryofresidence as country, use these mappings: aliases="firstnamelastname=name,countryofresidence=country"
  • defaultQuery (java.lang.String) Default query to use when none is specified.
  • defaultFacets (java.lang.String) Default facets to request when none are specified. This is a comma separated list.
  • spellCheck (java.lang.Boolean) Spellcheck the Query term if supported by the Platform.
    Default: true
  • expandQuery (java.lang.Boolean) Apply advanced linguistics such as stemming or lemmatization if supported by the Platform.
    Default: true
  • autoCorrect (java.lang.Boolean) Whether to auto-correct and resubmit futile queries (queries with zero results).
    Default: true
  • fileTypeField (java.lang.String) Set which field contains information about file type (mime type).
  • resultIDField (java.lang.String) Set which field represents the unique identifier for a given result.
  • pageLimit (java.lang.Long) A limitation to which page the platform will offset.