| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.channelSections.html">channelSections</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a resource.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts a new resource into this collection.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(part, channelId=None, id=None, hl=None, mine=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a list of resources, possibly filtered.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing resource.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Deletes a resource. |
| |
| Args: |
| id: string, A parameter (required) |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(part, body=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Inserts a new resource into this collection. |
| |
| Args: |
| 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) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "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. |
| "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. |
| "A String", |
| ], |
| "channels": [ # The channel ids for type multiple_channels. |
| "A String", |
| ], |
| }, |
| "localizations": { # Localizations for different languages |
| "a_key": { # ChannelSection localization setting |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| }, |
| "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. |
| "regions": [ # The region the channel section is targeting. |
| "A String", |
| ], |
| "languages": [ # The language the channel section is targeting. |
| "A String", |
| ], |
| "countries": [ # The country the channel section is targeting. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. |
| "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. |
| "defaultLanguage": "A String", # The language of the channel section's default title and description. |
| "style": "A String", # The style of the channel section. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. |
| "localized": { # ChannelSection localization setting # Localized title, read-only. |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. |
| "type": "A String", # The type of the channel section. |
| "position": 42, # The position of the channel section in the channel. |
| }, |
| "etag": "A String", # Etag of this resource. |
| } |
| |
| 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. |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "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. |
| "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. |
| "A String", |
| ], |
| "channels": [ # The channel ids for type multiple_channels. |
| "A String", |
| ], |
| }, |
| "localizations": { # Localizations for different languages |
| "a_key": { # ChannelSection localization setting |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| }, |
| "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. |
| "regions": [ # The region the channel section is targeting. |
| "A String", |
| ], |
| "languages": [ # The language the channel section is targeting. |
| "A String", |
| ], |
| "countries": [ # The country the channel section is targeting. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. |
| "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. |
| "defaultLanguage": "A String", # The language of the channel section's default title and description. |
| "style": "A String", # The style of the channel section. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. |
| "localized": { # ChannelSection localization setting # Localized title, read-only. |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. |
| "type": "A String", # The type of the channel section. |
| "position": 42, # The position of the channel section in the channel. |
| }, |
| "etag": "A String", # Etag of this resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(part, channelId=None, id=None, hl=None, mine=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Retrieves a list of resources, possibly filtered. |
| |
| Args: |
| 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) |
| channelId: string, Return the ChannelSections owned by the specified channel ID. |
| id: string, Return the ChannelSections with the given IDs for Stubby or Apiary. (repeated) |
| hl: string, Return content in specified language |
| mine: boolean, Return the ChannelSections owned by the authenticated user. |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "visitorId": "A String", # The visitorId identifies the visitor. |
| "items": [ # A list of ChannelSections that match the request criteria. |
| { |
| "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. |
| "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. |
| "A String", |
| ], |
| "channels": [ # The channel ids for type multiple_channels. |
| "A String", |
| ], |
| }, |
| "localizations": { # Localizations for different languages |
| "a_key": { # ChannelSection localization setting |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| }, |
| "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. |
| "regions": [ # The region the channel section is targeting. |
| "A String", |
| ], |
| "languages": [ # The language the channel section is targeting. |
| "A String", |
| ], |
| "countries": [ # The country the channel section is targeting. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. |
| "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. |
| "defaultLanguage": "A String", # The language of the channel section's default title and description. |
| "style": "A String", # The style of the channel section. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. |
| "localized": { # ChannelSection localization setting # Localized title, read-only. |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. |
| "type": "A String", # The type of the channel section. |
| "position": 42, # The position of the channel section in the channel. |
| }, |
| "etag": "A String", # Etag of this resource. |
| }, |
| ], |
| "kind": "youtube#channelSectionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse". |
| "eventId": "A String", # Serialized EventId of the request which produced this response. |
| "etag": "A String", # Etag of this resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Updates an existing resource. |
| |
| Args: |
| 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) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "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. |
| "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. |
| "A String", |
| ], |
| "channels": [ # The channel ids for type multiple_channels. |
| "A String", |
| ], |
| }, |
| "localizations": { # Localizations for different languages |
| "a_key": { # ChannelSection localization setting |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| }, |
| "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. |
| "regions": [ # The region the channel section is targeting. |
| "A String", |
| ], |
| "languages": [ # The language the channel section is targeting. |
| "A String", |
| ], |
| "countries": [ # The country the channel section is targeting. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. |
| "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. |
| "defaultLanguage": "A String", # The language of the channel section's default title and description. |
| "style": "A String", # The style of the channel section. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. |
| "localized": { # ChannelSection localization setting # Localized title, read-only. |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. |
| "type": "A String", # The type of the channel section. |
| "position": 42, # The position of the channel section in the channel. |
| }, |
| "etag": "A String", # Etag of this resource. |
| } |
| |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "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. |
| "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed. |
| "A String", |
| ], |
| "channels": [ # The channel ids for type multiple_channels. |
| "A String", |
| ], |
| }, |
| "localizations": { # Localizations for different languages |
| "a_key": { # ChannelSection localization setting |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| }, |
| "targeting": { # ChannelSection targeting setting. # The targeting object contains basic targeting settings about the channel section. |
| "regions": [ # The region the channel section is targeting. |
| "A String", |
| ], |
| "languages": [ # The language the channel section is targeting. |
| "A String", |
| ], |
| "countries": [ # The country the channel section is targeting. |
| "A String", |
| ], |
| }, |
| "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection". |
| "id": "A String", # The ID that YouTube uses to uniquely identify the channel section. |
| "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. |
| "defaultLanguage": "A String", # The language of the channel section's default title and description. |
| "style": "A String", # The style of the channel section. |
| "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channel section. |
| "localized": { # ChannelSection localization setting # Localized title, read-only. |
| "title": "A String", # The localized strings for channel section's title. |
| }, |
| "title": "A String", # The channel section's title for multiple_playlists and multiple_channels. |
| "type": "A String", # The type of the channel section. |
| "position": 42, # The position of the channel section in the channel. |
| }, |
| "etag": "A String", # Etag of this resource. |
| }</pre> |
| </div> |
| |
| </body></html> |