Network.Google.Resource.YouTube.PlayListItems.List

Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.

See: YouTube Data API Reference for youtube.playlistItems.list.

REST Resource

type PlayListItemsListResource = "youtube" :> ("v3" :> ("playlistItems" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "videoId" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "playlistId" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] PlayListItemListResponse))))))))))

A resource alias for youtube.playlistItems.list method which the PlayListItemsList request conforms to.

Creating a Request

playListItemsList

Arguments

:: Text

plilPart

-> PlayListItemsList

Creates a value of PlayListItemsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• plilPart
• plilOnBehalfOfContentOwner
• plilVideoId
• plilId
• plilPageToken
• plilPlayListId
• plilMaxResults

data PlayListItemsList

Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs.

See: playListItemsList smart constructor.

Instances

Eq PlayListItemsList

Methods

(==) :: PlayListItemsList -> PlayListItemsList -> Bool

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

Data PlayListItemsList

Methods

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

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

toConstr :: PlayListItemsList -> Constr

dataTypeOf :: PlayListItemsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show PlayListItemsList

Methods

showsPrec :: Int -> PlayListItemsList -> ShowS

show :: PlayListItemsList -> String

showList :: [PlayListItemsList] -> ShowS

Generic PlayListItemsList

Associated Types

type Rep PlayListItemsList :: * -> *

Methods

from :: PlayListItemsList -> Rep PlayListItemsList x

to :: Rep PlayListItemsList x -> PlayListItemsList

GoogleRequest PlayListItemsList

Associated Types

type Rs PlayListItemsList :: *

type Scopes PlayListItemsList :: [Symbol]

Methods

requestClient :: PlayListItemsList -> Client (Rs PlayListItemsList)

type Rep PlayListItemsList

type Rep PlayListItemsList = D1 (MetaData "PlayListItemsList" "Network.Google.Resource.YouTube.PlayListItems.List" "gogol-youtube-0.1.1-BKvHJYv3Lac2eVp6D9Sfdq" False) (C1 (MetaCons "PlayListItemsList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_plilPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_plilOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_plilVideoId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_plilId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_plilPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_plilPlayListId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_plilMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))

type Scopes PlayListItemsList

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

type Rs PlayListItemsList

type Rs PlayListItemsList = PlayListItemListResponse

Request Lenses

plilPart :: Lens' PlayListItemsList Text

The part parameter specifies a comma-separated list of one or more playlistItem 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 playlistItem resource, the snippet property contains numerous fields, including the title, description, position, and resourceId properties. As such, if you set part=snippet, the API response will contain all of those properties.

plilOnBehalfOfContentOwner :: Lens' PlayListItemsList (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.

plilVideoId :: Lens' PlayListItemsList (Maybe Text)

The videoId parameter specifies that the request should return only the playlist items that contain the specified video.

plilId :: Lens' PlayListItemsList (Maybe Text)

The id parameter specifies a comma-separated list of one or more unique playlist item IDs.

plilPageToken :: Lens' PlayListItemsList (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.

plilPlayListId :: Lens' PlayListItemsList (Maybe Text)

The playlistId parameter specifies the unique ID of the playlist for which you want to retrieve playlist items. Note that even though this is an optional parameter, every request to retrieve playlist items must specify a value for either the id parameter or the playlistId parameter.

plilMaxResults :: Lens' PlayListItemsList Word32

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