blob: bcf573b049ca7ee77122b5aead601c9589e3255e [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
75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.channelSections.html">channelSections</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -080078 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040079<p class="firstline">Deletes a channelSection.</p>
80<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -070081 <code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<p class="firstline">Adds a channelSection for the authenticated user's channel.</p>
83<p class="toc_element">
84 <code><a href="#list">list(part=None, onBehalfOfContentOwner=None, channelId=None, mine=None, id=None)</a></code></p>
85<p class="firstline">Returns channelSection resources that match the API request criteria.</p>
86<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -080087 <code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040088<p class="firstline">Update a channelSection.</p>
89<h3>Method Details</h3>
90<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -080091 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
John Asmuth614db982014-04-24 15:46:26 -040092 <pre>Deletes a channelSection.
93
94Args:
95 id: string, The id parameter specifies the YouTube channelSection ID for the resource that is being deleted. In a channelSection resource, the id property specifies the YouTube channelSection ID. (required)
Craig Citroe633be12015-03-02 13:40:36 -080096 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
97
98The 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
John Asmuth614db982014-04-24 15:46:26 -040099</pre>
100</div>
101
102<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700103 <code class="details" id="insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400104 <pre>Adds a channelSection for the authenticated user's channel.
105
106Args:
107 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.
108
109The part names that you can include in the parameter value are snippet and contentDetails. (required)
110 body: object, The request body. (required)
111 The object takes the form of:
112
Craig Citroe633be12015-03-02 13:40:36 -0800113{
114 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
115 "contentDetails": { # 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.
John Asmuth614db982014-04-24 15:46:26 -0400116 "channels": [ # The channel ids for type multiple_channels.
117 "A String",
118 ],
119 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
120 "A String",
121 ],
122 },
Craig Citroe633be12015-03-02 13:40:36 -0800123 "snippet": { # 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.
124 "style": "A String", # The style of the channel section.
125 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
126 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
127 "defaultLanguage": "A String", # The language of the channel section's default title and description.
128 "position": 42, # The position of the channel section in the channel.
129 "type": "A String", # The type of the channel section.
130 "localized": { # ChannelSection localization setting # Localized title, read-only.
131 "title": "A String", # The localized strings for channel section's title.
132 },
133 },
John Asmuth614db982014-04-24 15:46:26 -0400134 "etag": "A String", # Etag of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800135 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
136 "localizations": { # Localizations for different languages
137 "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
138 "title": "A String", # The localized strings for channel section's title.
139 },
140 },
John Asmuth614db982014-04-24 15:46:26 -0400141 }
142
Craig Citro065b5302014-08-14 00:47:23 -0700143 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
144
145The 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
John Asmuth614db982014-04-24 15:46:26 -0400146 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
147
148The 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.
149
150This 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.
151
152Returns:
153 An object of the form:
154
Craig Citroe633be12015-03-02 13:40:36 -0800155 {
156 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
157 "contentDetails": { # 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.
John Asmuth614db982014-04-24 15:46:26 -0400158 "channels": [ # The channel ids for type multiple_channels.
159 "A String",
160 ],
161 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
162 "A String",
163 ],
164 },
Craig Citroe633be12015-03-02 13:40:36 -0800165 "snippet": { # 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.
166 "style": "A String", # The style of the channel section.
167 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
168 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
169 "defaultLanguage": "A String", # The language of the channel section's default title and description.
170 "position": 42, # The position of the channel section in the channel.
171 "type": "A String", # The type of the channel section.
172 "localized": { # ChannelSection localization setting # Localized title, read-only.
173 "title": "A String", # The localized strings for channel section's title.
174 },
175 },
John Asmuth614db982014-04-24 15:46:26 -0400176 "etag": "A String", # Etag of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800177 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
178 "localizations": { # Localizations for different languages
179 "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
180 "title": "A String", # The localized strings for channel section's title.
181 },
182 },
John Asmuth614db982014-04-24 15:46:26 -0400183 }</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, channelId=None, mine=None, id=None)</code>
188 <pre>Returns channelSection resources that match the API request criteria.
189
190Args:
191 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.
192
193If 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)
194 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
195
196The 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
197 channelId: string, The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections.
198 mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections.
199 id: string, The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID.
200
201Returns:
202 An object of the form:
203
204 {
205 "eventId": "A String", # Serialized EventId of the request which produced this response.
206 "items": [ # A list of ChannelSections that match the request criteria.
Craig Citroe633be12015-03-02 13:40:36 -0800207 {
208 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
209 "contentDetails": { # 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.
John Asmuth614db982014-04-24 15:46:26 -0400210 "channels": [ # The channel ids for type multiple_channels.
211 "A String",
212 ],
213 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
214 "A String",
215 ],
216 },
Craig Citroe633be12015-03-02 13:40:36 -0800217 "snippet": { # 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.
218 "style": "A String", # The style of the channel section.
219 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
220 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
221 "defaultLanguage": "A String", # The language of the channel section's default title and description.
222 "position": 42, # The position of the channel section in the channel.
223 "type": "A String", # The type of the channel section.
224 "localized": { # ChannelSection localization setting # Localized title, read-only.
225 "title": "A String", # The localized strings for channel section's title.
226 },
227 },
John Asmuth614db982014-04-24 15:46:26 -0400228 "etag": "A String", # Etag of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800229 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
230 "localizations": { # Localizations for different languages
231 "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
232 "title": "A String", # The localized strings for channel section's title.
233 },
234 },
John Asmuth614db982014-04-24 15:46:26 -0400235 },
236 ],
237 "kind": "youtube#channelSectionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse".
238 "etag": "A String", # Etag of this resource.
239 "visitorId": "A String", # The visitorId identifies the visitor.
240 }</pre>
241</div>
242
243<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800244 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400245 <pre>Update a channelSection.
246
247Args:
248 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.
249
250The part names that you can include in the parameter value are snippet and contentDetails. (required)
251 body: object, The request body. (required)
252 The object takes the form of:
253
Craig Citroe633be12015-03-02 13:40:36 -0800254{
255 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
256 "contentDetails": { # 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.
John Asmuth614db982014-04-24 15:46:26 -0400257 "channels": [ # The channel ids for type multiple_channels.
258 "A String",
259 ],
260 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
261 "A String",
262 ],
263 },
Craig Citroe633be12015-03-02 13:40:36 -0800264 "snippet": { # 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.
265 "style": "A String", # The style of the channel section.
266 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
267 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
268 "defaultLanguage": "A String", # The language of the channel section's default title and description.
269 "position": 42, # The position of the channel section in the channel.
270 "type": "A String", # The type of the channel section.
271 "localized": { # ChannelSection localization setting # Localized title, read-only.
272 "title": "A String", # The localized strings for channel section's title.
273 },
274 },
John Asmuth614db982014-04-24 15:46:26 -0400275 "etag": "A String", # Etag of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800276 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
277 "localizations": { # Localizations for different languages
278 "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
279 "title": "A String", # The localized strings for channel section's title.
280 },
281 },
John Asmuth614db982014-04-24 15:46:26 -0400282 }
283
Craig Citroe633be12015-03-02 13:40:36 -0800284 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
285
286The 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
John Asmuth614db982014-04-24 15:46:26 -0400287
288Returns:
289 An object of the form:
290
Craig Citroe633be12015-03-02 13:40:36 -0800291 {
292 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
293 "contentDetails": { # 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.
John Asmuth614db982014-04-24 15:46:26 -0400294 "channels": [ # The channel ids for type multiple_channels.
295 "A String",
296 ],
297 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
298 "A String",
299 ],
300 },
Craig Citroe633be12015-03-02 13:40:36 -0800301 "snippet": { # 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.
302 "style": "A String", # The style of the channel section.
303 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels.
304 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section.
305 "defaultLanguage": "A String", # The language of the channel section's default title and description.
306 "position": 42, # The position of the channel section in the channel.
307 "type": "A String", # The type of the channel section.
308 "localized": { # ChannelSection localization setting # Localized title, read-only.
309 "title": "A String", # The localized strings for channel section's title.
310 },
311 },
John Asmuth614db982014-04-24 15:46:26 -0400312 "etag": "A String", # Etag of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800313 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section.
314 "localizations": { # Localizations for different languages
315 "a_key": { # ChannelSection localization setting # The language tag, using string since map_key require simple types.
316 "title": "A String", # The localized strings for channel section's title.
317 },
318 },
John Asmuth614db982014-04-24 15:46:26 -0400319 }</pre>
320</div>
321
322</body></html>