Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns channelSection resources that match the API request criteria.
See: YouTube Data API Reference for youtube.channelSections.list
.
Synopsis
- type ChannelSectionsListResource = "youtube" :> ("v3" :> ("channelSections" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "channelId" Text :> (QueryParam "hl" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ChannelSectionListResponse)))))))))
- channelSectionsList :: Text -> ChannelSectionsList
- data ChannelSectionsList
- cslPart :: Lens' ChannelSectionsList Text
- cslMine :: Lens' ChannelSectionsList (Maybe Bool)
- cslChannelId :: Lens' ChannelSectionsList (Maybe Text)
- cslHl :: Lens' ChannelSectionsList (Maybe Text)
- cslOnBehalfOfContentOwner :: Lens' ChannelSectionsList (Maybe Text)
- cslId :: Lens' ChannelSectionsList (Maybe Text)
REST Resource
type ChannelSectionsListResource = "youtube" :> ("v3" :> ("channelSections" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "channelId" Text :> (QueryParam "hl" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "id" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ChannelSectionListResponse))))))))) Source #
A resource alias for youtube.channelSections.list
method which the
ChannelSectionsList
request conforms to.
Creating a Request
Creates a value of ChannelSectionsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ChannelSectionsList Source #
Returns channelSection resources that match the API request criteria.
See: channelSectionsList
smart constructor.
Instances
Request Lenses
cslPart :: Lens' ChannelSectionsList Text Source #
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.
cslMine :: Lens' ChannelSectionsList (Maybe Bool) Source #
Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections.
cslChannelId :: Lens' ChannelSectionsList (Maybe Text) Source #
The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections.
cslHl :: Lens' ChannelSectionsList (Maybe Text) Source #
The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.
cslOnBehalfOfContentOwner :: Lens' ChannelSectionsList (Maybe Text) Source #
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.