All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.youtube.YouTube.Search.List.html Maven / Gradle / Ivy

Go to download

There is a newer version: v3-rev20240514-2.0.0
Show newest version






YouTube.Search.List (YouTube Data API v3 v3-rev20240417-2.0.0)













Skip navigation links
































com.google.api.services.youtube


Class YouTube.Search.List



















    

  • 


      

    • 



      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 com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
        

        

        Overrides:
        

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

        Throws:
        

        IOException
        

        

        • 

      




        

      • 

        buildHttpRequestUsingHead
        

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

        

        Overrides:
        

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

        Throws:
        

        IOException
        

        

        • 

      
















































        

      • 

        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.
        

        • 

      








        

      • 

        getChannelType
        

        public String getChannelType()
        

        Add a filter on the channel search.
        

        • 

      








        

      • 

        getEventType
        

        public String getEventType()
        

        Filter on the livestream status of the videos.
        

        • 

      








        

      • 

        getForContentOwner
        

        public Boolean getForContentOwner()
        

        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.
        

        • 

      








        

      • 

        getLocation
        

        public String getLocation()
        

        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]
        

        • 

      








        

      • 

        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.
        

        • 

      








        

      • 

        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.
        

        • 

      




        

      • 

        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.
        

        • 

      








        

      • 

        getType
        

        public List<String> getType()
        

        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.
        

        • 

      








        

      • 

        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.
        

        • 

      








        

      • 

        getVideoLicense
        

        public String getVideoLicense()
        

        Filter on the license of the videos.
        

        • 

      








        

      • 

        getVideoPaidProductPlacement
        

        public String getVideoPaidProductPlacement()
        

        • 

      








        

      • 

        getVideoSyndicated
        

        public String getVideoSyndicated()
        

        Filter on syndicated videos.
        

        • 

      








        

      • 

        getVideoType
        

        public String getVideoType()
        

        Filter on videos of a specific type.
        

        • 

      









      • 

    

    • 













Skip navigation links





























Copyright © 2011–2024 Google. All rights reserved.




© 2015 - 2024 Weber Informatics LLC | Privacy Policy