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 75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.channelSections.html">channelSections</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a resource.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Inserts a new resource into this collection.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(part, channelId=None, hl=None, id=None, mine=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a list of resources, possibly filtered.</p> 89<p class="toc_element"> 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> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</code> 100 <pre>Deletes a resource. 101 102Args: 103 id: string, A parameter (required) 104 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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. 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)</code> 114 <pre>Inserts a new resource into this collection. 115 116Args: 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) 118 body: object, The request body. 119 The object takes the form of: 120 121{ 122 "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. 123 "channels": [ # The channel ids for type multiple_channels. 124 "A String", 125 ], 126 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. 127 "A String", 128 ], 129 }, 130 "etag": "A String", # Etag of this resource. 131 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. 132 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". 133 "localizations": { # Localizations for different languages 134 "a_key": { # ChannelSection localization setting 135 "title": "A String", # The localized strings for channel section's title. 136 }, 137 }, 138 "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. 139 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. 140 "defaultLanguage": "A String", # The language of the channel section's default title and description. 141 "localized": { # ChannelSection localization setting # Localized title, read-only. 142 "title": "A String", # The localized strings for channel section's title. 143 }, 144 "position": 42, # The position of the channel section in the channel. 145 "style": "A String", # The style of the channel section. 146 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. 147 "type": "A String", # The type of the channel section. 148 }, 149 "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. 150 "countries": [ # The country the channel section is targeting. 151 "A String", 152 ], 153 "languages": [ # The language the channel section is targeting. 154 "A String", 155 ], 156 "regions": [ # The region the channel section is targeting. 157 "A String", 158 ], 159 }, 160} 161 162 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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. 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. 164 x__xgafv: string, V1 error format. 165 Allowed values 166 1 - v1 error format 167 2 - v2 error format 168 169Returns: 170 An object of the form: 171 172 { 173 "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. 174 "channels": [ # The channel ids for type multiple_channels. 175 "A String", 176 ], 177 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. 178 "A String", 179 ], 180 }, 181 "etag": "A String", # Etag of this resource. 182 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. 183 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". 184 "localizations": { # Localizations for different languages 185 "a_key": { # ChannelSection localization setting 186 "title": "A String", # The localized strings for channel section's title. 187 }, 188 }, 189 "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. 190 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. 191 "defaultLanguage": "A String", # The language of the channel section's default title and description. 192 "localized": { # ChannelSection localization setting # Localized title, read-only. 193 "title": "A String", # The localized strings for channel section's title. 194 }, 195 "position": 42, # The position of the channel section in the channel. 196 "style": "A String", # The style of the channel section. 197 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. 198 "type": "A String", # The type of the channel section. 199 }, 200 "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. 201 "countries": [ # The country the channel section is targeting. 202 "A String", 203 ], 204 "languages": [ # The language the channel section is targeting. 205 "A String", 206 ], 207 "regions": [ # The region the channel section is targeting. 208 "A String", 209 ], 210 }, 211}</pre> 212</div> 213 214<div class="method"> 215 <code class="details" id="list">list(part, channelId=None, hl=None, id=None, mine=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 216 <pre>Retrieves a list of resources, possibly filtered. 217 218Args: 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) 220 channelId: string, Return the ChannelSections owned by the specified channel ID. 221 hl: string, Return content in specified language 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'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. 225 x__xgafv: string, V1 error format. 226 Allowed values 227 1 - v1 error format 228 2 - v2 error format 229 230Returns: 231 An object of the form: 232 233 { 234 "etag": "A String", # Etag of this resource. 235 "eventId": "A String", # Serialized EventId of the request which produced this response. 236 "items": [ # A list of ChannelSections that match the request criteria. 237 { 238 "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. 239 "channels": [ # The channel ids for type multiple_channels. 240 "A String", 241 ], 242 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. 243 "A String", 244 ], 245 }, 246 "etag": "A String", # Etag of this resource. 247 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. 248 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". 249 "localizations": { # Localizations for different languages 250 "a_key": { # ChannelSection localization setting 251 "title": "A String", # The localized strings for channel section's title. 252 }, 253 }, 254 "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. 255 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. 256 "defaultLanguage": "A String", # The language of the channel section's default title and description. 257 "localized": { # ChannelSection localization setting # Localized title, read-only. 258 "title": "A String", # The localized strings for channel section's title. 259 }, 260 "position": 42, # The position of the channel section in the channel. 261 "style": "A String", # The style of the channel section. 262 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. 263 "type": "A String", # The type of the channel section. 264 }, 265 "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. 266 "countries": [ # The country the channel section is targeting. 267 "A String", 268 ], 269 "languages": [ # The language the channel section is targeting. 270 "A String", 271 ], 272 "regions": [ # The region the channel section is targeting. 273 "A String", 274 ], 275 }, 276 }, 277 ], 278 "kind": "youtube#channelSectionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse". 279 "visitorId": "A String", # The visitorId identifies the visitor. 280}</pre> 281</div> 282 283<div class="method"> 284 <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 285 <pre>Updates an existing resource. 286 287Args: 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) 289 body: object, The request body. 290 The object takes the form of: 291 292{ 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. 294 "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 }, 301 "etag": "A String", # Etag of this resource. 302 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. 303 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". 304 "localizations": { # Localizations for different languages 305 "a_key": { # ChannelSection localization setting 306 "title": "A String", # The localized strings for channel section's title. 307 }, 308 }, 309 "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. 310 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. 311 "defaultLanguage": "A String", # The language of the channel section's default title and description. 312 "localized": { # ChannelSection localization setting # Localized title, read-only. 313 "title": "A String", # The localized strings for channel section's title. 314 }, 315 "position": 42, # The position of the channel section in the channel. 316 "style": "A String", # The style of the channel section. 317 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. 318 "type": "A String", # The type of the channel section. 319 }, 320 "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. 321 "countries": [ # The country the channel section is targeting. 322 "A String", 323 ], 324 "languages": [ # The language the channel section is targeting. 325 "A String", 326 ], 327 "regions": [ # The region the channel section is targeting. 328 "A String", 329 ], 330 }, 331} 332 333 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *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. 334 x__xgafv: string, V1 error format. 335 Allowed values 336 1 - v1 error format 337 2 - v2 error format 338 339Returns: 340 An object of the form: 341 342 { 343 "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. 344 "channels": [ # The channel ids for type multiple_channels. 345 "A String", 346 ], 347 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. 348 "A String", 349 ], 350 }, 351 "etag": "A String", # Etag of this resource. 352 "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. 353 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". 354 "localizations": { # Localizations for different languages 355 "a_key": { # ChannelSection localization setting 356 "title": "A String", # The localized strings for channel section's title. 357 }, 358 }, 359 "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. 360 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. 361 "defaultLanguage": "A String", # The language of the channel section's default title and description. 362 "localized": { # ChannelSection localization setting # Localized title, read-only. 363 "title": "A String", # The localized strings for channel section's title. 364 }, 365 "position": 42, # The position of the channel section in the channel. 366 "style": "A String", # The style of the channel section. 367 "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. 368 "type": "A String", # The type of the channel section. 369 }, 370 "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. 371 "countries": [ # The country the channel section is targeting. 372 "A String", 373 ], 374 "languages": [ # The language the channel section is targeting. 375 "A String", 376 ], 377 "regions": [ # The region the channel section is targeting. 378 "A String", 379 ], 380 }, 381}</pre> 382</div> 383 384</body></html>