Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / youtube_v3.captions.html
blob: c37d12b36cb609d1ff286875fbb9f63e779030ba [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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]81 <code><a href="#delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]82<p class="firstline">Deletes a resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]84 <code><a href="#download">download(id, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, tlang=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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]87 <code><a href="#download_media">download_media(id, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, tlang=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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]90 <code><a href="#insert">insert(part, body=None, media_body=None, media_mime_type=None, onBehalfOf=None, onBehalfOfContentOwner=None, sync=None, x__xgafv=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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]93 <code><a href="#list">list(part, videoId, id=None, onBehalfOf=None, onBehalfOfContentOwner=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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]96 <code><a href="#update">update(part, body=None, media_body=None, media_mime_type=None, onBehalfOf=None, onBehalfOfContentOwner=None, sync=None, x__xgafv=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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]105 <code class="details" id="delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]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)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]110 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]120 <code class="details" id="download">download(id, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, tlang=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)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]125 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]127 tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]128 tlang: string, tlang is the language code; machine translate the captions into this language.
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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]137 <code class="details" id="download_media">download_media(id, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, tlang=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)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]142 onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]144 tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]145 tlang: string, tlang is the language code; machine translate the captions into this language.
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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]154 <code class="details" id="insert">insert(part, body=None, media_body=None, media_mime_type=None, onBehalfOf=None, onBehalfOfContentOwner=None, sync=None, x__xgafv=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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]163 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
164 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
165 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
166 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]167 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]168 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]169 &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.
170 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]171 &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
172 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]173 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
174 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]175 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]176 &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.
177 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
178 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
179 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]180 },
181}
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]182
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]183 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
184 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]185 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]186 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]187 sync: boolean, Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]197 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
198 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
199 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
200 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
201 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
202 &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.
203 &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.
204 &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.
205 &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
206 &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.
207 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
208 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]209 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]210 &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.
211 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
212 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
213 &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
214 },
215}</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]216</div>
217
218<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]219 <code class="details" id="list">list(part, videoId, id=None, onBehalfOf=None, onBehalfOfContentOwner=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:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]223 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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]224 videoId: string, Returns the captions for the specified video. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]225 id: string, Returns the captions with the given IDs for Stubby or Apiary. (repeated)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]226 onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]227 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]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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]237 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
238 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
239 &quot;items&quot;: [ # A list of captions that match the request criteria.
240 { # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
241 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
242 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
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;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
246 &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.
247 &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.
248 &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.
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;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
252 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]253 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]254 &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.
255 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
256 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
257 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]258 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]259 },
260 ],
261 &quot;kind&quot;: &quot;youtube#captionListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#captionListResponse&quot;.
262 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
263}</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]264</div>
265
266<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]267 <code class="details" id="update">update(part, body=None, media_body=None, media_mime_type=None, onBehalfOf=None, onBehalfOfContentOwner=None, sync=None, x__xgafv=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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]276 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
277 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
278 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
279 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]280 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]281 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]282 &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.
283 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]284 &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
285 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]286 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
287 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]288 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]289 &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.
290 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
291 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
292 &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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]293 },
294}
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]295
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]296 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
297 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]298 onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]299 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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]300 sync: boolean, Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]301 x__xgafv: string, V1 error format.
302 Allowed values
303 1 - v1 error format
304 2 - v2 error format
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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]310 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
311 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the caption track.
312 &quot;kind&quot;: &quot;youtube#caption&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#caption&quot;.
313 &quot;snippet&quot;: { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
314 &quot;audioTrackType&quot;: &quot;A String&quot;, # The type of audio track associated with the caption track.
315 &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.
316 &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.
317 &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.
318 &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
319 &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.
320 &quot;isLarge&quot;: True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
321 &quot;language&quot;: &quot;A String&quot;, # The language of the caption track. The property value is a BCP-47 language tag.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]322 &quot;lastUpdated&quot;: &quot;A String&quot;, # The date and time when the caption track was last updated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]323 &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.
324 &quot;status&quot;: &quot;A String&quot;, # The caption track&#x27;s status.
325 &quot;trackKind&quot;: &quot;A String&quot;, # The caption track&#x27;s type.
326 &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
327 },
328}</pre>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]329</div>
330
331</body></html>