public class YouTube.Search.List extends YouTubeRequest<SearchListResponse>
com.google.api.client.util.GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Modifier | Constructor and Description |
---|---|
protected |
List(String part)
Returns a collection of search results that match the query parameters specified in the API
request.
|
Modifier and Type | Method and Description |
---|---|
com.google.api.client.http.HttpRequest |
buildHttpRequestUsingHead() |
com.google.api.client.http.HttpResponse |
executeUsingHead() |
String |
getChannelId()
The channelId parameter indicates that the API response should only contain resources created by
the channel
|
String |
getChannelType()
The channelType parameter lets you restrict a search to a particular type of channel.
|
String |
getEventType()
The eventType parameter restricts a search to broadcast events.
|
Boolean |
getForContentOwner()
Note: This parameter is intended exclusively for YouTube content partners.
|
Boolean |
getForDeveloper()
The forDeveloper parameter restricts the search to only retrieve videos uploaded via the
developer's application or website.
|
Boolean |
getForMine()
The forMine parameter restricts the search to only retrieve videos owned by the authenticated user.
|
String |
getLocation()
The location parameter, in conjunction with the locationRadius parameter, defines a circular
geographic area and also restricts a search to videos that specify, in their metadata, a geographic
location that falls within that area.
|
String |
getLocationRadius()
The locationRadius parameter, in conjunction with the location parameter, defines a circular
geographic area.
|
Long |
getMaxResults()
The maxResults parameter specifies the maximum number of items that should be returned in the
result set.
|
String |
getOnBehalfOfContentOwner()
Note: This parameter is intended exclusively for YouTube content partners.
|
String |
getOrder()
The order parameter specifies the method that will be used to order resources in the API response.
|
String |
getPageToken()
The pageToken parameter identifies a specific page in the result set that should be returned.
|
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.
|
String |
getQ()
The q parameter specifies the query term to search for.
|
String |
getRegionCode()
The regionCode parameter instructs the API to return search results for the specified country.
|
String |
getRelatedToVideoId()
The relatedToVideoId parameter retrieves a list of videos that are related to the video that the
parameter value identifies.
|
String |
getRelevanceLanguage()
The relevanceLanguage parameter instructs the API to return search results that are most relevant
to the specified language.
|
String |
getSafeSearch()
The safeSearch parameter indicates whether the search results should include restricted content as
well as standard content.
|
String |
getTopicId()
The topicId parameter indicates that the API response should only contain resources associated with
the specified topic.
|
String |
getType()
The type parameter restricts a search query to only retrieve a particular type of resource.
|
String |
getVideoCaption()
The videoCaption parameter indicates whether the API should filter video search results based on
whether they have captions.
|
String |
getVideoCategoryId()
The videoCategoryId parameter filters video search results based on their category.
|
String |
getVideoDefinition()
The videoDefinition parameter lets you restrict a search to only include either high definition
(HD) or standard definition (SD) videos.
|
String |
getVideoDimension()
The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.
|
String |
getVideoDuration()
The videoDuration parameter filters video search results based on their duration.
|
String |
getVideoEmbeddable()
The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded
into a webpage.
|
String |
getVideoLicense()
The videoLicense parameter filters search results to only include videos with a particular license.
|
String |
getVideoSyndicated()
The videoSyndicated parameter lets you to restrict a search to only videos that can be played
outside youtube.com.
|
String |
getVideoType()
The videoType parameter lets you restrict a search to a particular type of videos.
|
YouTube.Search.List |
set(String parameterName,
Object value) |
YouTube.Search.List |
setAlt(String alt)
Data format for the response.
|
YouTube.Search.List |
setChannelId(String channelId)
The channelId parameter indicates that the API response should only contain resources
created by the channel
|
YouTube.Search.List |
setChannelType(String channelType)
The channelType parameter lets you restrict a search to a particular type of channel.
|
YouTube.Search.List |
setEventType(String eventType)
The eventType parameter restricts a search to broadcast events.
|
YouTube.Search.List |
setFields(String fields)
Selector specifying which fields to include in a partial response.
|
YouTube.Search.List |
setForContentOwner(Boolean forContentOwner)
Note: This parameter is intended exclusively for YouTube content partners.
|
YouTube.Search.List |
setForDeveloper(Boolean forDeveloper)
The forDeveloper parameter restricts the search to only retrieve videos uploaded via the
developer's application or website.
|
YouTube.Search.List |
setForMine(Boolean forMine)
The forMine parameter restricts the search to only retrieve videos owned by the
authenticated user.
|
YouTube.Search.List |
setKey(String key)
API key.
|
YouTube.Search.List |
setLocation(String location)
The location parameter, in conjunction with the locationRadius parameter, defines a
circular geographic area and also restricts a search to videos that specify, in their
metadata, a geographic location that falls within that area.
|
YouTube.Search.List |
setLocationRadius(String locationRadius)
The locationRadius parameter, in conjunction with the location parameter, defines a
circular geographic area.
|
YouTube.Search.List |
setMaxResults(Long maxResults)
The maxResults parameter specifies the maximum number of items that should be returned in
the result set.
|
YouTube.Search.List |
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
|
YouTube.Search.List |
setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
Note: This parameter is intended exclusively for YouTube content partners.
|
YouTube.Search.List |
setOrder(String order)
The order parameter specifies the method that will be used to order resources in the API
response.
|
YouTube.Search.List |
setPageToken(String pageToken)
The pageToken parameter identifies a specific page in the result set that should be
returned.
|
YouTube.Search.List |
setPart(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(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(String q)
The q parameter specifies the query term to search for.
|
YouTube.Search.List |
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
|
YouTube.Search.List |
setRegionCode(String regionCode)
The regionCode parameter instructs the API to return search results for the specified
country.
|
YouTube.Search.List |
setRelatedToVideoId(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(String relevanceLanguage)
The relevanceLanguage parameter instructs the API to return search results that are most
relevant to the specified language.
|
YouTube.Search.List |
setSafeSearch(String safeSearch)
The safeSearch parameter indicates whether the search results should include restricted
content as well as standard content.
|
YouTube.Search.List |
setTopicId(String topicId)
The topicId parameter indicates that the API response should only contain resources
associated with the specified topic.
|
YouTube.Search.List |
setType(String type)
The type parameter restricts a search query to only retrieve a particular type of resource.
|
YouTube.Search.List |
setUserIp(String userIp)
Deprecated.
|
YouTube.Search.List |
setVideoCaption(String videoCaption)
The videoCaption parameter indicates whether the API should filter video search results
based on whether they have captions.
|
YouTube.Search.List |
setVideoCategoryId(String videoCategoryId)
The videoCategoryId parameter filters video search results based on their category.
|
YouTube.Search.List |
setVideoDefinition(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(String videoDimension)
The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos.
|
YouTube.Search.List |
setVideoDuration(String videoDuration)
The videoDuration parameter filters video search results based on their duration.
|
YouTube.Search.List |
setVideoEmbeddable(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(String videoLicense)
The videoLicense parameter filters search results to only include videos with a particular
license.
|
YouTube.Search.List |
setVideoSyndicated(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(String videoType)
The videoType parameter lets you restrict a search to a particular type of videos.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders
getJsonContent, newExceptionOnError, queue
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
protected List(String part)
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.
part
- The part parameter specifies a comma-separated list of one or more search resource properties that
the API response will include. Set the parameter value to snippet.public com.google.api.client.http.HttpResponse executeUsingHead() throws IOException
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchListResponse>
IOException
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead() throws IOException
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SearchListResponse>
IOException
public YouTube.Search.List setAlt(String alt)
YouTubeRequest
setAlt
in class YouTubeRequest<SearchListResponse>
public YouTube.Search.List setFields(String fields)
YouTubeRequest
setFields
in class YouTubeRequest<SearchListResponse>
public YouTube.Search.List setKey(String key)
YouTubeRequest
setKey
in class YouTubeRequest<SearchListResponse>
public YouTube.Search.List setOauthToken(String oauthToken)
YouTubeRequest
setOauthToken
in class YouTubeRequest<SearchListResponse>
public YouTube.Search.List setPrettyPrint(Boolean prettyPrint)
YouTubeRequest
setPrettyPrint
in class YouTubeRequest<SearchListResponse>
public YouTube.Search.List setQuotaUser(String quotaUser)
YouTubeRequest
setQuotaUser
in class YouTubeRequest<SearchListResponse>
public YouTube.Search.List setUserIp(String userIp)
YouTubeRequest
setUserIp
in class YouTubeRequest<SearchListResponse>
public String getPart()
public YouTube.Search.List setPart(String part)
public String getChannelId()
public YouTube.Search.List setChannelId(String channelId)
public String getChannelType()
public YouTube.Search.List setChannelType(String channelType)
public String getEventType()
public YouTube.Search.List setEventType(String eventType)
public Boolean getForContentOwner()
public YouTube.Search.List setForContentOwner(Boolean forContentOwner)
public Boolean getForDeveloper()
public YouTube.Search.List setForDeveloper(Boolean forDeveloper)
public Boolean getForMine()
public YouTube.Search.List setForMine(Boolean forMine)
public String getLocation()
public YouTube.Search.List setLocation(String location)
public String getLocationRadius()
public YouTube.Search.List setLocationRadius(String locationRadius)
public Long getMaxResults()
public YouTube.Search.List setMaxResults(Long maxResults)
public String getOnBehalfOfContentOwner()
public YouTube.Search.List setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
public String getOrder()
public YouTube.Search.List setOrder(String order)
public String getPageToken()
public YouTube.Search.List setPageToken(String pageToken)
public com.google.api.client.util.DateTime getPublishedAfter()
public YouTube.Search.List setPublishedAfter(com.google.api.client.util.DateTime publishedAfter)
public com.google.api.client.util.DateTime getPublishedBefore()
public YouTube.Search.List setPublishedBefore(com.google.api.client.util.DateTime publishedBefore)
public String getQ()
public YouTube.Search.List setQ(String q)
public String getRegionCode()
public YouTube.Search.List setRegionCode(String regionCode)
public String getRelatedToVideoId()
public YouTube.Search.List setRelatedToVideoId(String relatedToVideoId)
public String getRelevanceLanguage()
public YouTube.Search.List setRelevanceLanguage(String relevanceLanguage)
public String getSafeSearch()
public YouTube.Search.List setSafeSearch(String safeSearch)
public String getTopicId()
public YouTube.Search.List setTopicId(String topicId)
public String getType()
public YouTube.Search.List setType(String type)
public String getVideoCaption()
public YouTube.Search.List setVideoCaption(String videoCaption)
public String getVideoCategoryId()
public YouTube.Search.List setVideoCategoryId(String videoCategoryId)
public String getVideoDefinition()
public YouTube.Search.List setVideoDefinition(String videoDefinition)
public String getVideoDimension()
public YouTube.Search.List setVideoDimension(String videoDimension)
public String getVideoDuration()
public YouTube.Search.List setVideoDuration(String videoDuration)
public String getVideoEmbeddable()
public YouTube.Search.List setVideoEmbeddable(String videoEmbeddable)
public String getVideoLicense()
public YouTube.Search.List setVideoLicense(String videoLicense)
public String getVideoSyndicated()
public YouTube.Search.List setVideoSyndicated(String videoSyndicated)
public String getVideoType()
public YouTube.Search.List setVideoType(String videoType)
public YouTube.Search.List set(String parameterName, Object value)
set
in class YouTubeRequest<SearchListResponse>
Copyright © 2011–2019 Google. All rights reserved.