com.google.api.services.youtube

Class YouTube.Search.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.youtube.YouTubeRequest<SearchListResponse>

com.google.api.services.youtube.YouTube.Search.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

YouTube.Search

public class YouTube.Search.List
extends YouTubeRequest<SearchListResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YouTube.Search.List(java.lang.String part) Returns a collection of search results that match the query parameters specified in the API request.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getChannelId() The channelId parameter indicates that the API response should only contain resources created by the channel
java.lang.String	getChannelType() The channelType parameter lets you restrict a search to a particular type of channel.
java.lang.String	getEventType() The eventType parameter restricts a search to broadcast events.
java.lang.Boolean	getForContentOwner() Note: This parameter is intended exclusively for YouTube content partners.
java.lang.Boolean	getForDeveloper() The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website.
java.lang.Boolean	getForMine() The forMine parameter restricts the search to only retrieve videos owned by the authenticated user.
java.lang.String	getLocation() The location parameter restricts a search to videos that have a geographical location specified in their metadata.
java.lang.String	getLocationRadius() The locationRadius, in conjunction with the location parameter, defines a geographic area.
java.lang.Long	getMaxResults() The maxResults parameter specifies the maximum number of items that should be returned in the result set.
java.lang.String	getOnBehalfOfContentOwner() Note: This parameter is intended exclusively for YouTube content partners.
java.lang.String	getOrder() The order parameter specifies the method that will be used to order resources in the API response.
java.lang.String	getPageToken() The pageToken parameter identifies a specific page in the result set that should be returned.
java.lang.String	getPart() The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include.
com.google.api.client.util.DateTime	getPublishedAfter() The publishedAfter parameter indicates that the API response should only contain resources created after the specified time.
com.google.api.client.util.DateTime	getPublishedBefore() The publishedBefore parameter indicates that the API response should only contain resources created before the specified time.
java.lang.String	getQ() The q parameter specifies the query term to search for.
java.lang.String	getRegionCode() The regionCode parameter instructs the API to return search results for the specified country.
java.lang.String	getRelatedToVideoId() The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies.
java.lang.String	getRelevanceLanguage() The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language.
java.lang.String	getSafeSearch() The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.
java.lang.String	getTopicId() The topicId parameter indicates that the API response should only contain resources associated with the specified topic.
java.lang.String	getType() The type parameter restricts a search query to only retrieve a particular type of resource.
java.lang.String	getVideoCaption() The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions.
java.lang.String	getVideoCategoryId() The videoCategoryId parameter filters video search results based on their category.
java.lang.String	getVideoDefinition() The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos.
java.lang.String	getVideoDimension() The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.
java.lang.String	getVideoDuration() The videoDuration parameter filters video search results based on their duration.
java.lang.String	getVideoEmbeddable() The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage.
java.lang.String	getVideoLicense() The videoLicense parameter filters search results to only include videos with a particular license.
java.lang.String	getVideoSyndicated() The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com.
java.lang.String	getVideoType() The videoType parameter lets you restrict a search to a particular type of videos.
YouTube.Search.List	set(java.lang.String parameterName, java.lang.Object value)
YouTube.Search.List	setAlt(java.lang.String alt) Data format for the response.
YouTube.Search.List	setChannelId(java.lang.String channelId) The channelId parameter indicates that the API response should only contain resources created by the channel
YouTube.Search.List	setChannelType(java.lang.String channelType) The channelType parameter lets you restrict a search to a particular type of channel.
YouTube.Search.List	setEventType(java.lang.String eventType) The eventType parameter restricts a search to broadcast events.
YouTube.Search.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTube.Search.List	setForContentOwner(java.lang.Boolean forContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.Search.List	setForDeveloper(java.lang.Boolean forDeveloper) The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website.
YouTube.Search.List	setForMine(java.lang.Boolean forMine) The forMine parameter restricts the search to only retrieve videos owned by the authenticated user.
YouTube.Search.List	setKey(java.lang.String key) API key.
YouTube.Search.List	setLocation(java.lang.String location) The location parameter restricts a search to videos that have a geographical location specified in their metadata.
YouTube.Search.List	setLocationRadius(java.lang.String locationRadius) The locationRadius, in conjunction with the location parameter, defines a geographic area.
YouTube.Search.List	setMaxResults(java.lang.Long maxResults) The maxResults parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Search.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTube.Search.List	setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.Search.List	setOrder(java.lang.String order) The order parameter specifies the method that will be used to order resources in the API response.
YouTube.Search.List	setPageToken(java.lang.String pageToken) The pageToken parameter identifies a specific page in the result set that should be returned.
YouTube.Search.List	setPart(java.lang.String part) The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include.
YouTube.Search.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Search.List	setPublishedAfter(com.google.api.client.util.DateTime publishedAfter) The publishedAfter parameter indicates that the API response should only contain resources created after the specified time.
YouTube.Search.List	setPublishedBefore(com.google.api.client.util.DateTime publishedBefore) The publishedBefore parameter indicates that the API response should only contain resources created before the specified time.
YouTube.Search.List	setQ(java.lang.String q) The q parameter specifies the query term to search for.
YouTube.Search.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Search.List	setRegionCode(java.lang.String regionCode) The regionCode parameter instructs the API to return search results for the specified country.
YouTube.Search.List	setRelatedToVideoId(java.lang.String relatedToVideoId) The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies.
YouTube.Search.List	setRelevanceLanguage(java.lang.String relevanceLanguage) The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language.
YouTube.Search.List	setSafeSearch(java.lang.String safeSearch) The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.
YouTube.Search.List	setTopicId(java.lang.String topicId) The topicId parameter indicates that the API response should only contain resources associated with the specified topic.
YouTube.Search.List	setType(java.lang.String type) The type parameter restricts a search query to only retrieve a particular type of resource.
YouTube.Search.List	setUserIp(java.lang.String userIp) IP address of the site where the request originates.
YouTube.Search.List	setVideoCaption(java.lang.String videoCaption) The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions.
YouTube.Search.List	setVideoCategoryId(java.lang.String videoCategoryId) The videoCategoryId parameter filters video search results based on their category.
YouTube.Search.List	setVideoDefinition(java.lang.String videoDefinition) The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos.
YouTube.Search.List	setVideoDimension(java.lang.String videoDimension) The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.
YouTube.Search.List	setVideoDuration(java.lang.String videoDuration) The videoDuration parameter filters video search results based on their duration.
YouTube.Search.List	setVideoEmbeddable(java.lang.String videoEmbeddable) The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage.
YouTube.Search.List	setVideoLicense(java.lang.String videoLicense) The videoLicense parameter filters search results to only include videos with a particular license.
YouTube.Search.List	setVideoSyndicated(java.lang.String videoSyndicated) The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com.
YouTube.Search.List	setVideoType(java.lang.String videoType) The videoType parameter lets you restrict a search to a particular type of videos.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

YouTube.Search.List

protected YouTube.Search.List(java.lang.String part)

Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. Create a request for the method "search.list". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

part - The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchListResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchListResponse>

Throws:

java.io.IOException

setAlt

public YouTube.Search.List setAlt(java.lang.String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<SearchListResponse>

setFields

public YouTube.Search.List setFields(java.lang.String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<SearchListResponse>

setKey

public YouTube.Search.List setKey(java.lang.String key)

Description copied from class: YouTubeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class YouTubeRequest<SearchListResponse>

setOauthToken

public YouTube.Search.List setOauthToken(java.lang.String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<SearchListResponse>

setPrettyPrint

public YouTube.Search.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<SearchListResponse>

setQuotaUser

public YouTube.Search.List setQuotaUser(java.lang.String quotaUser)

Description copied from class: YouTubeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class YouTubeRequest<SearchListResponse>

setUserIp

public YouTube.Search.List setUserIp(java.lang.String userIp)

Description copied from class: YouTubeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class YouTubeRequest<SearchListResponse>

getPart

public java.lang.String getPart()

The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

setPart

public YouTube.Search.List setPart(java.lang.String part)

The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include. The part names that you can include in the parameter value are id and snippet. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a search result, the snippet property contains other properties that identify the result's title, description, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

getEventType

public java.lang.String getEventType()

The eventType parameter restricts a search to broadcast events.

setEventType

public YouTube.Search.List setEventType(java.lang.String eventType)

The eventType parameter restricts a search to broadcast events.

getChannelId

public java.lang.String getChannelId()

The channelId parameter indicates that the API response should only contain resources created by the channel

setChannelId

public YouTube.Search.List setChannelId(java.lang.String channelId)

The channelId parameter indicates that the API response should only contain resources created by the channel

getForDeveloper

public java.lang.Boolean getForDeveloper()

The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website. The API server uses the request's authorization credentials to identify the developer. Therefore, a developer can restrict results to videos uploaded through the developer's own app or website but not to videos uploaded through other apps or sites.

setForDeveloper

public YouTube.Search.List setForDeveloper(java.lang.Boolean forDeveloper)

The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website. The API server uses the request's authorization credentials to identify the developer. Therefore, a developer can restrict results to videos uploaded through the developer's own app or website but not to videos uploaded through other apps or sites.

getVideoSyndicated

public java.lang.String getVideoSyndicated()

The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com.

setVideoSyndicated

public YouTube.Search.List setVideoSyndicated(java.lang.String videoSyndicated)

The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com.

getChannelType

public java.lang.String getChannelType()

The channelType parameter lets you restrict a search to a particular type of channel.

setChannelType

public YouTube.Search.List setChannelType(java.lang.String channelType)

The channelType parameter lets you restrict a search to a particular type of channel.

getVideoCaption

public java.lang.String getVideoCaption()

The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions.

setVideoCaption

public YouTube.Search.List setVideoCaption(java.lang.String videoCaption)

The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions.

getPublishedAfter

public com.google.api.client.util.DateTime getPublishedAfter()

The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).

setPublishedAfter

public YouTube.Search.List setPublishedAfter(com.google.api.client.util.DateTime publishedAfter)

The publishedAfter parameter indicates that the API response should only contain resources created after the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).

getOnBehalfOfContentOwner

public java.lang.String getOnBehalfOfContentOwner()

Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

setOnBehalfOfContentOwner

public YouTube.Search.List setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner)

Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.

getPageToken

public java.lang.String getPageToken()

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

setPageToken

public YouTube.Search.List setPageToken(java.lang.String pageToken)

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

getForContentOwner

public java.lang.Boolean getForContentOwner()

Note: This parameter is intended exclusively for YouTube content partners. The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated using a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.

setForContentOwner

public YouTube.Search.List setForContentOwner(java.lang.Boolean forContentOwner)

Note: This parameter is intended exclusively for YouTube content partners. The forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated using a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.

getRegionCode

public java.lang.String getRegionCode()

The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.

setRegionCode

public YouTube.Search.List setRegionCode(java.lang.String regionCode)

The regionCode parameter instructs the API to return search results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code.

getLocation

public java.lang.String getLocation()

The location parameter restricts a search to videos that have a geographical location specified in their metadata. The value is a string that specifies geographic latitude/longitude coordinates e.g. (37.42307,-122.08427)

setLocation

public YouTube.Search.List setLocation(java.lang.String location)

The location parameter restricts a search to videos that have a geographical location specified in their metadata. The value is a string that specifies geographic latitude/longitude coordinates e.g. (37.42307,-122.08427)

getLocationRadius

public java.lang.String getLocationRadius()

The locationRadius, in conjunction with the location parameter, defines a geographic area. If the geographic coordinates associated with a video fall within that area, then the video may be included in search results. This parameter value must be a floating point number followed by a measurement unit. Valid measurement units are m, km, ft, and mi. For example, valid parameter values include 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius parameter values larger than 1000 kilometers.

setLocationRadius

public YouTube.Search.List setLocationRadius(java.lang.String locationRadius)

The locationRadius, in conjunction with the location parameter, defines a geographic area. If the geographic coordinates associated with a video fall within that area, then the video may be included in search results. This parameter value must be a floating point number followed by a measurement unit. Valid measurement units are m, km, ft, and mi. For example, valid parameter values include 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius parameter values larger than 1000 kilometers.

getVideoType

public java.lang.String getVideoType()

The videoType parameter lets you restrict a search to a particular type of videos.

setVideoType

public YouTube.Search.List setVideoType(java.lang.String videoType)

The videoType parameter lets you restrict a search to a particular type of videos.

getType

public java.lang.String getType()

The type parameter restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types. [default: video,channel,playlist]

setType

public YouTube.Search.List setType(java.lang.String type)

The type parameter restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types.

getTopicId

public java.lang.String getTopicId()

The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID.

setTopicId

public YouTube.Search.List setTopicId(java.lang.String topicId)

The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID.

getPublishedBefore

public com.google.api.client.util.DateTime getPublishedBefore()

The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).

