Network.Google.Resource.YouTube.Videos.List

Returns a list of videos that match the API request parameters.

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

REST Resource

type VideosListResource = "youtube" :> ("v3" :> ("videos" :> (QueryParam "part" Text :> (QueryParam "chart" VideosListChart :> (QueryParam "regionCode" Text :> (QueryParam "locale" Text :> (QueryParam "myRating" VideosListMyRating :> (QueryParam "maxHeight" (Textual Word32) :> (QueryParam "hl" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "videoCategoryId" Text :> (QueryParam "maxWidth" (Textual Word32) :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] VideoListResponse))))))))))))))))

A resource alias for youtube.videos.list method which the VideosList request conforms to.

Creating a Request

videosList

Arguments

:: Text

vlPart

-> VideosList

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

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

• vlChart
• vlPart
• vlRegionCode
• vlLocale
• vlMyRating
• vlMaxHeight
• vlHl
• vlOnBehalfOfContentOwner
• vlVideoCategoryId
• vlMaxWidth
• vlId
• vlPageToken
• vlMaxResults

data VideosList

Returns a list of videos that match the API request parameters.

See: videosList smart constructor.

Instances

Eq VideosList

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

Methods

(==) :: VideosList -> VideosList -> Bool

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

Data VideosList

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

Methods

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

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

toConstr :: VideosList -> Constr

dataTypeOf :: VideosList -> DataType

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

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

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

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

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

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

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

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

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

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

Show VideosList

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

Methods

showsPrec :: Int -> VideosList -> ShowS

show :: VideosList -> String

showList :: [VideosList] -> ShowS

Generic VideosList

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

Associated Types

type Rep VideosList :: Type -> Type

Methods

from :: VideosList -> Rep VideosList x

to :: Rep VideosList x -> VideosList

GoogleRequest VideosList

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

Associated Types

type Rs VideosList :: Type

type Scopes VideosList :: [Symbol]

Methods

requestClient :: VideosList -> GClient (Rs VideosList)

type Rep VideosList

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

type Rep VideosList = D1 (MetaData "VideosList" "Network.Google.Resource.YouTube.Videos.List" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "VideosList'" PrefixI True) (((S1 (MetaSel (Just "_vlChart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VideosListChart)) :*: (S1 (MetaSel (Just "_vlPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_vlRegionCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_vlLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_vlMyRating") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VideosListMyRating)) :*: S1 (MetaSel (Just "_vlMaxHeight") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))) :*: ((S1 (MetaSel (Just "_vlHl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_vlOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_vlVideoCategoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_vlMaxWidth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: S1 (MetaSel (Just "_vlId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_vlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_vlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))))

type Scopes VideosList

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

type Scopes VideosList = "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 VideosList

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

type Rs VideosList = VideoListResponse

Request Lenses

vlChart :: Lens' VideosList (Maybe VideosListChart)

The chart parameter identifies the chart that you want to retrieve.

vlPart :: Lens' VideosList Text

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

vlRegionCode :: Lens' VideosList (Maybe Text)

The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code.

vlLocale :: Lens' VideosList (Maybe Text)

DEPRECATED

vlMyRating :: Lens' VideosList (Maybe VideosListMyRating)

Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.

vlMaxHeight :: Lens' VideosList (Maybe Word32)

The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request.

vlHl :: Lens' VideosList (Maybe Text)

The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.

vlOnBehalfOfContentOwner :: Lens' VideosList (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.

vlVideoCategoryId :: Lens' VideosList Text

The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category.

vlMaxWidth :: Lens' VideosList (Maybe Word32)

The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request.

vlId :: Lens' VideosList (Maybe Text)

The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.

vlPageToken :: Lens' VideosList (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. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.

vlMaxResults :: Lens' VideosList Word32

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.