Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / youtube_v3.channelSections.html
blob: c5d3b6ef481fc39c020c537433cb69907c8a0d37 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]84 <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]85<p class="firstline">Inserts a new resource into this collection.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]87 <code><a href="#list">list(part, channelId=None, hl=None, id=None, mine=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Updates an existing resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</code>
100 <pre>Deletes a resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101
102Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103 id: string, A parameter (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]104 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]109</pre>
110</div>
111
112<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]113 <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 <pre>Inserts a new resource into this collection.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115
116Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]118 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119 The object takes the form of:
120
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]121{
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]122 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
123 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]125 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 &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]127 },
128 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 &quot;targeting&quot;: { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]130 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &quot;A String&quot;,
132 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]133 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;A String&quot;,
135 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]136 &quot;regions&quot;: [ # The region the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;A String&quot;,
138 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]139 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]140 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#channelSection&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]141 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
142 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
143 &quot;A String&quot;,
144 ],
145 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
146 &quot;A String&quot;,
147 ],
148 },
149 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
150 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
151 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
152 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
153 &quot;position&quot;: 42, # The position of the channel section in the channel.
154 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
155 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published the channel section.
156 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
157 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
158 },
159 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160 }
161
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]163 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* 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 onBehalfOfContentOwner 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 onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168
169Returns:
170 An object of the form:
171
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]172 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]173 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
174 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]176 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 &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]178 },
179 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]180 &quot;targeting&quot;: { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]181 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &quot;A String&quot;,
183 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]184 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]185 &quot;A String&quot;,
186 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]187 &quot;regions&quot;: [ # The region the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 &quot;A String&quot;,
189 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]191 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#channelSection&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]192 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
193 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
194 &quot;A String&quot;,
195 ],
196 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
197 &quot;A String&quot;,
198 ],
199 },
200 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
201 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
202 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
203 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
204 &quot;position&quot;: 42, # The position of the channel section in the channel.
205 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
206 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published the channel section.
207 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
208 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
209 },
210 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 }</pre>
212</div>
213
214<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]215 <code class="details" id="list">list(part, channelId=None, hl=None, id=None, mine=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]216 <pre>Retrieves a list of resources, possibly filtered.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]217
218Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]219 part: string, The *part* parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set *part=snippet*, the API response will also contain all of those nested properties. (required) (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]220 channelId: string, Return the ChannelSections owned by the specified channel ID.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 hl: string, Return content in specified language
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]222 id: string, Return the ChannelSections with the given IDs for Stubby or Apiary. (repeated)
223 mine: boolean, Return the ChannelSections owned by the authenticated user.
224 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]225 x__xgafv: string, V1 error format.
226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]229
230Returns:
231 An object of the form:
232
233 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]234 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]235 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]236 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]237 &quot;items&quot;: [ # A list of ChannelSections that match the request criteria.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]238 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]239 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
240 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]241 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]242 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]243 &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]244 },
245 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]246 &quot;targeting&quot;: { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]247 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]248 &quot;A String&quot;,
249 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]250 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]251 &quot;A String&quot;,
252 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]253 &quot;regions&quot;: [ # The region the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 &quot;A String&quot;,
255 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]256 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]257 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#channelSection&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]258 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
259 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
260 &quot;A String&quot;,
261 ],
262 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
263 &quot;A String&quot;,
264 ],
265 },
266 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
267 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
268 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
269 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
270 &quot;position&quot;: 42, # The position of the channel section in the channel.
271 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
272 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published the channel section.
273 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
274 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
275 },
276 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 },
278 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]279 &quot;kind&quot;: &quot;youtube#channelSectionListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#channelSectionListResponse&quot;.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 }</pre>
281</div>
282
283<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]284 <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
285 <pre>Updates an existing resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286
287Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]288 part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]289 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290 The object takes the form of:
291
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]292{
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]293 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
294 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]295 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]296 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]297 &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]298 },
299 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]300 &quot;targeting&quot;: { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]301 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 &quot;A String&quot;,
303 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]304 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 &quot;A String&quot;,
306 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]307 &quot;regions&quot;: [ # The region the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308 &quot;A String&quot;,
309 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]310 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]311 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#channelSection&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]312 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
313 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
314 &quot;A String&quot;,
315 ],
316 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
317 &quot;A String&quot;,
318 ],
319 },
320 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
321 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
322 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
323 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
324 &quot;position&quot;: 42, # The position of the channel section in the channel.
325 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
326 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published the channel section.
327 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
328 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
329 },
330 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]331 }
332
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]333 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]334 x__xgafv: string, V1 error format.
335 Allowed values
336 1 - v1 error format
337 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]338
339Returns:
340 An object of the form:
341
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]342 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]343 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel section.
344 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]345 &quot;localizations&quot;: { # Localizations for different languages
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]346 &quot;a_key&quot;: { # ChannelSection localization setting
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]347 &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]348 },
349 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]350 &quot;targeting&quot;: { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]351 &quot;languages&quot;: [ # The language the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]352 &quot;A String&quot;,
353 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]354 &quot;countries&quot;: [ # The country the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]355 &quot;A String&quot;,
356 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]357 &quot;regions&quot;: [ # The region the channel section is targeting.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]358 &quot;A String&quot;,
359 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]360 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]361 &quot;kind&quot;: &quot;youtube#channelSection&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#channelSection&quot;.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]362 &quot;contentDetails&quot;: { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.
363 &quot;playlists&quot;: [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
364 &quot;A String&quot;,
365 ],
366 &quot;channels&quot;: [ # The channel ids for type multiple_channels.
367 &quot;A String&quot;,
368 ],
369 },
370 &quot;snippet&quot;: { # Basic details about a channel section, including title, style and position. # The snippet object contains basic details about the channel section, such as its type, style and title.
371 &quot;style&quot;: &quot;A String&quot;, # The style of the channel section.
372 &quot;title&quot;: &quot;A String&quot;, # The channel section&#x27;s title for multiple_playlists and multiple_channels.
373 &quot;type&quot;: &quot;A String&quot;, # The type of the channel section.
374 &quot;position&quot;: 42, # The position of the channel section in the channel.
375 &quot;defaultLanguage&quot;: &quot;A String&quot;, # The language of the channel section&#x27;s default title and description.
376 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the channel that published the channel section.
377 &quot;localized&quot;: { # ChannelSection localization setting # Localized title, read-only.
378 &quot;title&quot;: &quot;A String&quot;, # The localized strings for channel section&#x27;s title.
379 },
380 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]381 }</pre>
382</div>
383
384</body></html>