{-# LANGUAGE DataKinds #-} {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeOperators #-} {-# OPTIONS_GHC -fno-warn-duplicate-exports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} -- | -- Module : Network.Google.Resource.YouTube.ChannelBanners.Insert -- Copyright : (c) 2015-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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:/ for @youtube.channelBanners.insert@. module Network.Google.Resource.YouTube.ChannelBanners.Insert ( -- * REST Resource ChannelBannersInsertResource -- * Creating a Request , channelBannersInsert , ChannelBannersInsert -- * Request Lenses , cbiPayload , cbiOnBehalfOfContentOwner ) where import Network.Google.Prelude import Network.Google.YouTube.Types -- | A resource alias for @youtube.channelBanners.insert@ method which the -- 'ChannelBannersInsert' request conforms to. type ChannelBannersInsertResource = "youtube" :> "v3" :> "channelBanners" :> "insert" :> QueryParam "onBehalfOfContentOwner" Text :> QueryParam "alt" AltJSON :> ReqBody '[JSON] ChannelBannerResource :> Post '[JSON] ChannelBannerResource :<|> "upload" :> "youtube" :> "v3" :> "channelBanners" :> "insert" :> QueryParam "onBehalfOfContentOwner" Text :> QueryParam "alt" AltJSON :> QueryParam "uploadType" Multipart :> MultipartRelated '[JSON] ChannelBannerResource :> Post '[JSON] ChannelBannerResource -- | 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. data ChannelBannersInsert = ChannelBannersInsert' { _cbiPayload :: !ChannelBannerResource , _cbiOnBehalfOfContentOwner :: !(Maybe Text) } deriving (Eq,Show,Data,Typeable,Generic) -- | 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: -- -- * 'cbiPayload' -- -- * 'cbiOnBehalfOfContentOwner' channelBannersInsert :: ChannelBannerResource -- ^ 'cbiPayload' -> ChannelBannersInsert channelBannersInsert pCbiPayload_ = ChannelBannersInsert' { _cbiPayload = pCbiPayload_ , _cbiOnBehalfOfContentOwner = Nothing } -- | Multipart request metadata. cbiPayload :: Lens' ChannelBannersInsert ChannelBannerResource cbiPayload = lens _cbiPayload (\ s a -> s{_cbiPayload = a}) -- | 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. cbiOnBehalfOfContentOwner :: Lens' ChannelBannersInsert (Maybe Text) cbiOnBehalfOfContentOwner = lens _cbiOnBehalfOfContentOwner (\ s a -> s{_cbiOnBehalfOfContentOwner = a}) instance GoogleRequest ChannelBannersInsert where type Rs ChannelBannersInsert = ChannelBannerResource type Scopes ChannelBannersInsert = '["https://www.googleapis.com/auth/youtube", "https://www.googleapis.com/auth/youtube.force-ssl", "https://www.googleapis.com/auth/youtube.upload"] requestClient ChannelBannersInsert'{..} = go _cbiOnBehalfOfContentOwner (Just AltJSON) _cbiPayload youTubeService where go :<|> _ = buildClient (Proxy :: Proxy ChannelBannersInsertResource) mempty instance GoogleRequest (MediaUpload ChannelBannersInsert) where type Rs (MediaUpload ChannelBannersInsert) = ChannelBannerResource type Scopes (MediaUpload ChannelBannersInsert) = Scopes ChannelBannersInsert requestClient (MediaUpload ChannelBannersInsert'{..} body) = go _cbiOnBehalfOfContentOwner (Just AltJSON) (Just Multipart) _cbiPayload body youTubeService where _ :<|> go = buildClient (Proxy :: Proxy ChannelBannersInsertResource) mempty