• Home
• com.google.apis
• google-api-services-youtube
• v3-rev20240417-2.0.0
• source code
• YouTube.Videos.List.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.youtube
Class YouTube.Videos.List



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


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

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
YouTube.Videos




public class YouTube.Videos.List
extends YouTubeRequest<VideoListResponse>











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
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 resources, possibly filtered.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead() 


com.google.api.client.http.HttpResponse
executeUsingHead() 


String
getChart()
Return the videos that are in the specified chart.



String
getHl()
Stands for "host language".



List<String>
getId()
Return videos with the given ids.



String
getLocale() 


Integer
getMaxHeight()
[minimum: 72] [maximum: 8192]



Long
getMaxResults()
The *maxResults* parameter specifies the maximum number of items that should be returned in the
     result set.



Integer
getMaxWidth()
Return the player with maximum height specified in

     [minimum: 72] [maximum: 8192]



String
getMyRating()
Return videos liked/disliked by the authenticated user.



String
getOnBehalfOfContentOwner()
Note:* This parameter is intended exclusively for YouTube content partners.



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 video resource properties that
     the API response will include.



String
getRegionCode()
Use a chart that is specific to the specified region



String
getVideoCategoryId()
Use chart that is specific to the specified video category [default: 0]



YouTube.Videos.List
set(String parameterName,
   Object value) 


YouTube.Videos.List
set$Xgafv(String $Xgafv)
V1 error format.



YouTube.Videos.List
setAccessToken(String accessToken)
OAuth access token.



YouTube.Videos.List
setAlt(String alt)
Data format for response.



YouTube.Videos.List
setCallback(String callback)
JSONP



YouTube.Videos.List
setChart(String chart)
Return the videos that are in the specified chart.



YouTube.Videos.List
setFields(String fields)
Selector specifying which fields to include in a partial response.



YouTube.Videos.List
setHl(String hl)
Stands for "host language".



YouTube.Videos.List
setId(List<String> id)
Return videos with the given ids.



YouTube.Videos.List
setKey(String key)
API key.



YouTube.Videos.List
setLocale(String locale) 


YouTube.Videos.List
setMaxHeight(Integer maxHeight) 


YouTube.Videos.List
setMaxResults(Long maxResults)
The *maxResults* parameter specifies the maximum number of items that should be returned in
 the result set.



YouTube.Videos.List
setMaxWidth(Integer maxWidth)
Return the player with maximum height specified in



YouTube.Videos.List
setMyRating(String myRating)
Return videos liked/disliked by the authenticated user.



YouTube.Videos.List
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



YouTube.Videos.List
setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
*Note:* This parameter is intended exclusively for YouTube content partners.



YouTube.Videos.List
setPageToken(String pageToken)
The *pageToken* parameter identifies a specific page in the result set that should be
 returned.



YouTube.Videos.List
setPart(List<String> part)
The *part* parameter specifies a comma-separated list of one or more video resource
 properties that the API response will include.



YouTube.Videos.List
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



YouTube.Videos.List
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



YouTube.Videos.List
setRegionCode(String regionCode)
Use a chart that is specific to the specified region



YouTube.Videos.List
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



YouTube.Videos.List
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.



YouTube.Videos.List
setVideoCategoryId(String videoCategoryId)
Use chart that is specific to the specified video category







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.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





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 resources, possibly filtered.

 Create a request for the method "videos.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 video 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 video
        resource, the snippet property contains the channelId, title, description, tags, and
        categoryId 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<VideoListResponse>
Throws:
IOException








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

Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<VideoListResponse>
Throws:
IOException








set$Xgafv
public YouTube.Videos.List set$Xgafv(String $Xgafv)
Description copied from class: YouTubeRequest
V1 error format.

Overrides:
set$Xgafv in class YouTubeRequest<VideoListResponse>








setAccessToken
public YouTube.Videos.List setAccessToken(String accessToken)
Description copied from class: YouTubeRequest
OAuth access token.

Overrides:
setAccessToken in class YouTubeRequest<VideoListResponse>








setAlt
public YouTube.Videos.List setAlt(String alt)
Description copied from class: YouTubeRequest
Data format for response.

Overrides:
setAlt in class YouTubeRequest<VideoListResponse>








setCallback
public YouTube.Videos.List setCallback(String callback)
Description copied from class: YouTubeRequest
JSONP

Overrides:
setCallback in class YouTubeRequest<VideoListResponse>








setFields
public YouTube.Videos.List setFields(String fields)
Description copied from class: YouTubeRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class YouTubeRequest<VideoListResponse>








