• Home
• com.google.apis
• google-api-services-youtube
• v3-rev20240303-2.0.0
• source code
• YouTube.Captions.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.Captions.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.Captions.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<CaptionListResponse>


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

















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


Enclosing class:
YouTube.Captions




public class YouTube.Captions.List
extends YouTubeRequest<CaptionListResponse>











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,
    String videoId)
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() 


List<String>
getId()
Returns the captions with the given IDs for Stubby or Apiary.



String
getOnBehalfOf()
ID of the Google+ Page for the channel that the request is on behalf of.



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



List<String>
getPart()
The *part* parameter specifies a comma-separated list of one or more caption resource parts that
     the API response will include.



String
getVideoId()
Returns the captions for the specified video.



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


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



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



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



YouTube.Captions.List
setCallback(String callback)
JSONP



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



YouTube.Captions.List
setId(List<String> id)
Returns the captions with the given IDs for Stubby or Apiary.



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



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



YouTube.Captions.List
setOnBehalfOf(String onBehalfOf)
ID of the Google+ Page for the channel that the request is on behalf of.



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



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



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



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



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



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



YouTube.Captions.List
setVideoId(String videoId)
Returns the captions for the specified video.







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,
               String videoId)
Retrieves a list of resources, possibly filtered.

 Create a request for the method "captions.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 caption resource parts that the
        API response will include. The part names that you can include in the parameter value are
        id and snippet.
videoId - Returns the captions for the specified video.
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<CaptionListResponse>
Throws:
IOException








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

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








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

Overrides:
set$Xgafv in class YouTubeRequest<CaptionListResponse>








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

Overrides:
setAccessToken in class YouTubeRequest<CaptionListResponse>








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

Overrides:
setAlt in class YouTubeRequest<CaptionListResponse>








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

Overrides:
setCallback in class YouTubeRequest<CaptionListResponse>








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

Overrides:
setFields in class YouTubeRequest<CaptionListResponse>








setKey
public YouTube.Captions.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<CaptionListResponse>








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

Overrides:
setOauthToken in class YouTubeRequest<CaptionListResponse>








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

Overrides:
setPrettyPrint in class YouTubeRequest<CaptionListResponse>








setQuotaUser
public YouTube.Captions.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<CaptionListResponse>








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

Overrides:
setUploadType in class YouTubeRequest<CaptionListResponse>








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

Overrides:
setUploadProtocol in class YouTubeRequest<CaptionListResponse>








getPart
public List<String> getPart()
The *part* parameter specifies a comma-separated list of one or more caption resource parts that
     the API response will include. The part names that you can include in the parameter value are id
     and snippet.







setPart
public YouTube.Captions.List setPart(List<String> part)
The *part* parameter specifies a comma-separated list of one or more caption resource parts
 that the API response will include. The part names that you can include in the parameter
 value are id and snippet.







getVideoId
public String getVideoId()
Returns the captions for the specified video.







setVideoId
public YouTube.Captions.List setVideoId(String videoId)
Returns the captions for the specified video.







getId
public List<String> getId()
Returns the captions with the given IDs for Stubby or Apiary.







setId
public YouTube.Captions.List setId(List<String> id)
Returns the captions with the given IDs for Stubby or Apiary.







getOnBehalfOf
public String getOnBehalfOf()
ID of the Google+ Page for the channel that the request is on behalf of.







setOnBehalfOf
public YouTube.Captions.List setOnBehalfOf(String onBehalfOf)
ID of the Google+ Page for the channel that the request is on behalf of.







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 actual CMS account that the user authenticates with must be linked to the specified YouTube
 content owner.







setOnBehalfOfContentOwner
public YouTube.Captions.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 actual CMS account that the user authenticates
 with must be linked to the specified YouTube content owner.







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

Overrides:
set in class YouTubeRequest<CaptionListResponse>














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.