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 a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.
See: YouTube Data API Reference for youtube.playlists.list
.
Synopsis
- type PlayListsListResource = "youtube" :> ("v3" :> ("playlists" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "channelId" Text :> (QueryParam "hl" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] PlayListListResponse))))))))))))
- playListsList :: Text -> PlayListsList
- data PlayListsList
- pllPart :: Lens' PlayListsList Text
- pllMine :: Lens' PlayListsList (Maybe Bool)
- pllChannelId :: Lens' PlayListsList (Maybe Text)
- pllHl :: Lens' PlayListsList (Maybe Text)
- pllOnBehalfOfContentOwner :: Lens' PlayListsList (Maybe Text)
- pllOnBehalfOfContentOwnerChannel :: Lens' PlayListsList (Maybe Text)
- pllId :: Lens' PlayListsList (Maybe Text)
- pllPageToken :: Lens' PlayListsList (Maybe Text)
- pllMaxResults :: Lens' PlayListsList Word32
REST Resource
type PlayListsListResource = "youtube" :> ("v3" :> ("playlists" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "channelId" Text :> (QueryParam "hl" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] PlayListListResponse)))))))))))) Source #
A resource alias for youtube.playlists.list
method which the
PlayListsList
request conforms to.
Creating a Request
:: Text | |
-> PlayListsList |
Creates a value of PlayListsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PlayListsList Source #
Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.
See: playListsList
smart constructor.
Instances
Request Lenses
pllPart :: Lens' PlayListsList Text Source #
The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties.
pllMine :: Lens' PlayListsList (Maybe Bool) Source #
Set this parameter's value to true to instruct the API to only return playlists owned by the authenticated user.
pllChannelId :: Lens' PlayListsList (Maybe Text) Source #
This value indicates that the API should only return the specified channel's playlists.
pllHl :: Lens' PlayListsList (Maybe Text) Source #
The hl parameter should be used for filter out the properties that are not in the given language. Used for the snippet part.
pllOnBehalfOfContentOwner :: Lens' PlayListsList (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.
pllOnBehalfOfContentOwnerChannel :: Lens' PlayListsList (Maybe Text) Source #
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.
pllId :: Lens' PlayListsList (Maybe Text) Source #
The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID.
pllPageToken :: Lens' PlayListsList (Maybe Text) Source #
The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
pllMaxResults :: Lens' PlayListsList Word32 Source #
The maxResults parameter specifies the maximum number of items that should be returned in the result set.