| Copyright | (c) 2015 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
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.
- 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" AltMedia :> (MultipartRelated `[JSON]` ChannelBannerResource RequestBody :> Post `[JSON]` ChannelBannerResource)))))))))
- channelBannersInsert :: ChannelBannerResource -> ChannelBannersInsert
- data ChannelBannersInsert
- cbiPayload :: Lens' ChannelBannersInsert ChannelBannerResource
- cbiOnBehalfOfContentOwner :: Lens' ChannelBannersInsert (Maybe Text)
REST Resource
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" AltMedia :> (MultipartRelated `[JSON]` ChannelBannerResource RequestBody :> Post `[JSON]` ChannelBannerResource))))))))) Source
A resource alias for youtube.channelBanners.insert method which the
ChannelBannersInsert request conforms to.
Creating a Request
Arguments
| :: ChannelBannerResource | |
| -> 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
Request Lenses
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.