Network.Google.Resource.YouTube.Channels.List

Returns a collection of zero or more channel resources that match the request criteria.

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

REST Resource

type ChannelsListResource = "youtube" :> ("v3" :> ("channels" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "forUsername" Text :> (QueryParam "hl" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "categoryId" Text :> (QueryParam "id" Text :> (QueryParam "mySubscribers" Bool :> (QueryParam "pageToken" Text :> (QueryParam "managedByMe" Bool :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] ChannelListResponse))))))))))))))

A resource alias for youtube.channels.list method which the ChannelsList request conforms to.

Creating a Request

channelsList

Arguments

:: Text

cPart

-> ChannelsList

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

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

• cPart
• cMine
• cForUsername
• cHl
• cOnBehalfOfContentOwner
• cCategoryId
• cId
• cMySubscribers
• cPageToken
• cManagedByMe
• cMaxResults

data ChannelsList

Returns a collection of zero or more channel resources that match the request criteria.

See: channelsList smart constructor.

Instances

Eq ChannelsList

Methods

(==) :: ChannelsList -> ChannelsList -> Bool

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

Data ChannelsList

Methods

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

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

toConstr :: ChannelsList -> Constr

dataTypeOf :: ChannelsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show ChannelsList

Methods

showsPrec :: Int -> ChannelsList -> ShowS

show :: ChannelsList -> String

showList :: [ChannelsList] -> ShowS

Generic ChannelsList

Associated Types

type Rep ChannelsList :: * -> *

Methods

from :: ChannelsList -> Rep ChannelsList x

to :: Rep ChannelsList x -> ChannelsList

GoogleRequest ChannelsList

Associated Types

type Rs ChannelsList :: *

type Scopes ChannelsList :: [Symbol]

Methods

requestClient :: ChannelsList -> Client (Rs ChannelsList)

type Rep ChannelsList

type Rep ChannelsList = D1 (MetaData "ChannelsList" "Network.Google.Resource.YouTube.Channels.List" "gogol-youtube-0.1.1-BKvHJYv3Lac2eVp6D9Sfdq" False) (C1 (MetaCons "ChannelsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cMine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_cForUsername") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cHl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cCategoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cMySubscribers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) (S1 (MetaSel (Just Symbol "_cPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cManagedByMe") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_cMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))))

type Scopes ChannelsList

type Scopes ChannelsList = (:) 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 "https://www.googleapis.com/auth/youtubepartner-channel-audit" ([] Symbol)))))

type Rs ChannelsList

type Rs ChannelsList = ChannelListResponse

Request Lenses

cPart :: Lens' ChannelsList Text

The part parameter specifies a comma-separated list of one or more channel 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 channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set part=contentDetails, the API response will also contain all of those nested properties.

cMine :: Lens' ChannelsList (Maybe Bool)

Set this parameter's value to true to instruct the API to only return channels owned by the authenticated user.

cForUsername :: Lens' ChannelsList (Maybe Text)

The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.

cHl :: Lens' ChannelsList (Maybe Text)

The hl parameter should be used for filter out the properties that are not in the given language. Used for the brandingSettings part.

cOnBehalfOfContentOwner :: Lens' ChannelsList (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.

cCategoryId :: Lens' ChannelsList (Maybe Text)

The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.

cId :: Lens' ChannelsList (Maybe Text)

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

cMySubscribers :: Lens' ChannelsList (Maybe Bool)

Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers to the authenticated user's channel.

cPageToken :: Lens' ChannelsList (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.

cManagedByMe :: Lens' ChannelsList (Maybe Bool)

Note: This parameter is intended exclusively for YouTube content partners. Set this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.

cMaxResults :: Lens' ChannelsList Word32

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