setKey
public YouTube.Videos.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<VideoListResponse>








setOauthToken
public YouTube.Videos.List setOauthToken(String oauthToken)
Description copied from class: YouTubeRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class YouTubeRequest<VideoListResponse>








setPrettyPrint
public YouTube.Videos.List setPrettyPrint(Boolean prettyPrint)
Description copied from class: YouTubeRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class YouTubeRequest<VideoListResponse>








setQuotaUser
public YouTube.Videos.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<VideoListResponse>








setUploadType
public YouTube.Videos.List setUploadType(String uploadType)
Description copied from class: YouTubeRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class YouTubeRequest<VideoListResponse>








setUploadProtocol
public YouTube.Videos.List setUploadProtocol(String uploadProtocol)
Description copied from class: YouTubeRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class YouTubeRequest<VideoListResponse>








getPart
public List<String> getPart()
The *part* parameter specifies a comma-separated list of one or more video 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 video
     resource, the snippet property contains the channelId, title, description, tags, and categoryId
     properties. As such, if you set *part=snippet*, the API response will contain all of those
     properties.







setPart
public YouTube.Videos.List setPart(List<String> part)
The *part* parameter specifies a comma-separated list of one or more video 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 video resource, the snippet property contains the channelId, title,
 description, tags, and categoryId properties. As such, if you set *part=snippet*, the API
 response will contain all of those properties.







getChart
public String getChart()
Return the videos that are in the specified chart.







setChart
public YouTube.Videos.List setChart(String chart)
Return the videos that are in the specified chart.







getHl
public String getHl()
Stands for "host language". Specifies the localization language of the metadata to be filled into
     snippet.localized. The field is filled with the default metadata if there is no localization in the
     specified language. The parameter value must be a language code included in the list returned by
     the i18nLanguages.list method (e.g. en_US, es_MX).







setHl
public YouTube.Videos.List setHl(String hl)
Stands for "host language". Specifies the localization language of the metadata to be
 filled into snippet.localized. The field is filled with the default metadata if there is no
 localization in the specified language. The parameter value must be a language code
 included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).







getId
public List<String> getId()
Return videos with the given ids.







setId
public YouTube.Videos.List setId(List<String> id)
Return videos with the given ids.







getLocale
public String getLocale()







setLocale
public YouTube.Videos.List setLocale(String locale)







getMaxHeight
public Integer getMaxHeight()
[minimum: 72] [maximum: 8192]







setMaxHeight
public YouTube.Videos.List setMaxHeight(Integer maxHeight)







getMaxResults
public Long getMaxResults()
The *maxResults* parameter specifies the maximum number of items that should be returned in the
     result set. *Note:* This parameter is supported for use in conjunction with the myRating and chart
     parameters, but it is not supported for use in conjunction with the id parameter. [default: 5]
     [minimum: 1] [maximum: 50]







setMaxResults
public YouTube.Videos.List setMaxResults(Long maxResults)
The *maxResults* parameter specifies the maximum number of items that should be returned in
 the result set. *Note:* This parameter is supported for use in conjunction with the
 myRating and chart parameters, but it is not supported for use in conjunction with the id
 parameter.







getMaxWidth
public Integer getMaxWidth()
Return the player with maximum height specified in

     [minimum: 72] [maximum: 8192]







setMaxWidth
public YouTube.Videos.List setMaxWidth(Integer maxWidth)
Return the player with maximum height specified in







getMyRating
public String getMyRating()
Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE.







setMyRating
public YouTube.Videos.List setMyRating(String myRating)
Return videos liked/disliked by the authenticated user. Does not support
 RateType.RATED_TYPE_NONE.







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.Videos.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. *Note:* This parameter is supported for use in conjunction with the myRating and chart
     parameters, but it is not supported for use in conjunction with the id parameter.







setPageToken
public YouTube.Videos.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. *Note:* This parameter is supported for use in conjunction
 with the myRating and chart parameters, but it is not supported for use in conjunction with
 the id parameter.







getRegionCode
public String getRegionCode()
Use a chart that is specific to the specified region







setRegionCode
public YouTube.Videos.List setRegionCode(String regionCode)
Use a chart that is specific to the specified region







getVideoCategoryId
public String getVideoCategoryId()
Use chart that is specific to the specified video category [default: 0]







setVideoCategoryId
public YouTube.Videos.List setVideoCategoryId(String videoCategoryId)
Use chart that is specific to the specified video category







set
public YouTube.Videos.List set(String parameterName,
                               Object value)

Overrides:
set in class YouTubeRequest<VideoListResponse>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.