Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / youtube_v3.captions.html
blob: 51184357e74e94935da52af565aae3bc7c61e519 [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]78 <code><a href="#delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#download">download(id, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Downloads a caption track.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#download_media">download_media(id, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Downloads a caption track.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#insert">insert(part, body=None, sync=None, onBehalfOfContentOwner=None, onBehalfOf=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
88<p class="firstline">Inserts a new resource into this collection.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code><a href="#list">list(videoId, part, onBehalfOf=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]93 <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOf=None, sync=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
94<p class="firstline">Updates an existing resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]97 <code class="details" id="delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
98 <pre>Deletes a resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]99
100Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]101 id: string, A parameter (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]102 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
104content partners.&lt;br&gt;&lt;br&gt;The
105&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
106that the request&#x27;s authorization credentials identify a YouTube CMS user
107who is acting on behalf of the content owner specified in the parameter
108value. This parameter is intended for YouTube content partners that own and
109manage many different YouTube channels. It allows content owners to
110authenticate once and get access to all their video and channel data,
111without having to provide authentication credentials for each individual
112channel. The actual CMS account that the user authenticates with must be
113linked to the specified YouTube content owner.
114 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]115 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116 1 - v1 error format
117 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]118</pre>
119</div>
120
121<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]122 <code class="details" id="download">download(id, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</code>
123 <pre>Downloads a caption track.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]124
125Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 id: string, The ID of the caption track to download, required for One Platform. (required)
127 tlang: string, tlang is the language code; machine translate the captions into
128this language.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]129 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]130 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
131content partners.&lt;br&gt;&lt;br&gt;The
132&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
133that the request&#x27;s authorization credentials identify a YouTube CMS user
134who is acting on behalf of the content owner specified in the parameter
135value. This parameter is intended for YouTube content partners that own and
136manage many different YouTube channels. It allows content owners to
137authenticate once and get access to all their video and channel data,
138without having to provide authentication credentials for each individual
139channel. The actual CMS account that the user authenticates with must be
140linked to the specified YouTube content owner.
141 tfmt: string, Convert the captions into this format. Supported options are
142sbv, srt, and vtt.
143 x__xgafv: string, V1 error format.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]144 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]145 1 - v1 error format
146 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]147</pre>
148</div>
149
150<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 <code class="details" id="download_media">download_media(id, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</code>
152 <pre>Downloads a caption track.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]153
154Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]155 id: string, The ID of the caption track to download, required for One Platform. (required)
156 tlang: string, tlang is the language code; machine translate the captions into
157this language.
158 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
159 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
160content partners.&lt;br&gt;&lt;br&gt;The
161&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
162that the request&#x27;s authorization credentials identify a YouTube CMS user
163who is acting on behalf of the content owner specified in the parameter
164value. This parameter is intended for YouTube content partners that own and
165manage many different YouTube channels. It allows content owners to
166authenticate once and get access to all their video and channel data,
167without having to provide authentication credentials for each individual
168channel. The actual CMS account that the user authenticates with must be
169linked to the specified YouTube content owner.
170 tfmt: string, Convert the captions into this format. Supported options are
171sbv, srt, and vtt.
172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
176</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="insert">insert(part, body=None, sync=None, onBehalfOfContentOwner=None, onBehalfOf=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
181 <pre>Inserts a new resource into this collection.
182
183Args:
184 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies the
185&lt;code&gt;caption&lt;/code&gt; resource parts that the API response will include. Set
186the parameter value to &lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]187 body: object, The request body.
188 The object takes the form of:
189
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]190{ # A &lt;code&gt;&lt;strong&gt;caption&lt;/strong&gt;&lt;/code&gt; resource represents a YouTube
191 # caption track. A caption track is associated with exactly one YouTube
192 # video.
193 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the caption.
194 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio
195 # track in the video. The value will be &lt;code&gt;true&lt;/code&gt; if a sync was
196 # explicitly requested when the caption track was uploaded. For example,
197 # when calling the &lt;code&gt;captions.insert&lt;/code&gt; or
198 # &lt;code&gt;captions.update&lt;/code&gt; methods, you can set the &lt;code&gt;sync&lt;/code&gt;
199 # parameter to &lt;code&gt;true&lt;/code&gt; to instruct YouTube to sync the uploaded
200 # track to the video. If the value is &lt;code&gt;false&lt;/code&gt;, YouTube uses
201 # the time codes in the uploaded caption track to determine when to display
202 # captions.
203 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This
204 # property is only present if the &lt;code&gt;&lt;a href=&quot;#state&quot;&gt;state&lt;/a&gt;&lt;/code&gt;
205 # property&#x27;s value is &lt;code&gt;failed&lt;/code&gt;.
206 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
207 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf
208 # and hard of hearing. The default value is &lt;code&gt;false&lt;/code&gt;.
209 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a
210 # &lt;a href=&quot;http://www.rfc-editor.org/rfc/bcp/bcp47.txt&quot;&gt;BCP-47&lt;/a&gt;
211 # language tag.
212 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
213 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot;
214 # meaning it is at a third-grade level for language learners.
215 # The default value is &lt;code&gt;false&lt;/code&gt;.
216 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is
217 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
218 # format.
219 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible
220 # to the user as an option during playback.
221 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the
222 # vision-impaired. The default value is &lt;code&gt;false&lt;/code&gt;.
223 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
224 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is
225 # &lt;code&gt;true&lt;/code&gt;, then the track is not publicly visible.
226 # The default value is &lt;code&gt;false&lt;/code&gt;.
227 # @mutable youtube.captions.insert youtube.captions.update
228 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated
229 # with the caption track.
230 # @mutable youtube.captions.insert
231 },
232 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
233 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string
234 # &lt;code&gt;&quot;youtube#caption&quot;&lt;/code&gt;.
235 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
236}
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]237
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]238 sync: boolean, Extra parameter to allow automatically syncing the uploaded
239caption/transcript with the audio.
240 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
241content partners.&lt;br&gt;&lt;br&gt;The
242&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
243that the request&#x27;s authorization credentials identify a YouTube CMS user
244who is acting on behalf of the content owner specified in the parameter
245value. This parameter is intended for YouTube content partners that own and
246manage many different YouTube channels. It allows content owners to
247authenticate once and get access to all their video and channel data,
248without having to provide authentication credentials for each individual
249channel. The actual CMS account that the user authenticates with must be
250linked to the specified YouTube content owner.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]251 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
257 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]258
259Returns:
260 An object of the form:
261
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]262 { # A &lt;code&gt;&lt;strong&gt;caption&lt;/strong&gt;&lt;/code&gt; resource represents a YouTube
263 # caption track. A caption track is associated with exactly one YouTube
264 # video.
265 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the caption.
266 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio
267 # track in the video. The value will be &lt;code&gt;true&lt;/code&gt; if a sync was
268 # explicitly requested when the caption track was uploaded. For example,
269 # when calling the &lt;code&gt;captions.insert&lt;/code&gt; or
270 # &lt;code&gt;captions.update&lt;/code&gt; methods, you can set the &lt;code&gt;sync&lt;/code&gt;
271 # parameter to &lt;code&gt;true&lt;/code&gt; to instruct YouTube to sync the uploaded
272 # track to the video. If the value is &lt;code&gt;false&lt;/code&gt;, YouTube uses
273 # the time codes in the uploaded caption track to determine when to display
274 # captions.
275 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This
276 # property is only present if the &lt;code&gt;&lt;a href=&quot;#state&quot;&gt;state&lt;/a&gt;&lt;/code&gt;
277 # property&#x27;s value is &lt;code&gt;failed&lt;/code&gt;.
278 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
279 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf
280 # and hard of hearing. The default value is &lt;code&gt;false&lt;/code&gt;.
281 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a
282 # &lt;a href=&quot;http://www.rfc-editor.org/rfc/bcp/bcp47.txt&quot;&gt;BCP-47&lt;/a&gt;
283 # language tag.
284 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
285 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot;
286 # meaning it is at a third-grade level for language learners.
287 # The default value is &lt;code&gt;false&lt;/code&gt;.
288 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is
289 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
290 # format.
291 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible
292 # to the user as an option during playback.
293 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the
294 # vision-impaired. The default value is &lt;code&gt;false&lt;/code&gt;.
295 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
296 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is
297 # &lt;code&gt;true&lt;/code&gt;, then the track is not publicly visible.
298 # The default value is &lt;code&gt;false&lt;/code&gt;.
299 # @mutable youtube.captions.insert youtube.captions.update
300 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated
301 # with the caption track.
302 # @mutable youtube.captions.insert
303 },
304 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
305 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string
306 # &lt;code&gt;&quot;youtube#caption&quot;&lt;/code&gt;.
307 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
308 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]309</div>
310
311<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]312 <code class="details" id="list">list(videoId, part, onBehalfOf=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
313 <pre>Retrieves a list of resources, possibly filtered.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]314
315Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]316 videoId: string, Returns the captions for the specified video. (required)
317 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies a
318comma-separated list of one or more &lt;code&gt;caption&lt;/code&gt; resource parts
319that the API response will include. The &lt;code&gt;part&lt;/code&gt; names that you
320can include in the parameter value are &lt;code&gt;id&lt;/code&gt; and
321&lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]322 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]323 id: string, Returns the captions with the given IDs for Stubby or Apiary. (repeated)
324 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
325content partners.&lt;br&gt;&lt;br&gt;The
326&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
327that the request&#x27;s authorization credentials identify a YouTube CMS user
328who is acting on behalf of the content owner specified in the parameter
329value. This parameter is intended for YouTube content partners that own and
330manage many different YouTube channels. It allows content owners to
331authenticate once and get access to all their video and channel data,
332without having to provide authentication credentials for each individual
333channel. The actual CMS account that the user authenticates with must be
334linked to the specified YouTube content owner.
335 x__xgafv: string, V1 error format.
336 Allowed values
337 1 - v1 error format
338 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]339
340Returns:
341 An object of the form:
342
343 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]344 &quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]345 &quot;items&quot;: [ # A list of captions that match the request criteria.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]346 { # A &lt;code&gt;&lt;strong&gt;caption&lt;/strong&gt;&lt;/code&gt; resource represents a YouTube
347 # caption track. A caption track is associated with exactly one YouTube
348 # video.
349 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the caption.
350 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio
351 # track in the video. The value will be &lt;code&gt;true&lt;/code&gt; if a sync was
352 # explicitly requested when the caption track was uploaded. For example,
353 # when calling the &lt;code&gt;captions.insert&lt;/code&gt; or
354 # &lt;code&gt;captions.update&lt;/code&gt; methods, you can set the &lt;code&gt;sync&lt;/code&gt;
355 # parameter to &lt;code&gt;true&lt;/code&gt; to instruct YouTube to sync the uploaded
356 # track to the video. If the value is &lt;code&gt;false&lt;/code&gt;, YouTube uses
357 # the time codes in the uploaded caption track to determine when to display
358 # captions.
359 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This
360 # property is only present if the &lt;code&gt;&lt;a href=&quot;#state&quot;&gt;state&lt;/a&gt;&lt;/code&gt;
361 # property&#x27;s value is &lt;code&gt;failed&lt;/code&gt;.
362 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
363 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf
364 # and hard of hearing. The default value is &lt;code&gt;false&lt;/code&gt;.
365 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a
366 # &lt;a href=&quot;http://www.rfc-editor.org/rfc/bcp/bcp47.txt&quot;&gt;BCP-47&lt;/a&gt;
367 # language tag.
368 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
369 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot;
370 # meaning it is at a third-grade level for language learners.
371 # The default value is &lt;code&gt;false&lt;/code&gt;.
372 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is
373 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
374 # format.
375 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible
376 # to the user as an option during playback.
377 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the
378 # vision-impaired. The default value is &lt;code&gt;false&lt;/code&gt;.
379 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
380 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is
381 # &lt;code&gt;true&lt;/code&gt;, then the track is not publicly visible.
382 # The default value is &lt;code&gt;false&lt;/code&gt;.
383 # @mutable youtube.captions.insert youtube.captions.update
384 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated
385 # with the caption track.
386 # @mutable youtube.captions.insert
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]387 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]388 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
389 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string
390 # &lt;code&gt;&quot;youtube#caption&quot;&lt;/code&gt;.
391 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
392 },
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]393 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]394 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
395 &quot;kind&quot;: &quot;youtube#captionListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
396 # &lt;code&gt;&quot;youtube#captionListResponse&quot;&lt;/code&gt;.
397 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]398 }</pre>
399</div>
400
401<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]402 <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, onBehalfOf=None, sync=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
403 <pre>Updates an existing resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]404
405Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]406 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies a
407comma-separated list of one or more &lt;code&gt;caption&lt;/code&gt; resource parts
408that the API response will include. The &lt;code&gt;part&lt;/code&gt; names that you
409can include in the parameter value are &lt;code&gt;id&lt;/code&gt; and
410&lt;code&gt;snippet&lt;/code&gt;. (required) (repeated)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]411 body: object, The request body.
412 The object takes the form of:
413
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]414{ # A &lt;code&gt;&lt;strong&gt;caption&lt;/strong&gt;&lt;/code&gt; resource represents a YouTube
415 # caption track. A caption track is associated with exactly one YouTube
416 # video.
417 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the caption.
418 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio
419 # track in the video. The value will be &lt;code&gt;true&lt;/code&gt; if a sync was
420 # explicitly requested when the caption track was uploaded. For example,
421 # when calling the &lt;code&gt;captions.insert&lt;/code&gt; or
422 # &lt;code&gt;captions.update&lt;/code&gt; methods, you can set the &lt;code&gt;sync&lt;/code&gt;
423 # parameter to &lt;code&gt;true&lt;/code&gt; to instruct YouTube to sync the uploaded
424 # track to the video. If the value is &lt;code&gt;false&lt;/code&gt;, YouTube uses
425 # the time codes in the uploaded caption track to determine when to display
426 # captions.
427 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This
428 # property is only present if the &lt;code&gt;&lt;a href=&quot;#state&quot;&gt;state&lt;/a&gt;&lt;/code&gt;
429 # property&#x27;s value is &lt;code&gt;failed&lt;/code&gt;.
430 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
431 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf
432 # and hard of hearing. The default value is &lt;code&gt;false&lt;/code&gt;.
433 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a
434 # &lt;a href=&quot;http://www.rfc-editor.org/rfc/bcp/bcp47.txt&quot;&gt;BCP-47&lt;/a&gt;
435 # language tag.
436 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
437 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot;
438 # meaning it is at a third-grade level for language learners.
439 # The default value is &lt;code&gt;false&lt;/code&gt;.
440 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is
441 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
442 # format.
443 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible
444 # to the user as an option during playback.
445 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the
446 # vision-impaired. The default value is &lt;code&gt;false&lt;/code&gt;.
447 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
448 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is
449 # &lt;code&gt;true&lt;/code&gt;, then the track is not publicly visible.
450 # The default value is &lt;code&gt;false&lt;/code&gt;.
451 # @mutable youtube.captions.insert youtube.captions.update
452 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated
453 # with the caption track.
454 # @mutable youtube.captions.insert
455 },
456 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
457 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string
458 # &lt;code&gt;&quot;youtube#caption&quot;&lt;/code&gt;.
459 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
460}
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]461
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]462 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
463content partners.&lt;br&gt;&lt;br&gt;The
464&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
465that the request&#x27;s authorization credentials identify a YouTube CMS user
466who is acting on behalf of the content owner specified in the parameter
467value. This parameter is intended for YouTube content partners that own and
468manage many different YouTube channels. It allows content owners to
469authenticate once and get access to all their video and channel data,
470without having to provide authentication credentials for each individual
471channel. The actual CMS account that the user authenticates with must be
472linked to the specified YouTube content owner.
473 onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
474 sync: boolean, Extra parameter to allow automatically syncing the uploaded
475caption/transcript with the audio.
476 x__xgafv: string, V1 error format.
477 Allowed values
478 1 - v1 error format
479 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]480 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
481 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]482
483Returns:
484 An object of the form:
485
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]486 { # A &lt;code&gt;&lt;strong&gt;caption&lt;/strong&gt;&lt;/code&gt; resource represents a YouTube
487 # caption track. A caption track is associated with exactly one YouTube
488 # video.
489 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the caption.
490 &quot;isAutoSynced&quot;: True or False, # Indicates whether YouTube synchronized the caption track to the audio
491 # track in the video. The value will be &lt;code&gt;true&lt;/code&gt; if a sync was
492 # explicitly requested when the caption track was uploaded. For example,
493 # when calling the &lt;code&gt;captions.insert&lt;/code&gt; or
494 # &lt;code&gt;captions.update&lt;/code&gt; methods, you can set the &lt;code&gt;sync&lt;/code&gt;
495 # parameter to &lt;code&gt;true&lt;/code&gt; to instruct YouTube to sync the uploaded
496 # track to the video. If the value is &lt;code&gt;false&lt;/code&gt;, YouTube uses
497 # the time codes in the uploaded caption track to determine when to display
498 # captions.
499 &quot;failureReason&quot;: &quot;A String&quot;, # The reason that YouTube failed to process the caption track. This
500 # property is only present if the &lt;code&gt;&lt;a href=&quot;#state&quot;&gt;state&lt;/a&gt;&lt;/code&gt;
501 # property&#x27;s value is &lt;code&gt;failed&lt;/code&gt;.
502 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
503 &quot;isCC&quot;: True or False, # Indicates whether the track contains closed captions for the deaf
504 # and hard of hearing. The default value is &lt;code&gt;false&lt;/code&gt;.
505 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a
506 # &lt;a href=&quot;http://www.rfc-editor.org/rfc/bcp/bcp47.txt&quot;&gt;BCP-47&lt;/a&gt;
507 # language tag.
508 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
509 &quot;isEasyReader&quot;: True or False, # Indicates whether caption track is formatted for &quot;easy reader,&quot;
510 # meaning it is at a third-grade level for language learners.
511 # The default value is &lt;code&gt;false&lt;/code&gt;.
512 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated. The value is
513 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
514 # format.
515 &quot;name&quot;: &quot;A String&quot;, # The name of the caption track. The name is intended to be visible
516 # to the user as an option during playback.
517 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the
518 # vision-impaired. The default value is &lt;code&gt;false&lt;/code&gt;.
519 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
520 &quot;isDraft&quot;: True or False, # Indicates whether the caption track is a draft. If the value is
521 # &lt;code&gt;true&lt;/code&gt;, then the track is not publicly visible.
522 # The default value is &lt;code&gt;false&lt;/code&gt;.
523 # @mutable youtube.captions.insert youtube.captions.update
524 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the video associated
525 # with the caption track.
526 # @mutable youtube.captions.insert
527 },
528 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
529 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string
530 # &lt;code&gt;&quot;youtube#caption&quot;&lt;/code&gt;.
531 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
532 }</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]533</div>
534
535</body></html>