Network.Google.Resource.YouTube.Captions.Update

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

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

REST Resource

type CaptionsUpdateResource = ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Caption :> Put '[JSON] Caption))))))))) :<|> ("upload" :> ("youtube" :> ("v3" :> ("captions" :> (QueryParam "part" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "sync" Bool :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] Caption :> Put '[JSON] Caption)))))))))))

A resource alias for youtube.captions.update method which the CaptionsUpdate request conforms to.

Creating a Request

captionsUpdate

Arguments

:: Text

capPart

-> Caption

capPayload

-> CaptionsUpdate

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

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

• capOnBehalfOf
• capPart
• capPayload
• capOnBehalfOfContentOwner
• capSync

data CaptionsUpdate

Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both.

See: captionsUpdate smart constructor.

Instances

Eq CaptionsUpdate

Methods

(==) :: CaptionsUpdate -> CaptionsUpdate -> Bool

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

Data CaptionsUpdate

Methods

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

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

toConstr :: CaptionsUpdate -> Constr

dataTypeOf :: CaptionsUpdate -> DataType

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

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

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

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

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

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

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

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

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

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

Show CaptionsUpdate

Methods

showsPrec :: Int -> CaptionsUpdate -> ShowS

show :: CaptionsUpdate -> String

showList :: [CaptionsUpdate] -> ShowS

Generic CaptionsUpdate

Associated Types

type Rep CaptionsUpdate :: * -> *

Methods

from :: CaptionsUpdate -> Rep CaptionsUpdate x

to :: Rep CaptionsUpdate x -> CaptionsUpdate

GoogleRequest CaptionsUpdate

Associated Types

type Rs CaptionsUpdate :: *

type Scopes CaptionsUpdate :: [Symbol]

Methods

requestClient :: CaptionsUpdate -> Client (Rs CaptionsUpdate)

GoogleRequest (MediaUpload CaptionsUpdate)

Associated Types

type Rs (MediaUpload CaptionsUpdate) :: *

type Scopes (MediaUpload CaptionsUpdate) :: [Symbol]

Methods

requestClient :: MediaUpload CaptionsUpdate -> Client (Rs (MediaUpload CaptionsUpdate))

type Rep CaptionsUpdate

type Rep CaptionsUpdate = D1 (MetaData "CaptionsUpdate" "Network.Google.Resource.YouTube.Captions.Update" "gogol-youtube-0.3.0-2CKT3iLSir83mLosJE4Zg" False) (C1 (MetaCons "CaptionsUpdate'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_capOnBehalfOf") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_capPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_capPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Caption)) ((:*:) (S1 (MetaSel (Just Symbol "_capOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_capSync") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))))

type Scopes CaptionsUpdate

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

type Rs CaptionsUpdate

type Rs CaptionsUpdate = Caption

type Scopes (MediaUpload CaptionsUpdate)

type Scopes (MediaUpload CaptionsUpdate) = Scopes CaptionsUpdate

type Rs (MediaUpload CaptionsUpdate)

type Rs (MediaUpload CaptionsUpdate) = Caption

Request Lenses

capOnBehalfOf :: Lens' CaptionsUpdate (Maybe Text)

ID of the Google+ Page for the channel that the request is be on behalf of

capPart :: Lens' CaptionsUpdate Text

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. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.

capPayload :: Lens' CaptionsUpdate Caption

Multipart request metadata.

capOnBehalfOfContentOwner :: Lens' CaptionsUpdate (Maybe Text)

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.

capSync :: Lens' CaptionsUpdate (Maybe Bool)

Note: The API server only processes the parameter value if the request contains an updated caption file. The sync parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to true, YouTube will automatically synchronize the caption track with the audio track.