Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / youtube_v3.channelSections.html
blob: 0f4410a29a6644d92b3b23a097df560553a81719 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.channelSections.html">channelSections</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]78 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Inserts a new resource into this collection.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#list">list(part, mine=None, channelId=None, onBehalfOfContentOwner=None, hl=None, id=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Updates an existing resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]91 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</code>
92 <pre>Deletes a resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93
94Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]95 id: string, A parameter (required)
96 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
100request&#x27;s authorization credentials identify a YouTube CMS user who is
101acting on behalf of the content owner specified in the parameter value.
102This parameter is intended for YouTube content partners that own and manage
103many different YouTube channels. It allows content owners to authenticate
104once and get access to all their video and channel data, without having to
105provide authentication credentials for each individual channel. The CMS
106account that the user authenticates with must be linked to the specified
107YouTube content owner.
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112</pre>
113</div>
114
115<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116 <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
117 <pre>Inserts a new resource into this collection.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]118
119Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter serves two purposes in
121this operation. It identifies the properties that the write operation will
122set as well as the properties that the API response will
123include.&lt;br/&gt;&lt;br/&gt;The &lt;code&gt;part&lt;/code&gt; names that you can include in the
124parameter value are &lt;code&gt;snippet&lt;/code&gt; and &lt;code&gt;contentDetails&lt;/code&gt;. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]125 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126 The object takes the form of:
127
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]128{
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
130 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains details about the channel
131 # section content, such as a list of playlists or channels featured in the
132 # section.
133 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For
134 # singlePlaylist, only one playlistId is allowed.
135 &quot;A String&quot;,
136 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
138 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]139 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]140 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]144 },
145 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string
147 # &lt;code&gt;&quot;youtube#channelSection&quot;&lt;/code&gt;.
148 &quot;targeting&quot;: { # ChannelSection targeting setting. # The &lt;code&gt;targeting&lt;/code&gt; object contains basic targeting settings about
149 # the channel section.
150 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 &quot;A String&quot;,
152 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]153 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &quot;A String&quot;,
155 ],
156 &quot;regions&quot;: [ # The region the channel section is targeting.
157 &quot;A String&quot;,
158 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]159 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]160 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the channel
161 # section, such as its type, style and title.
162 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
163 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
164 },
165 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
166 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published
167 # the channel section.
168 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
169 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
170 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
171 &quot;position&quot;: 42, # The position of the channel section in the channel.
172 },
173 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]174 }
175
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]176 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly &lt;a
177href=&quot;/youtube/v3/guides/authentication&quot;&gt;authorized request&lt;/a&gt;.
178&lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
179content partners.&lt;br&gt;&lt;br&gt;The
180&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwnerChannel&lt;/strong&gt;&lt;/code&gt; parameter
181specifies the YouTube channel ID of the channel to which a video is being
182added. This parameter is required when a request specifies a value for the
183&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter, and it can only be used in
184conjunction with that parameter. In addition, the request must be
185authorized using a CMS account that is linked to the content owner that the
186&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies. Finally, the
187channel that the &lt;code&gt;onBehalfOfContentOwnerChannel&lt;/code&gt; parameter value
188specifies must be linked to the content owner that the
189&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies.&lt;br&gt;&lt;br&gt;This
190parameter is intended for YouTube content partners that own and manage many
191different YouTube channels. It allows content owners to authenticate once
192and perform actions on behalf of the channel specified in the parameter
193value, without having to provide authentication credentials for each
194separate channel.
195 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
196content partners.&lt;br&gt;&lt;br&gt;The
197&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
198that the
199request&#x27;s authorization credentials identify a YouTube CMS user who is
200acting on behalf of the content owner specified in the parameter value.
201This parameter is intended for YouTube content partners that own and manage
202many different YouTube channels. It allows content owners to authenticate
203once and get access to all their video and channel data, without having to
204provide authentication credentials for each individual channel. The CMS
205account that the user authenticates with must be linked to the specified
206YouTube content owner.
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211
212Returns:
213 An object of the form:
214
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]215 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
217 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains details about the channel
218 # section content, such as a list of playlists or channels featured in the
219 # section.
220 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For
221 # singlePlaylist, only one playlistId is allowed.
222 &quot;A String&quot;,
223 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
225 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]226 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]227 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]228 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]229 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]230 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]231 },
232 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]233 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string
234 # &lt;code&gt;&quot;youtube#channelSection&quot;&lt;/code&gt;.
235 &quot;targeting&quot;: { # ChannelSection targeting setting. # The &lt;code&gt;targeting&lt;/code&gt; object contains basic targeting settings about
236 # the channel section.
237 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 &quot;A String&quot;,
239 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]240 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;A String&quot;,
242 ],
243 &quot;regions&quot;: [ # The region the channel section is targeting.
244 &quot;A String&quot;,
245 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]246 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]247 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the channel
248 # section, such as its type, style and title.
249 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
250 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
251 },
252 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
253 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published
254 # the channel section.
255 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
256 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
257 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
258 &quot;position&quot;: 42, # The position of the channel section in the channel.
259 },
260 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]261 }</pre>
262</div>
263
264<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]265 <code class="details" id="list">list(part, mine=None, channelId=None, onBehalfOfContentOwner=None, hl=None, id=None, x__xgafv=None)</code>
266 <pre>Retrieves a list of resources, possibly filtered.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]267
268Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]269 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies a
270comma-separated list of one or more &lt;code&gt;channelSection&lt;/code&gt; resource
271properties that the API response will include. The &lt;code&gt;part&lt;/code&gt; names
272that you can include in the parameter value are &lt;code&gt;id&lt;/code&gt;,
273&lt;code&gt;snippet&lt;/code&gt;, and &lt;code&gt;contentDetails&lt;/code&gt;.&lt;br&gt;&lt;br&gt;If the
274parameter identifies a property that contains child properties, the child
275properties will be included in the response. For example, in a
276&lt;code&gt;channelSection&lt;/code&gt; resource, the &lt;code&gt;snippet&lt;/code&gt; property
277contains other properties, such as a display title for the channelSection.
278If you set &lt;code&gt;&lt;strong&gt;part=snippet&lt;/strong&gt;&lt;/code&gt;, the API response
279will also contain all of those nested properties. (required) (repeated)
280 mine: boolean, Return the ChannelSections owned by the authenticated user.
281 channelId: string, Return the ChannelSections owned by the specified channel ID.
282 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
283content partners.&lt;br&gt;&lt;br&gt;The
284&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
285that the
286request&#x27;s authorization credentials identify a YouTube CMS user who is
287acting on behalf of the content owner specified in the parameter value.
288This parameter is intended for YouTube content partners that own and manage
289many different YouTube channels. It allows content owners to authenticate
290once and get access to all their video and channel data, without having to
291provide authentication credentials for each individual channel. The CMS
292account that the user authenticates with must be linked to the specified
293YouTube content owner.
294 hl: string, Return content in specified language
295 id: string, Return the ChannelSections with the given IDs for Stubby or Apiary. (repeated)
296 x__xgafv: string, V1 error format.
297 Allowed values
298 1 - v1 error format
299 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]300
301Returns:
302 An object of the form:
303
304 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 &quot;items&quot;: [ # A list of ChannelSections that match the request criteria.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]306 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]307 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
308 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains details about the channel
309 # section content, such as a list of playlists or channels featured in the
310 # section.
311 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For
312 # singlePlaylist, only one playlistId is allowed.
313 &quot;A String&quot;,
314 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
316 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]317 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]318 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]319 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]320 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]321 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]322 },
323 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]324 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string
325 # &lt;code&gt;&quot;youtube#channelSection&quot;&lt;/code&gt;.
326 &quot;targeting&quot;: { # ChannelSection targeting setting. # The &lt;code&gt;targeting&lt;/code&gt; object contains basic targeting settings about
327 # the channel section.
328 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]329 &quot;A String&quot;,
330 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]331 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]332 &quot;A String&quot;,
333 ],
334 &quot;regions&quot;: [ # The region the channel section is targeting.
335 &quot;A String&quot;,
336 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]337 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]338 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the channel
339 # section, such as its type, style and title.
340 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
341 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
342 },
343 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
344 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published
345 # the channel section.
346 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
347 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
348 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
349 &quot;position&quot;: 42, # The position of the channel section in the channel.
350 },
351 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]352 },
353 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]354 &quot;kind&quot;: &quot;youtube#channelSectionListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
355 # &lt;code&gt;&quot;youtube#channelSectionListResponse&quot;&lt;/code&gt;.
356 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
357 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
358 &quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]359 }</pre>
360</div>
361
362<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]363 <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
364 <pre>Updates an existing resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]365
366Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]367 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter serves two purposes in
368this operation. It identifies the properties that the write operation will
369set as well as the properties that the API response will
370include.&lt;br/&gt;&lt;br/&gt;The &lt;code&gt;part&lt;/code&gt; names that you can include in the
371parameter value are &lt;code&gt;snippet&lt;/code&gt; and &lt;code&gt;contentDetails&lt;/code&gt;. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]372 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]373 The object takes the form of:
374
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]375{
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]376 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
377 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains details about the channel
378 # section content, such as a list of playlists or channels featured in the
379 # section.
380 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For
381 # singlePlaylist, only one playlistId is allowed.
382 &quot;A String&quot;,
383 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]384 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
385 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]386 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]387 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]388 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]389 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]390 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]391 },
392 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]393 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string
394 # &lt;code&gt;&quot;youtube#channelSection&quot;&lt;/code&gt;.
395 &quot;targeting&quot;: { # ChannelSection targeting setting. # The &lt;code&gt;targeting&lt;/code&gt; object contains basic targeting settings about
396 # the channel section.
397 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]398 &quot;A String&quot;,
399 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]400 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]401 &quot;A String&quot;,
402 ],
403 &quot;regions&quot;: [ # The region the channel section is targeting.
404 &quot;A String&quot;,
405 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]406 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]407 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the channel
408 # section, such as its type, style and title.
409 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
410 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
411 },
412 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
413 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published
414 # the channel section.
415 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
416 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
417 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
418 &quot;position&quot;: 42, # The position of the channel section in the channel.
419 },
420 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]421 }
422
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]423 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
424content partners.&lt;br&gt;&lt;br&gt;The
425&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
426that the
427request&#x27;s authorization credentials identify a YouTube CMS user who is
428acting on behalf of the content owner specified in the parameter value.
429This parameter is intended for YouTube content partners that own and manage
430many different YouTube channels. It allows content owners to authenticate
431once and get access to all their video and channel data, without having to
432provide authentication credentials for each individual channel. The CMS
433account that the user authenticates with must be linked to the specified
434YouTube content owner.
435 x__xgafv: string, V1 error format.
436 Allowed values
437 1 - v1 error format
438 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]439
440Returns:
441 An object of the form:
442
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]443 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]444 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
445 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains details about the channel
446 # section content, such as a list of playlists or channels featured in the
447 # section.
448 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For
449 # singlePlaylist, only one playlistId is allowed.
450 &quot;A String&quot;,
451 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]452 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
453 &quot;A String&quot;,
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]454 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]455 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]456 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]457 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]458 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]459 },
460 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]461 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string
462 # &lt;code&gt;&quot;youtube#channelSection&quot;&lt;/code&gt;.
463 &quot;targeting&quot;: { # ChannelSection targeting setting. # The &lt;code&gt;targeting&lt;/code&gt; object contains basic targeting settings about
464 # the channel section.
465 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]466 &quot;A String&quot;,
467 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]468 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]469 &quot;A String&quot;,
470 ],
471 &quot;regions&quot;: [ # The region the channel section is targeting.
472 &quot;A String&quot;,
473 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]474 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]475 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the channel
476 # section, such as its type, style and title.
477 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
478 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
479 },
480 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
481 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published
482 # the channel section.
483 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
484 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
485 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
486 &quot;position&quot;: 42, # The position of the channel section in the channel.
487 },
488 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]489 }</pre>
490</div>
491
492</body></html>