YouTube.Search.List (YouTube Data API v3 v3-rev20220320-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,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:

Cloneable, Map<String,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
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(List<String> part)
Retrieves a list of search resources Create a request for the method "search.list".

Constructors
Modifier	Constructor and Description
`protected`	`List(List<String> part)` Retrieves a list of search resources Create a request for the method "search.list".

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getChannelId()` Filter on resources belonging to this channelId.
`String`	`getChannelType()` Add a filter on the channel search.
`String`	`getEventType()` Filter on the livestream status of the videos.
`Boolean`	`getForContentOwner()` Search owned by a content owner.
`Boolean`	`getForDeveloper()` Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
`Boolean`	`getForMine()` Search for the private videos of the authenticated user.
`String`	`getLocation()` Filter on location of the video
`String`	`getLocationRadius()` Filter on distance from the location (specified above).
`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()` Sort order of the results.
`String`	`getPageToken()` The pageToken parameter identifies a specific page in the result set that should be returned.
`List<String>`	`getPart()` The part parameter specifies a comma-separated list of one or more search resource properties that the API response will include.
`String`	`getPublishedAfter()` Filter on resources published after this date.
`String`	`getPublishedBefore()` Filter on resources published before this date.
`String`	`getQ()` Textual search terms to match.
`String`	`getRegionCode()` Display the content as seen by viewers in this country.
`String`	`getRelatedToVideoId()` Search related to a resource.
`String`	`getRelevanceLanguage()` Return results relevant to this language.
`String`	`getSafeSearch()` Indicates whether the search results should include restricted content as well as standard content.
`String`	`getTopicId()` Restrict results to a particular topic.
`List<String>`	`getType()` Restrict results to a particular set of resource types from One Platform.
`String`	`getVideoCaption()` Filter on the presence of captions on the videos.
`String`	`getVideoCategoryId()` Filter on videos in a specific category.
`String`	`getVideoDefinition()` Filter on the definition of the videos.
`String`	`getVideoDimension()` Filter on 3d videos.
`String`	`getVideoDuration()` Filter on the duration of the videos.
`String`	`getVideoEmbeddable()` Filter on embeddable videos.
`String`	`getVideoLicense()` Filter on the license of the videos.
`String`	`getVideoSyndicated()` Filter on syndicated videos.
`String`	`getVideoType()` Filter on videos of a specific type.
`YouTube.Search.List`	`set(String parameterName, Object value)`
`YouTube.Search.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`YouTube.Search.List`	`setAccessToken(String accessToken)` OAuth access token.
`YouTube.Search.List`	`setAlt(String alt)` Data format for response.
`YouTube.Search.List`	`setCallback(String callback)` JSONP
`YouTube.Search.List`	`setChannelId(String channelId)` Filter on resources belonging to this channelId.
`YouTube.Search.List`	`setChannelType(String channelType)` Add a filter on the channel search.
`YouTube.Search.List`	`setEventType(String eventType)` Filter on the livestream status of the videos.
`YouTube.Search.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`YouTube.Search.List`	`setForContentOwner(Boolean forContentOwner)` Search owned by a content owner.
`YouTube.Search.List`	`setForDeveloper(Boolean forDeveloper)` Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
`YouTube.Search.List`	`setForMine(Boolean forMine)` Search for the private videos of the authenticated user.
`YouTube.Search.List`	`setKey(String key)` API key.
`YouTube.Search.List`	`setLocation(String location)` Filter on location of the video
`YouTube.Search.List`	`setLocationRadius(String locationRadius)` Filter on distance from the location (specified above).
`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)` Sort order of the results.
`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(List<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(String publishedAfter)` Filter on resources published after this date.
`YouTube.Search.List`	`setPublishedBefore(String publishedBefore)` Filter on resources published before this date.
`YouTube.Search.List`	`setQ(String q)` Textual search terms to match.
`YouTube.Search.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`YouTube.Search.List`	`setRegionCode(String regionCode)` Display the content as seen by viewers in this country.
`YouTube.Search.List`	`setRelatedToVideoId(String relatedToVideoId)` Search related to a resource.
`YouTube.Search.List`	`setRelevanceLanguage(String relevanceLanguage)` Return results relevant to this language.
`YouTube.Search.List`	`setSafeSearch(String safeSearch)` Indicates whether the search results should include restricted content as well as standard content.
`YouTube.Search.List`	`setTopicId(String topicId)` Restrict results to a particular topic.
`YouTube.Search.List`	`setType(List<String> type)` Restrict results to a particular set of resource types from One Platform.
`YouTube.Search.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`YouTube.Search.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`YouTube.Search.List`	`setVideoCaption(String videoCaption)` Filter on the presence of captions on the videos.
`YouTube.Search.List`	`setVideoCategoryId(String videoCategoryId)` Filter on videos in a specific category.
`YouTube.Search.List`	`setVideoDefinition(String videoDefinition)` Filter on the definition of the videos.
`YouTube.Search.List`	`setVideoDimension(String videoDimension)` Filter on 3d videos.
`YouTube.Search.List`	`setVideoDuration(String videoDuration)` Filter on the duration of the videos.
`YouTube.Search.List`	`setVideoEmbeddable(String videoEmbeddable)` Filter on embeddable videos.
`YouTube.Search.List`	`setVideoLicense(String videoLicense)` Filter on the license of the videos.
`YouTube.Search.List`	`setVideoSyndicated(String videoSyndicated)` Filter on syndicated videos.
`YouTube.Search.List`	`setVideoType(String videoType)` Filter on videos of a specific type.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(List<String> part)
```
    Retrieves a list of search resources 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. Set the parameter value to snippet.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<SearchListResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<SearchListResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public YouTube.Search.List set$Xgafv(String $Xgafv)
```
    Description copied from class: YouTubeRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class YouTubeRequest<SearchListResponse>
  - setAccessToken
```
public YouTube.Search.List setAccessToken(String accessToken)
```
    Description copied from class: YouTubeRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class YouTubeRequest<SearchListResponse>
  - setAlt
```
public YouTube.Search.List setAlt(String alt)
```
    Description copied from class: YouTubeRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class YouTubeRequest<SearchListResponse>
  - setCallback
```
public YouTube.Search.List setCallback(String callback)
```
    Description copied from class: YouTubeRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class YouTubeRequest<SearchListResponse>
  - setFields
```
public YouTube.Search.List setFields(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(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(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(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(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:
    
    setQuotaUser in class YouTubeRequest<SearchListResponse>
  - setUploadType
```
public YouTube.Search.List setUploadType(String uploadType)
```
    Description copied from class: YouTubeRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class YouTubeRequest<SearchListResponse>
  - setUploadProtocol
```
public YouTube.Search.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: YouTubeRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class YouTubeRequest<SearchListResponse>
  - getPart
```
public List<String> getPart()
```
    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.
  - setPart
```
public YouTube.Search.List setPart(List<String> 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.
  - getChannelId
```
public String getChannelId()
```
    Filter on resources belonging to this channelId.
  - setChannelId
```
public YouTube.Search.List setChannelId(String channelId)
```
    Filter on resources belonging to this channelId.
  - getChannelType
```
public String getChannelType()
```
    Add a filter on the channel search.
  - setChannelType
```
public YouTube.Search.List setChannelType(String channelType)
```
    Add a filter on the channel search.
  - getEventType
```
public String getEventType()
```
    Filter on the livestream status of the videos.
  - setEventType
```
public YouTube.Search.List setEventType(String eventType)
```
    Filter on the livestream status of the videos.
  - getForContentOwner
```
public Boolean getForContentOwner()
```
    Search owned by a content owner.
  - setForContentOwner
```
public YouTube.Search.List setForContentOwner(Boolean forContentOwner)
```
    Search owned by a content owner.
  - getForDeveloper
```
public Boolean getForDeveloper()
```
    Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
  - setForDeveloper
```
public YouTube.Search.List setForDeveloper(Boolean forDeveloper)
```
    Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
  - getForMine
```
public Boolean getForMine()
```
    Search for the private videos of the authenticated user.
  - setForMine
```
public YouTube.Search.List setForMine(Boolean forMine)
```
    Search for the private videos of the authenticated user.
  - getLocation
```
public String getLocation()
```
    Filter on location of the video
  - setLocation
```
public YouTube.Search.List setLocation(String location)
```
    Filter on location of the video
  - getLocationRadius
```
public String getLocationRadius()
```
    Filter on distance from the location (specified above).
  - setLocationRadius
```
public YouTube.Search.List setLocationRadius(String locationRadius)
```
    Filter on distance from the location (specified above).
  - getMaxResults
```
public 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(Long maxResults)
```
    The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
  - getOnBehalfOfContentOwner
```
public 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(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.
  - getOrder
```
public String getOrder()
```
    Sort order of the results. [default: relevance]
  - setOrder
```
public YouTube.Search.List setOrder(String order)
```
    Sort order of the results.
  - getPageToken
```
public 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(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.
  - getPublishedAfter
```
public String getPublishedAfter()
```
    Filter on resources published after this date.
  - setPublishedAfter
```
public YouTube.Search.List setPublishedAfter(String publishedAfter)
```
    Filter on resources published after this date.
  - getPublishedBefore
```
public String getPublishedBefore()
```
    Filter on resources published before this date.
  - setPublishedBefore
```
public YouTube.Search.List setPublishedBefore(String publishedBefore)
```
    Filter on resources published before this date.
  - getQ
```
public String getQ()
```
    Textual search terms to match.
  - setQ
```
public YouTube.Search.List setQ(String q)
```
    Textual search terms to match.
  - getRegionCode
```
public String getRegionCode()
```
    Display the content as seen by viewers in this country.
  - setRegionCode
```
public YouTube.Search.List setRegionCode(String regionCode)
```
    Display the content as seen by viewers in this country.
  - getRelatedToVideoId
```
public String getRelatedToVideoId()
```
    Search related to a resource.
  - setRelatedToVideoId
```
public YouTube.Search.List setRelatedToVideoId(String relatedToVideoId)
```
    Search related to a resource.
  - getRelevanceLanguage
```
public String getRelevanceLanguage()
```
    Return results relevant to this language.
  - setRelevanceLanguage
```
public YouTube.Search.List setRelevanceLanguage(String relevanceLanguage)
```
    Return results relevant to this language.
  - getSafeSearch
```
public String getSafeSearch()
```
    Indicates whether the search results should include restricted content as well as standard content. [default: moderate]
  - setSafeSearch
```
public YouTube.Search.List setSafeSearch(String safeSearch)
```
    Indicates whether the search results should include restricted content as well as standard content.
  - getTopicId
```
public String getTopicId()
```
    Restrict results to a particular topic.
  - setTopicId
```
public YouTube.Search.List setTopicId(String topicId)
```
    Restrict results to a particular topic.
  - getType
```
public List<String> getType()
```
    Restrict results to a particular set of resource types from One Platform.
  - setType
```
public YouTube.Search.List setType(List<String> type)
```
    Restrict results to a particular set of resource types from One Platform.
  - getVideoCaption
```
public String getVideoCaption()
```
    Filter on the presence of captions on the videos.
  - setVideoCaption
```
public YouTube.Search.List setVideoCaption(String videoCaption)
```
    Filter on the presence of captions on the videos.
  - getVideoCategoryId
```
public String getVideoCategoryId()
```
    Filter on videos in a specific category.
  - setVideoCategoryId
```
public YouTube.Search.List setVideoCategoryId(String videoCategoryId)
```
    Filter on videos in a specific category.
  - getVideoDefinition
```
public String getVideoDefinition()
```
    Filter on the definition of the videos.
  - setVideoDefinition
```
public YouTube.Search.List setVideoDefinition(String videoDefinition)
```
    Filter on the definition of the videos.
  - getVideoDimension
```
public String getVideoDimension()
```
    Filter on 3d videos.
  - setVideoDimension
```
public YouTube.Search.List setVideoDimension(String videoDimension)
```
    Filter on 3d videos.
  - getVideoDuration
```
public String getVideoDuration()
```
    Filter on the duration of the videos.
  - setVideoDuration
```
public YouTube.Search.List setVideoDuration(String videoDuration)
```
    Filter on the duration of the videos.
  - getVideoEmbeddable
```
public String getVideoEmbeddable()
```
    Filter on embeddable videos.
  - setVideoEmbeddable
```
public YouTube.Search.List setVideoEmbeddable(String videoEmbeddable)
```
    Filter on embeddable videos.
  - getVideoLicense
```
public String getVideoLicense()
```
    Filter on the license of the videos.
  - setVideoLicense
```
public YouTube.Search.List setVideoLicense(String videoLicense)
```
    Filter on the license of the videos.
  - getVideoSyndicated
```
public String getVideoSyndicated()
```
    Filter on syndicated videos.
  - setVideoSyndicated
```
public YouTube.Search.List setVideoSyndicated(String videoSyndicated)
```
    Filter on syndicated videos.
  - getVideoType
```
public String getVideoType()
```
    Filter on videos of a specific type.
  - setVideoType
```
public YouTube.Search.List setVideoType(String videoType)
```
    Filter on videos of a specific type.
  - set
```
public YouTube.Search.List set(String parameterName,
                               Object value)
```
    Overrides:
    
    set in class YouTubeRequest<SearchListResponse>

Class YouTube.Search.List

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getPart

setPart

getChannelId

setChannelId

getChannelType

setChannelType

getEventType

setEventType

getForContentOwner

setForContentOwner

getForDeveloper

setForDeveloper

getForMine

setForMine

getLocation

setLocation

getLocationRadius

setLocationRadius

getMaxResults

setMaxResults

getOnBehalfOfContentOwner

setOnBehalfOfContentOwner

getOrder

setOrder

getPageToken

setPageToken

getPublishedAfter

setPublishedAfter

getPublishedBefore

setPublishedBefore

getQ

setQ

getRegionCode

setRegionCode

getRelatedToVideoId

setRelatedToVideoId

getRelevanceLanguage

setRelevanceLanguage

getSafeSearch

setSafeSearch

getTopicId

setTopicId

getType

setType

getVideoCaption

setVideoCaption

getVideoCategoryId

setVideoCategoryId