Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.YouTube.ChannelBanners.Insert

Contents

REST Resource
Creating a Request
Request Lenses

Description

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. - Extract the url property's value from the response that the API returns for step 1. - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.

See: YouTube Data API Reference for youtube.channelBanners.insert.

Synopsis

type ChannelBannersInsertResource = ("youtube" :> ("v3" :> ("channelBanners" :> ("insert" :> (QueryParam "channelId" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ChannelBannerResource :> Post '[JSON] ChannelBannerResource)))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("channelBanners" :> ("insert" :> (QueryParam "channelId" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] ChannelBannerResource :> Post '[JSON] ChannelBannerResource))))))))))
channelBannersInsert :: ChannelBannerResource -> ChannelBannersInsert
data ChannelBannersInsert
cbiChannelId :: Lens' ChannelBannersInsert (Maybe Text)
cbiPayload :: Lens' ChannelBannersInsert ChannelBannerResource
cbiOnBehalfOfContentOwner :: Lens' ChannelBannersInsert (Maybe Text)

REST Resource

type ChannelBannersInsertResource = ("youtube" :> ("v3" :> ("channelBanners" :> ("insert" :> (QueryParam "channelId" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ChannelBannerResource :> Post '[JSON] ChannelBannerResource)))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("channelBanners" :> ("insert" :> (QueryParam "channelId" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] ChannelBannerResource :> Post '[JSON] ChannelBannerResource)))))))))) Source #

A resource alias for youtube.channelBanners.insert method which the ChannelBannersInsert request conforms to.

Creating a Request

channelBannersInsert Source #

Arguments

:: ChannelBannerResource	`cbiPayload`
-> ChannelBannersInsert

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

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

data ChannelBannersInsert Source #

Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. - Extract the url property's value from the response that the API returns for step 1. - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2.

See: channelBannersInsert smart constructor.

Instances

Eq ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert Methods (==) :: ChannelBannersInsert -> ChannelBannersInsert -> Bool # (/=) :: ChannelBannersInsert -> ChannelBannersInsert -> Bool #
Data ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChannelBannersInsert -> c ChannelBannersInsert # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChannelBannersInsert # toConstr :: ChannelBannersInsert -> Constr # dataTypeOf :: ChannelBannersInsert -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ChannelBannersInsert) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChannelBannersInsert) # gmapT :: (forall b. Data b => b -> b) -> ChannelBannersInsert -> ChannelBannersInsert # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChannelBannersInsert -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChannelBannersInsert -> r # gmapQ :: (forall d. Data d => d -> u) -> ChannelBannersInsert -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ChannelBannersInsert -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChannelBannersInsert -> m ChannelBannersInsert # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChannelBannersInsert -> m ChannelBannersInsert # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChannelBannersInsert -> m ChannelBannersInsert #
Show ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert Methods showsPrec :: Int -> ChannelBannersInsert -> ShowS # show :: ChannelBannersInsert -> String # showList :: [ChannelBannersInsert] -> ShowS #
Generic ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert Associated Types type Rep ChannelBannersInsert :: Type -> Type # Methods from :: ChannelBannersInsert -> Rep ChannelBannersInsert x # to :: Rep ChannelBannersInsert x -> ChannelBannersInsert #
GoogleRequest ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert Associated Types type Rs ChannelBannersInsert :: Type # type Scopes ChannelBannersInsert :: [Symbol] # Methods requestClient :: ChannelBannersInsert -> GClient (Rs ChannelBannersInsert) #
GoogleRequest (MediaUpload ChannelBannersInsert) Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert Associated Types type Rs (MediaUpload ChannelBannersInsert) :: Type # type Scopes (MediaUpload ChannelBannersInsert) :: [Symbol] # Methods requestClient :: MediaUpload ChannelBannersInsert -> GClient (Rs (MediaUpload ChannelBannersInsert)) #
type Rep ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert type Rep ChannelBannersInsert = D1 (MetaData "ChannelBannersInsert" "Network.Google.Resource.YouTube.ChannelBanners.Insert" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "ChannelBannersInsert'" PrefixI True) (S1 (MetaSel (Just "_cbiChannelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_cbiPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ChannelBannerResource) :: S1 (MetaSel (Just "_cbiOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Scopes ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert type Scopes ChannelBannersInsert = "https://www.googleapis.com/auth/youtube" ': ("https://www.googleapis.com/auth/youtube.force-ssl" ': ("https://www.googleapis.com/auth/youtube.upload" ': ([] :: [Symbol])))
type Rs ChannelBannersInsert Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert type Rs ChannelBannersInsert = ChannelBannerResource
type Scopes (MediaUpload ChannelBannersInsert) Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert type Scopes (MediaUpload ChannelBannersInsert) = Scopes ChannelBannersInsert
type Rs (MediaUpload ChannelBannersInsert) Source #
Instance details Defined in Network.Google.Resource.YouTube.ChannelBanners.Insert type Rs (MediaUpload ChannelBannersInsert) = ChannelBannerResource

Request Lenses

cbiChannelId :: Lens' ChannelBannersInsert (Maybe Text) Source #

The channelId parameter identifies the YouTube channel to which the banner is uploaded. The channelId parameter was introduced as a required parameter in May 2017. As this was a backward-incompatible change, channelBanners.insert requests that do not specify this parameter will not return an error until six months have passed from the time that the parameter was introduced. Please see the API Terms of Service for the official policy regarding backward incompatible changes and the API revision history for the exact date that the parameter was introduced.

cbiPayload :: Lens' ChannelBannersInsert ChannelBannerResource Source #

Multipart request metadata.

cbiOnBehalfOfContentOwner :: Lens' ChannelBannersInsert (Maybe Text) Source #

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.