Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 25fba648ea647b62f2a6edc54ae927c1ed381b45 / . / docs / dyn / youtube_v3.captions.html
blob: fb6ce44532f88c4dcbe64323b1b8aaff8a319ae7 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.captions.html">captions</a></h1>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]84 <code><a href="#download">download(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]85<p class="firstline">Downloads a caption track.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#download_media">download_media(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88<p class="firstline">Downloads a caption track.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90 <code><a href="#insert">insert(part, body=None, sync=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]91<p class="firstline">Inserts a new resource into this collection.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93 <code><a href="#list">list(videoId, part, id=None, onBehalfOfContentOwner=None, onBehalfOf=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]94<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]95<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]96 <code><a href="#update">update(part, body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]97<p class="firstline">Updates an existing resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 <code class="details" id="delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
106 <pre>Deletes a resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]107
108Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]109 id: string, A parameter (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]111 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]113 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 1 - v1 error format
115 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]116</pre>
117</div>
118
119<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 <code class="details" id="download">download(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]121 <pre>Downloads a caption track.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]122
123Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124 id: string, The ID of the caption track to download, required for One Platform. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]125 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
127 tlang: string, tlang is the language code; machine translate the captions into this language.
128 tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]130 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 1 - v1 error format
132 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]133</pre>
134</div>
135
136<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]137 <code class="details" id="download_media">download_media(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 <pre>Downloads a caption track.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]139
140Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 id: string, The ID of the caption track to download, required for One Platform. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]143 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
144 tlang: string, tlang is the language code; machine translate the captions into this language.
145 tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 x__xgafv: string, V1 error format.
147 Allowed values
148 1 - v1 error format
149 2 - v2 error format
150</pre>
151</div>
152
153<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]154 <code class="details" id="insert">insert(part, body=None, sync=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]155 <pre>Inserts a new resource into this collection.
156
157Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]158 part: string, The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. (required) (repeated)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]159 body: object, The request body.
160 The object takes the form of:
161
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
163 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
164 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
165 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
166 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
167 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
168 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible to the user as an option during playback.
169 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update
170 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot; meaning it is at a third-grade level for language learners. The default value is false.
171 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
172 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
173 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This property is only present if the state property&#x27;s value is failed.
174 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
175 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
176 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
177 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
178 },
179 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
180 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
181 }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]182
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]183 sync: boolean, Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]184 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]185 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
191 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]192
193Returns:
194 An object of the form:
195
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]196 { # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
197 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
198 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
199 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
200 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
201 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
202 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible to the user as an option during playback.
203 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update
204 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot; meaning it is at a third-grade level for language learners. The default value is false.
205 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
206 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
207 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This property is only present if the state property&#x27;s value is failed.
208 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
209 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
210 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
211 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
212 },
213 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
214 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
215 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]216</div>
217
218<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]219 <code class="details" id="list">list(videoId, part, id=None, onBehalfOfContentOwner=None, onBehalfOf=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]220 <pre>Retrieves a list of resources, possibly filtered.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]221
222Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]223 videoId: string, Returns the captions for the specified video. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]224 part: string, 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. (required) (repeated)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]225 id: string, Returns the captions with the given IDs for Stubby or Apiary. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]226 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
227 onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]228 x__xgafv: string, V1 error format.
229 Allowed values
230 1 - v1 error format
231 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]232
233Returns:
234 An object of the form:
235
236 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]237 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]238 &quot;kind&quot;: &quot;youtube#captionListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#captionListResponse&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]239 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]240 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
241 &quot;items&quot;: [ # A list of captions that match the request criteria.
242 { # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
243 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
244 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
245 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
246 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
247 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
248 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible to the user as an option during playback.
249 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update
250 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot; meaning it is at a third-grade level for language learners. The default value is false.
251 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
252 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
253 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This property is only present if the state property&#x27;s value is failed.
254 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
255 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
256 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
257 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
258 },
259 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
260 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
261 },
262 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]263 }</pre>
264</div>
265
266<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]267 <code class="details" id="update">update(part, body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]268 <pre>Updates an existing resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]269
270Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]271 part: string, 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. (required) (repeated)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]272 body: object, The request body.
273 The object takes the form of:
274
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]275{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
276 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
277 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
278 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
279 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
280 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
281 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible to the user as an option during playback.
282 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update
283 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot; meaning it is at a third-grade level for language learners. The default value is false.
284 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
285 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
286 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This property is only present if the state property&#x27;s value is failed.
287 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
288 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
289 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
290 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
291 },
292 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
293 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
294 }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]295
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]296 onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]297 sync: boolean, Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
298 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]299 x__xgafv: string, V1 error format.
300 Allowed values
301 1 - v1 error format
302 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]303 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
304 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]305
306Returns:
307 An object of the form:
308
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]309 { # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
310 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
311 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
312 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.
313 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
314 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
315 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible to the user as an option during playback.
316 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. @mutable youtube.captions.insert youtube.captions.update
317 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot; meaning it is at a third-grade level for language learners. The default value is false.
318 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
319 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
320 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This property is only present if the state property&#x27;s value is failed.
321 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
322 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
323 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
324 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
325 },
326 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
327 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
328 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]329</div>
330
331</body></html>