setPublishedBefore

public YouTube.Search.List setPublishedBefore(com.google.api.client.util.DateTime publishedBefore)

The publishedBefore parameter indicates that the API response should only contain resources created before the specified time. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).

getVideoDimension

public java.lang.String getVideoDimension()

The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.

setVideoDimension

public YouTube.Search.List setVideoDimension(java.lang.String videoDimension)

The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.

getVideoLicense

public java.lang.String getVideoLicense()

The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos.

setVideoLicense

public YouTube.Search.List setVideoLicense(java.lang.String videoLicense)

The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos.

getMaxResults

public java.lang.Long getMaxResults()

The maxResults parameter specifies the maximum number of items that should be returned in the result set. [default: 5] [minimum: 0] [maximum: 50]

setMaxResults

public YouTube.Search.List setMaxResults(java.lang.Long maxResults)

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

getRelatedToVideoId

public java.lang.String getRelatedToVideoId()

The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video.

setRelatedToVideoId

public YouTube.Search.List setRelatedToVideoId(java.lang.String relatedToVideoId)

The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video.

getVideoDefinition

public java.lang.String getVideoDefinition()

The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available.

setVideoDefinition

public YouTube.Search.List setVideoDefinition(java.lang.String videoDefinition)

The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available.

getVideoDuration

