Network.Google.Resource.YouTube.PlayLists.List

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.

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))))))))))))

A resource alias for youtube.playlists.list method which the PlayListsList request conforms to.

Creating a Request

playListsList

Arguments

:: Text

pllPart

-> 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:

• pllPart
• pllMine
• pllChannelId
• pllHl
• pllOnBehalfOfContentOwner
• pllOnBehalfOfContentOwnerChannel
• pllId
• pllPageToken
• pllMaxResults

data PlayListsList

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

Eq PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

Methods

(==) :: PlayListsList -> PlayListsList -> Bool

(/=) :: PlayListsList -> PlayListsList -> Bool

Data PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PlayListsList -> c PlayListsList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PlayListsList

toConstr :: PlayListsList -> Constr

dataTypeOf :: PlayListsList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PlayListsList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PlayListsList)

gmapT :: (forall b. Data b => b -> b) -> PlayListsList -> PlayListsList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PlayListsList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PlayListsList -> r

gmapQ :: (forall d. Data d => d -> u) -> PlayListsList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PlayListsList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PlayListsList -> m PlayListsList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PlayListsList -> m PlayListsList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PlayListsList -> m PlayListsList

Show PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

Methods

showsPrec :: Int -> PlayListsList -> ShowS

show :: PlayListsList -> String

showList :: [PlayListsList] -> ShowS

Generic PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

Associated Types

type Rep PlayListsList :: Type -> Type

Methods

from :: PlayListsList -> Rep PlayListsList x

to :: Rep PlayListsList x -> PlayListsList

GoogleRequest PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

Associated Types

type Rs PlayListsList :: Type

type Scopes PlayListsList :: [Symbol]

Methods

requestClient :: PlayListsList -> GClient (Rs PlayListsList)

type Rep PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

type Rep PlayListsList = D1 (MetaData "PlayListsList" "Network.Google.Resource.YouTube.PlayLists.List" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "PlayListsList'" PrefixI True) (((S1 (MetaSel (Just "_pllPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pllMine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_pllChannelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pllHl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pllOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pllOnBehalfOfContentOwnerChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pllId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pllPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pllMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))

type Scopes PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

type Scopes PlayListsList = "https://www.googleapis.com/auth/youtube" ': ("https://www.googleapis.com/auth/youtube.force-ssl" ': ("https://www.googleapis.com/auth/youtube.readonly" ': ("https://www.googleapis.com/auth/youtubepartner" ': ([] :: [Symbol]))))

type Rs PlayListsList

Defined in Network.Google.Resource.YouTube.PlayLists.List

type Rs PlayListsList = PlayListListResponse

Request Lenses

pllPart :: Lens' PlayListsList Text

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)

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)

This value indicates that the API should only return the specified channel's playlists.

pllHl :: Lens' PlayListsList (Maybe Text)

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)

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)

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)

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)

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

The maxResults parameter specifies the maximum number of items that should be returned in the result set.