blob: c5352d332f6b342e0806da2ffae950c637035349 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.channelBanners.html">channelBanners</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070078 <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>
79<p class="firstline">Inserts a new resource into this collection.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<h3>Method Details</h3>
81<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070082 <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>
83 <pre>Inserts a new resource into this collection.
John Asmuth614db982014-04-24 15:46:26 -040084
85Args:
86 body: object, The request body.
87 The object takes the form of:
88
89{ # A channel banner returned as the response to a channel_banner.insert call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -070090 &quot;etag&quot;: &quot;A String&quot;,
91 &quot;kind&quot;: &quot;youtube#channelBannerResource&quot;, # Identifies what kind of resource this is. Value: the fixed string
92 # &lt;code&gt;&quot;youtube#channelBannerResource&quot;&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -070093 &quot;url&quot;: &quot;A String&quot;, # The URL of this banner image.
John Asmuth614db982014-04-24 15:46:26 -040094 }
95
Bu Sun Kimd059ad82020-07-22 17:02:09 -070096 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
97content partners.&lt;br&gt;&lt;br&gt;The
98&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
99that the request&#x27;s authorization credentials identify a YouTube CMS user
100who is acting on behalf of the content owner specified in the parameter
101value. This parameter is intended for YouTube content partners that own and
102manage many different YouTube channels. It allows content owners to
103authenticate once and get access to all their video and channel data,
104without having to provide authentication credentials for each individual
105channel. The actual CMS account that the user authenticates with must be
106linked to the specified YouTube content owner.
107 channelId: string, Unused, channel_id is currently derived from the security context of the
108requestor.
109 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly &lt;a
110href=&quot;/youtube/v3/guides/authentication&quot;&gt;authorized request&lt;/a&gt;.
111&lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
112content partners.&lt;br&gt;&lt;br&gt;The
113&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwnerChannel&lt;/strong&gt;&lt;/code&gt; parameter
114specifies the YouTube channel ID of the channel to which a video is being
115added. This parameter is required when a request specifies a value for the
116&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter, and it can only be used in
117conjunction with that parameter. In addition, the request must be
118authorized using a CMS account that is linked to the content owner that the
119&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies. Finally, the
120channel that the &lt;code&gt;onBehalfOfContentOwnerChannel&lt;/code&gt; parameter value
121specifies must be linked to the content owner that the
122&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies.&lt;br&gt;&lt;br&gt;This
123parameter is intended for YouTube content partners that own and manage many
124different YouTube channels. It allows content owners to authenticate once
125and perform actions on behalf of the channel specified in the parameter
126value, without having to provide authentication credentials for each
127separate channel.
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800133 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
John Asmuth614db982014-04-24 15:46:26 -0400134
135Returns:
136 An object of the form:
137
138 { # A channel banner returned as the response to a channel_banner.insert call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700139 &quot;etag&quot;: &quot;A String&quot;,
140 &quot;kind&quot;: &quot;youtube#channelBannerResource&quot;, # Identifies what kind of resource this is. Value: the fixed string
141 # &lt;code&gt;&quot;youtube#channelBannerResource&quot;&lt;/code&gt;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700142 &quot;url&quot;: &quot;A String&quot;, # The URL of this banner image.
John Asmuth614db982014-04-24 15:46:26 -0400143 }</pre>
144</div>
145
146</body></html>