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.Videos.Update

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates a video's metadata.

See: YouTube Data API Reference for youtube.videos.update.

Synopsis

type VideosUpdateResource = "youtube" :> ("v3" :> ("videos" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Video :> Put '[JSON] Video))))))
videosUpdate :: Text -> Video -> VideosUpdate
data VideosUpdate
vuPart :: Lens' VideosUpdate Text
vuPayload :: Lens' VideosUpdate Video
vuOnBehalfOfContentOwner :: Lens' VideosUpdate (Maybe Text)

REST Resource

type VideosUpdateResource = "youtube" :> ("v3" :> ("videos" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Video :> Put '[JSON] Video)))))) Source #

A resource alias for youtube.videos.update method which the VideosUpdate request conforms to.

Creating a Request

videosUpdate Source #

Arguments

:: Text	`vuPart`
-> Video	`vuPayload`
-> VideosUpdate

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

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

data VideosUpdate Source #

Updates a video's metadata.

See: videosUpdate smart constructor.

Instances

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

Request Lenses

vuPart :: Lens' VideosUpdate Text Source #

The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

vuPayload :: Lens' VideosUpdate Video Source #

Multipart request metadata.

vuOnBehalfOfContentOwner :: Lens' VideosUpdate (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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.