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

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

Go to download

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






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













Skip navigation links
































com.google.api.services.youtube


Class YouTube.PlaylistItems.List



















    

  • 


      

    • 



      Constructor Detail
      




        

      • 

        List
        

        protected List(List<String> part)
        

        Retrieves a list of resources, possibly filtered.

 Create a request for the method "playlistItems.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 playlistItem resource
        properties that the API response will include. If the parameter identifies a property that
        contains child properties, the child properties will be included in the response. For
        example, in a playlistItem resource, the snippet property contains numerous fields,
        including the title, description, position, and resourceId properties. As such, if you set
        *part=snippet*, the API response will contain all of those properties.
        

        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<PlaylistItemListResponse>
        

        Throws:
        

        IOException
        

        

        • 

      




        

      • 

        buildHttpRequestUsingHead
        

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

        

        Overrides:
        

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

        Throws:
        

        IOException
        

        

        • 

      
















































        

      • 

        getPart
        

        public List<String> getPart()
        

        The *part* parameter specifies a comma-separated list of one or more playlistItem resource
     properties that the API response will include. If the parameter identifies a property that contains
     child properties, the child properties will be included in the response. For example, in a
     playlistItem resource, the snippet property contains numerous fields, including the title,
     description, position, and resourceId properties. As such, if you set *part=snippet*, the API
     response will contain all of those properties.
        

        • 

      




        

      • 

        setPart
        

        public YouTube.PlaylistItems.List setPart(List<String> part)
        

        The *part* parameter specifies a comma-separated list of one or more playlistItem resource
 properties that the API response will include. If the parameter identifies a property that
 contains child properties, the child properties will be included in the response. For
 example, in a playlistItem resource, the snippet property contains numerous fields,
 including the title, description, position, and resourceId properties. As such, if you set
 *part=snippet*, the API response will contain all of those properties.
        

        • 

      












        

      • 

        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.PlaylistItems.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.PlaylistItems.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.
        

        • 

      




        

      • 

        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.PlaylistItems.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.
        

        • 

      




        

      • 

        getPlaylistId
        

        public String getPlaylistId()
        

        Return the playlist items within the given playlist.
        

        • 

      








        

      • 

        getVideoId
        

        public String getVideoId()
        

        Return the playlist items associated with the given video ID.
        

        • 

      









      • 

    

    • 













Skip navigation links





























Copyright © 2011–2024 Google. All rights reserved.




© 2015 - 2024 Weber Informatics LLC | Privacy Policy