Network.Google.Resource.YouTube.Sponsors.List

Lists sponsors for a channel.

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

REST Resource

type SponsorsListResource = "youtube" :> ("v3" :> ("sponsors" :> (QueryParam "part" Text :> (QueryParam "filter" SponsorsListFilter :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] SponsorListResponse)))))))

A resource alias for youtube.sponsors.list method which the SponsorsList request conforms to.

Creating a Request

sponsorsList

Arguments

:: Text

sPart

-> SponsorsList

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

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

• sPart
• sFilter
• sPageToken
• sMaxResults

data SponsorsList

Lists sponsors for a channel.

See: sponsorsList smart constructor.

Instances

Eq SponsorsList

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

Methods

(==) :: SponsorsList -> SponsorsList -> Bool

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

Data SponsorsList

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

Methods

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

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

toConstr :: SponsorsList -> Constr

dataTypeOf :: SponsorsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show SponsorsList

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

Methods

showsPrec :: Int -> SponsorsList -> ShowS

show :: SponsorsList -> String

showList :: [SponsorsList] -> ShowS

Generic SponsorsList

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

Associated Types

type Rep SponsorsList :: Type -> Type

Methods

from :: SponsorsList -> Rep SponsorsList x

to :: Rep SponsorsList x -> SponsorsList

GoogleRequest SponsorsList

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

Associated Types

type Rs SponsorsList :: Type

type Scopes SponsorsList :: [Symbol]

Methods

requestClient :: SponsorsList -> GClient (Rs SponsorsList)

type Rep SponsorsList

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

type Rep SponsorsList = D1 (MetaData "SponsorsList" "Network.Google.Resource.YouTube.Sponsors.List" "gogol-youtube-0.5.0-E1wAk7ot8IcIJSF7D3gEAs" False) (C1 (MetaCons "SponsorsList'" PrefixI True) ((S1 (MetaSel (Just "_sPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SponsorsListFilter)) :*: (S1 (MetaSel (Just "_sPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32)))))

type Scopes SponsorsList

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

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

type Rs SponsorsList

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

type Rs SponsorsList = SponsorListResponse

Request Lenses

sPart :: Lens' SponsorsList Text

The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.

sFilter :: Lens' SponsorsList SponsorsListFilter

The filter parameter specifies which channel sponsors to return.

sPageToken :: Lens' SponsorsList (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.

sMaxResults :: Lens' SponsorsList Word32

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