docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/youtube_v3.captions.html b/docs/dyn/youtube_v3.captions.html
index 4a5a864..9057278 100644
--- a/docs/dyn/youtube_v3.captions.html
+++ b/docs/dyn/youtube_v3.captions.html
@@ -78,22 +78,22 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, onBehalfOf=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a resource.</p>
<p class="toc_element">
- <code><a href="#download">download(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</a></code></p>
+ <code><a href="#download">download(id, tfmt=None, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads a caption track.</p>
<p class="toc_element">
- <code><a href="#download_media">download_media(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</a></code></p>
+ <code><a href="#download_media">download_media(id, tfmt=None, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Downloads a caption track.</p>
<p class="toc_element">
- <code><a href="#insert">insert(part, body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
+ <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>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
- <code><a href="#list">list(part, videoId, onBehalfOf=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(part, videoId, id=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
- <code><a href="#update">update(part, body=None, onBehalfOf=None, onBehalfOfContentOwner=None, sync=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
+ <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, sync=None, onBehalfOf=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Updates an existing resource.</p>
<h3>Method Details</h3>
<div class="method">
@@ -102,13 +102,13 @@
</div>
<div class="method">
- <code class="details" id="delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, onBehalfOf=None, x__xgafv=None)</code>
<pre>Deletes a resource.
Args:
id: string, A parameter (required)
- onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -117,15 +117,15 @@
</div>
<div class="method">
- <code class="details" id="download">download(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</code>
+ <code class="details" id="download">download(id, tfmt=None, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Downloads a caption track.
Args:
id: string, The ID of the caption track to download, required for One Platform. (required)
- onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
- tlang: string, tlang is the language code; machine translate the captions into this language.
- onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
+ tlang: string, tlang is the language code; machine translate the captions into this language.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
+ onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -134,15 +134,15 @@
</div>
<div class="method">
- <code class="details" id="download_media">download_media(id, onBehalfOf=None, tlang=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</code>
+ <code class="details" id="download_media">download_media(id, tfmt=None, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Downloads a caption track.
Args:
id: string, The ID of the caption track to download, required for One Platform. (required)
- onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
- tlang: string, tlang is the language code; machine translate the captions into this language.
- onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
+ tlang: string, tlang is the language code; machine translate the captions into this language.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
+ onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -151,7 +151,7 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(part, body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
+ <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>
<pre>Inserts a new resource into this collection.
Args:
@@ -160,28 +160,28 @@
The object takes the form of:
{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
- "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
- "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
- "status": "A String", # The caption track's status.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
- "trackKind": "A String", # The caption track's type.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
- "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
- "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
- "isDraft": 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
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "isAutoSynced": 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.
- "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
"etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "isAutoSynced": 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.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "trackKind": "A String", # The caption track's type.
+ "isDraft": 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
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "status": "A String", # The caption track's status.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
}
- onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
sync: boolean, Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is be on behalf of
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
x__xgafv: string, V1 error format.
Allowed values
@@ -194,36 +194,36 @@
An object of the form:
{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
- "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
- "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
- "status": "A String", # The caption track's status.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
- "trackKind": "A String", # The caption track's type.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
- "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
- "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
- "isDraft": 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
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "isAutoSynced": 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.
- "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
"etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "isAutoSynced": 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.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "trackKind": "A String", # The caption track's type.
+ "isDraft": 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
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "status": "A String", # The caption track's status.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(part, videoId, onBehalfOf=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(part, videoId, id=None, onBehalfOf=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
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)
videoId: string, Returns the captions for the specified video. (required)
- onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
id: string, Returns the captions with the given IDs for Stubby or Apiary. (repeated)
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
x__xgafv: string, V1 error format.
Allowed values
@@ -234,37 +234,37 @@
An object of the form:
{
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "kind": "youtube#captionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse".
- "visitorId": "A String", # The visitorId identifies the visitor.
+ "etag": "A String", # Etag of this resource.
"items": [ # A list of captions that match the request criteria.
{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
- "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
- "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
- "status": "A String", # The caption track's status.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
- "trackKind": "A String", # The caption track's type.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
- "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
- "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
- "isDraft": 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
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "isAutoSynced": 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.
- "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
"etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "isAutoSynced": 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.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "trackKind": "A String", # The caption track's type.
+ "isDraft": 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
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "status": "A String", # The caption track's status.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
},
],
- "etag": "A String", # Etag of this resource.
+ "kind": "youtube#captionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse".
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
+ "visitorId": "A String", # The visitorId identifies the visitor.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(part, body=None, onBehalfOf=None, onBehalfOfContentOwner=None, sync=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
+ <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, sync=None, onBehalfOf=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
<pre>Updates an existing resource.
Args:
@@ -273,29 +273,29 @@
The object takes the form of:
{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
- "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
- "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
- "status": "A String", # The caption track's status.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
- "trackKind": "A String", # The caption track's type.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
- "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
- "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
- "isDraft": 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
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "isAutoSynced": 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.
- "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
"etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "isAutoSynced": 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.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "trackKind": "A String", # The caption track's type.
+ "isDraft": 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
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "status": "A String", # The caption track's status.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
}
- onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
sync: boolean, Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
+ onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -307,24 +307,24 @@
An object of the form:
{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
- "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
- "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
- "status": "A String", # The caption track's status.
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
- "trackKind": "A String", # The caption track's type.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
- "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
- "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
- "isDraft": 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
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "isAutoSynced": 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.
- "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
- },
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
"etag": "A String", # Etag of this resource.
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "isAutoSynced": 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.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "trackKind": "A String", # The caption track's type.
+ "isDraft": 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
+ "failureReason": "A String", # The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "isEasyReader": True or False, # Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.
+ "audioTrackType": "A String", # The type of audio track associated with the caption track.
+ "status": "A String", # The caption track's status.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ },
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
}</pre>
</div>