blob: c5352d332f6b342e0806da2ffae950c637035349 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.channelBanners.html">channelBanners</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#insert">insert(body=None, onBehalfOfContentOwner=None, channelId=None, onBehalfOfContentOwnerChannel=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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, channelId=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
<pre>Inserts a new resource into this collection.
Args:
body: object, The request body.
The object takes the form of:
{ # A channel banner returned as the response to a channel_banner.insert call.
&quot;etag&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;youtube#channelBannerResource&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#channelBannerResource&quot;&lt;/code&gt;.
&quot;url&quot;: &quot;A String&quot;, # The URL of this banner image.
}
onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
content partners.&lt;br&gt;&lt;br&gt;The
&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; 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.
channelId: string, Unused, channel_id is currently derived from the security context of the
requestor.
onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly &lt;a
href=&quot;/youtube/v3/guides/authentication&quot;&gt;authorized request&lt;/a&gt;.
&lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
content partners.&lt;br&gt;&lt;br&gt;The
&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwnerChannel&lt;/strong&gt;&lt;/code&gt; parameter
specifies the YouTube channel ID of the channel to which a video is being
added. This parameter is required when a request specifies a value for the
&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter, and it can only be used in
conjunction with that parameter. In addition, the request must be
authorized using a CMS account that is linked to the content owner that the
&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies. Finally, the
channel that the &lt;code&gt;onBehalfOfContentOwnerChannel&lt;/code&gt; parameter value
specifies must be linked to the content owner that the
&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies.&lt;br&gt;&lt;br&gt;This
parameter is intended for YouTube content partners that own and manage many
different YouTube channels. It allows content owners to authenticate once
and perform actions on behalf of the channel specified in the parameter
value, without having to provide authentication credentials for each
separate channel.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # A channel banner returned as the response to a channel_banner.insert call.
&quot;etag&quot;: &quot;A String&quot;,
&quot;kind&quot;: &quot;youtube#channelBannerResource&quot;, # Identifies what kind of resource this is. Value: the fixed string
# &lt;code&gt;&quot;youtube#channelBannerResource&quot;&lt;/code&gt;.
&quot;url&quot;: &quot;A String&quot;, # The URL of this banner image.
}</pre>
</div>
</body></html>