public java.lang.String getVideoDuration()

The videoDuration parameter filters video search results based on their duration.

setVideoDuration

public YouTube.Search.List setVideoDuration(java.lang.String videoDuration)

The videoDuration parameter filters video search results based on their duration.

getRelevanceLanguage

public java.lang.String getRelevanceLanguage()

The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language. The parameter 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. Please note that results in other languages will still be returned if they are highly relevant to the search query term.

setRelevanceLanguage

public YouTube.Search.List setRelevanceLanguage(java.lang.String relevanceLanguage)

The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language. The parameter 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. Please note that results in other languages will still be returned if they are highly relevant to the search query term.

getForMine

public java.lang.Boolean getForMine()

The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. If you set this parameter to true, then the type parameter's value must also be set to video.

setForMine

public YouTube.Search.List setForMine(java.lang.Boolean forMine)

The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. If you set this parameter to true, then the type parameter's value must also be set to video.

getQ

public java.lang.String getQ()

The q parameter specifies the query term to search for.

setQ

public YouTube.Search.List setQ(java.lang.String q)

The q parameter specifies the query term to search for.

getSafeSearch

public java.lang.String getSafeSearch()

The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.

setSafeSearch

public YouTube.Search.List setSafeSearch(java.lang.String safeSearch)

The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.

getVideoEmbeddable

public java.lang.String getVideoEmbeddable()

The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage.

setVideoEmbeddable

public YouTube.Search.List setVideoEmbeddable(java.lang.String videoEmbeddable)

The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage.

getVideoCategoryId

public java.lang.String getVideoCategoryId()

The videoCategoryId parameter filters video search results based on their category.

setVideoCategoryId

public YouTube.Search.List setVideoCategoryId(java.lang.String videoCategoryId)

The videoCategoryId parameter filters video search results based on their category.

getOrder

public java.lang.String getOrder()

The order parameter specifies the method that will be used to order resources in the API response. [default: SEARCH_SORT_RELEVANCE]

setOrder

public YouTube.Search.List setOrder(java.lang.String order)

The order parameter specifies the method that will be used to order resources in the API response.

set

public YouTube.Search.List set(java.lang.String parameterName,
                      java.lang.Object value)

Overrides:

set in class YouTubeRequest<SearchListResponse>