docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/youtube_v3.captions.html b/docs/dyn/youtube_v3.captions.html
index 5118435..fb6ce44 100644
--- a/docs/dyn/youtube_v3.captions.html
+++ b/docs/dyn/youtube_v3.captions.html
@@ -75,42 +75,40 @@
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.captions.html">captions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <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>
<p class="firstline">Deletes a resource.</p>
<p class="toc_element">
- <code><a href="#download">download(id, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</a></code></p>
+ <code><a href="#download">download(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=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, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</a></code></p>
+ <code><a href="#download_media">download_media(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=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, sync=None, onBehalfOfContentOwner=None, onBehalfOf=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(videoId, part, onBehalfOf=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(videoId, part, id=None, onBehalfOfContentOwner=None, onBehalfOf=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, onBehalfOfContentOwner=None, onBehalfOf=None, sync=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
+ <code><a href="#update">update(part, body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Updates an existing resource.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(id, onBehalfOf=None, onBehalfOfContentOwner=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, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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.
+ 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
@@ -119,27 +117,15 @@
</div>
<div class="method">
- <code class="details" id="download">download(id, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</code>
+ <code class="details" id="download">download(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=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)
- 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, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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.
+ 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.
+ tlang: string, tlang is the language code; machine translate the captions into this language.
+ tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -148,27 +134,15 @@
</div>
<div class="method">
- <code class="details" id="download_media">download_media(id, tlang=None, onBehalfOf=None, onBehalfOfContentOwner=None, tfmt=None, x__xgafv=None)</code>
+ <code class="details" id="download_media">download_media(id, onBehalfOf=None, onBehalfOfContentOwner=None, tlang=None, tfmt=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)
- 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, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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.
+ 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.
+ tlang: string, tlang is the language code; machine translate the captions into this language.
+ tfmt: string, Convert the captions into this format. Supported options are sbv, srt, and vtt.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -177,78 +151,38 @@
</div>
<div class="method">
- <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>
+ <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:
- part: string, The <code><strong>part</strong></code> parameter specifies the
-<code>caption</code> resource parts that the API response will include. Set
-the parameter value to <code>snippet</code>. (required) (repeated)
+ part: string, The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet. (required) (repeated)
body: object, The request body.
The object takes the form of:
-{ # A <code><strong>caption</strong></code> 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 <code>snippet</code> object contains basic details about the caption.
- "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio
- # track in the video. The value will be <code>true</code> if a sync was
- # explicitly requested when the caption track was uploaded. For example,
- # when calling the <code>captions.insert</code> or
- # <code>captions.update</code> methods, you can set the <code>sync</code>
- # parameter to <code>true</code> to instruct YouTube to sync the uploaded
- # track to the video. If the value is <code>false</code>, 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 <code><a href="#state">state</a></code>
- # property's value is <code>failed</code>.
- "trackKind": "A String", # The caption track's type.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf
- # and hard of hearing. The default value is <code>false</code>.
- "language": "A String", # The language of the caption track. The property value is a
- # <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP-47</a>
- # language tag.
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "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 <code>false</code>.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "name": "A String", # The name of the caption track. The name is intended to be visible
- # to the user as an option during playback.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the
- # vision-impaired. The default value is <code>false</code>.
- "status": "A String", # The caption track's status.
- "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is
- # <code>true</code>, then the track is not publicly visible.
- # The default value is <code>false</code>.
- # @mutable youtube.captions.insert youtube.captions.update
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated
- # with the caption track.
- # @mutable youtube.captions.insert
- },
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#caption"</code>.
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
-}
+{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "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.
+ "status": "A String", # The caption track's status.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "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
+ "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.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "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.
+ "trackKind": "A String", # The caption track's type.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ },
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "etag": "A String", # Etag of this resource.
+ }
- sync: boolean, Extra parameter to allow automatically syncing the uploaded
-caption/transcript with the audio.
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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 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
@@ -259,79 +193,38 @@
Returns:
An object of the form:
- { # A <code><strong>caption</strong></code> 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 <code>snippet</code> object contains basic details about the caption.
- "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio
- # track in the video. The value will be <code>true</code> if a sync was
- # explicitly requested when the caption track was uploaded. For example,
- # when calling the <code>captions.insert</code> or
- # <code>captions.update</code> methods, you can set the <code>sync</code>
- # parameter to <code>true</code> to instruct YouTube to sync the uploaded
- # track to the video. If the value is <code>false</code>, 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 <code><a href="#state">state</a></code>
- # property's value is <code>failed</code>.
- "trackKind": "A String", # The caption track's type.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf
- # and hard of hearing. The default value is <code>false</code>.
- "language": "A String", # The language of the caption track. The property value is a
- # <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP-47</a>
- # language tag.
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "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 <code>false</code>.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "name": "A String", # The name of the caption track. The name is intended to be visible
- # to the user as an option during playback.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the
- # vision-impaired. The default value is <code>false</code>.
- "status": "A String", # The caption track's status.
- "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is
- # <code>true</code>, then the track is not publicly visible.
- # The default value is <code>false</code>.
- # @mutable youtube.captions.insert youtube.captions.update
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated
- # with the caption track.
- # @mutable youtube.captions.insert
- },
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#caption"</code>.
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- }</pre>
+ { # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "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.
+ "status": "A String", # The caption track's status.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "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
+ "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.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "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.
+ "trackKind": "A String", # The caption track's type.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ },
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "etag": "A String", # Etag of this resource.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(videoId, part, onBehalfOf=None, id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(videoId, part, id=None, onBehalfOfContentOwner=None, onBehalfOf=None, x__xgafv=None)</code>
<pre>Retrieves a list of resources, possibly filtered.
Args:
videoId: string, Returns the captions for the specified video. (required)
- part: string, The <code><strong>part</strong></code> parameter specifies a
-comma-separated list of one or more <code>caption</code> resource parts
-that the API response will include. The <code>part</code> names that you
-can include in the parameter value are <code>id</code> and
-<code>snippet</code>. (required) (repeated)
- onBehalfOf: string, ID of the Google+ Page for the channel that the request is on behalf of.
+ 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)
id: string, Returns the captions with the given IDs for Stubby or Apiary. (repeated)
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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.
+ 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 on behalf of.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -341,138 +234,68 @@
An object of the form:
{
- "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
- "items": [ # A list of captions that match the request criteria.
- { # A <code><strong>caption</strong></code> 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 <code>snippet</code> object contains basic details about the caption.
- "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio
- # track in the video. The value will be <code>true</code> if a sync was
- # explicitly requested when the caption track was uploaded. For example,
- # when calling the <code>captions.insert</code> or
- # <code>captions.update</code> methods, you can set the <code>sync</code>
- # parameter to <code>true</code> to instruct YouTube to sync the uploaded
- # track to the video. If the value is <code>false</code>, 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 <code><a href="#state">state</a></code>
- # property's value is <code>failed</code>.
- "trackKind": "A String", # The caption track's type.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf
- # and hard of hearing. The default value is <code>false</code>.
- "language": "A String", # The language of the caption track. The property value is a
- # <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP-47</a>
- # language tag.
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "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 <code>false</code>.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "name": "A String", # The name of the caption track. The name is intended to be visible
- # to the user as an option during playback.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the
- # vision-impaired. The default value is <code>false</code>.
- "status": "A String", # The caption track's status.
- "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is
- # <code>true</code>, then the track is not publicly visible.
- # The default value is <code>false</code>.
- # @mutable youtube.captions.insert youtube.captions.update
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated
- # with the caption track.
- # @mutable youtube.captions.insert
- },
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#caption"</code>.
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- },
- ],
"etag": "A String", # Etag of this resource.
- "kind": "youtube#captionListResponse", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#captionListResponse"</code>.
+ "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.
+ "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.
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "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.
+ "status": "A String", # The caption track's status.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "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
+ "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.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "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.
+ "trackKind": "A String", # The caption track's type.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ },
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "etag": "A String", # Etag of this resource.
+ },
+ ],
}</pre>
</div>
<div class="method">
- <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>
+ <code class="details" id="update">update(part, body=None, onBehalfOf=None, sync=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
<pre>Updates an existing resource.
Args:
- part: string, The <code><strong>part</strong></code> parameter specifies a
-comma-separated list of one or more <code>caption</code> resource parts
-that the API response will include. The <code>part</code> names that you
-can include in the parameter value are <code>id</code> and
-<code>snippet</code>. (required) (repeated)
+ 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)
body: object, The request body.
The object takes the form of:
-{ # A <code><strong>caption</strong></code> 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 <code>snippet</code> object contains basic details about the caption.
- "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio
- # track in the video. The value will be <code>true</code> if a sync was
- # explicitly requested when the caption track was uploaded. For example,
- # when calling the <code>captions.insert</code> or
- # <code>captions.update</code> methods, you can set the <code>sync</code>
- # parameter to <code>true</code> to instruct YouTube to sync the uploaded
- # track to the video. If the value is <code>false</code>, 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 <code><a href="#state">state</a></code>
- # property's value is <code>failed</code>.
- "trackKind": "A String", # The caption track's type.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf
- # and hard of hearing. The default value is <code>false</code>.
- "language": "A String", # The language of the caption track. The property value is a
- # <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP-47</a>
- # language tag.
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "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 <code>false</code>.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "name": "A String", # The name of the caption track. The name is intended to be visible
- # to the user as an option during playback.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the
- # vision-impaired. The default value is <code>false</code>.
- "status": "A String", # The caption track's status.
- "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is
- # <code>true</code>, then the track is not publicly visible.
- # The default value is <code>false</code>.
- # @mutable youtube.captions.insert youtube.captions.update
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated
- # with the caption track.
- # @mutable youtube.captions.insert
- },
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#caption"</code>.
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
-}
+{ # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "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.
+ "status": "A String", # The caption track's status.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "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
+ "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.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "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.
+ "trackKind": "A String", # The caption track's type.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ },
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "etag": "A String", # Etag of this resource.
+ }
- onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube
-content partners.<br><br>The
-<code><strong>onBehalfOfContentOwner</strong></code> 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 on behalf of.
- sync: boolean, Extra parameter to allow automatically syncing the uploaded
-caption/transcript with the audio.
+ sync: boolean, Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.
+ 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
@@ -483,53 +306,26 @@
Returns:
An object of the form:
- { # A <code><strong>caption</strong></code> 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 <code>snippet</code> object contains basic details about the caption.
- "isAutoSynced": True or False, # Indicates whether YouTube synchronized the caption track to the audio
- # track in the video. The value will be <code>true</code> if a sync was
- # explicitly requested when the caption track was uploaded. For example,
- # when calling the <code>captions.insert</code> or
- # <code>captions.update</code> methods, you can set the <code>sync</code>
- # parameter to <code>true</code> to instruct YouTube to sync the uploaded
- # track to the video. If the value is <code>false</code>, 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 <code><a href="#state">state</a></code>
- # property's value is <code>failed</code>.
- "trackKind": "A String", # The caption track's type.
- "isCC": True or False, # Indicates whether the track contains closed captions for the deaf
- # and hard of hearing. The default value is <code>false</code>.
- "language": "A String", # The language of the caption track. The property value is a
- # <a href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">BCP-47</a>
- # language tag.
- "audioTrackType": "A String", # The type of audio track associated with the caption track.
- "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 <code>false</code>.
- "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is
- # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
- # format.
- "name": "A String", # The name of the caption track. The name is intended to be visible
- # to the user as an option during playback.
- "isLarge": True or False, # Indicates whether the caption track uses large text for the
- # vision-impaired. The default value is <code>false</code>.
- "status": "A String", # The caption track's status.
- "isDraft": True or False, # Indicates whether the caption track is a draft. If the value is
- # <code>true</code>, then the track is not publicly visible.
- # The default value is <code>false</code>.
- # @mutable youtube.captions.insert youtube.captions.update
- "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated
- # with the caption track.
- # @mutable youtube.captions.insert
- },
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string
- # <code>"youtube#caption"</code>.
- "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
- }</pre>
+ { # A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
+ "kind": "youtube#caption", # Identifies what kind of resource this is. Value: the fixed string "youtube#caption".
+ "snippet": { # Basic details about a caption track, such as its language and name. # The snippet object contains basic details about the caption.
+ "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.
+ "status": "A String", # The caption track's status.
+ "lastUpdated": "A String", # The date and time when the caption track was last updated. The value is specified in ISO 8601 format.
+ "name": "A String", # The name of the caption track. The name is intended to be visible to the user as an option during playback.
+ "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
+ "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.
+ "videoId": "A String", # The ID that YouTube uses to uniquely identify the video associated with the caption track. @mutable youtube.captions.insert
+ "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.
+ "trackKind": "A String", # The caption track's type.
+ "language": "A String", # The language of the caption track. The property value is a BCP-47 language tag.
+ "isLarge": True or False, # Indicates whether the caption track uses large text for the vision-impaired. The default value is false.
+ "isCC": True or False, # Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.
+ },
+ "id": "A String", # The ID that YouTube uses to uniquely identify the caption track.
+ "etag": "A String", # Etag of this resource.
+ }</pre>
</div>
</body></html>
\ No newline at end of file