Network.Google.Resource.YouTube.Captions.Download

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

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

REST Resource

type CaptionsDownloadResource = ("youtube" :> ("v3" :> ("captions" :> (Capture "id" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "tlang" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "tfmt" CaptionsDownloadTfmt :> (QueryParam "alt" AltJSON :> Get '[JSON] ()))))))))) :<|> ("youtube" :> ("v3" :> ("captions" :> (Capture "id" Text :> (QueryParam "onBehalfOf" Text :> (QueryParam "tlang" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "tfmt" CaptionsDownloadTfmt :> (QueryParam "alt" AltMedia :> Get '[OctetStream] Stream)))))))))

A resource alias for youtube.captions.download method which the CaptionsDownload request conforms to.

Creating a Request

captionsDownload

Arguments

:: Text

capaId

-> CaptionsDownload

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

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

• capaOnBehalfOf
• capaTlang
• capaOnBehalfOfContentOwner
• capaId
• capaTfmt

data CaptionsDownload

Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter.

See: captionsDownload smart constructor.

Instances

Eq CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

Methods

(==) :: CaptionsDownload -> CaptionsDownload -> Bool

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

Data CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

Methods

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

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

toConstr :: CaptionsDownload -> Constr

dataTypeOf :: CaptionsDownload -> DataType

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

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

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

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

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

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

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

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

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

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

Show CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

Methods

showsPrec :: Int -> CaptionsDownload -> ShowS

show :: CaptionsDownload -> String

showList :: [CaptionsDownload] -> ShowS

Generic CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

Associated Types

type Rep CaptionsDownload :: Type -> Type

Methods

from :: CaptionsDownload -> Rep CaptionsDownload x

to :: Rep CaptionsDownload x -> CaptionsDownload

GoogleRequest CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

Associated Types

type Rs CaptionsDownload :: Type

type Scopes CaptionsDownload :: [Symbol]

Methods

requestClient :: CaptionsDownload -> GClient (Rs CaptionsDownload)

GoogleRequest (MediaDownload CaptionsDownload)

Defined in Network.Google.Resource.YouTube.Captions.Download

Associated Types

type Rs (MediaDownload CaptionsDownload) :: Type

type Scopes (MediaDownload CaptionsDownload) :: [Symbol]

Methods

requestClient :: MediaDownload CaptionsDownload -> GClient (Rs (MediaDownload CaptionsDownload))

type Rep CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

type Rep CaptionsDownload = D1 (MetaData "CaptionsDownload" "Network.Google.Resource.YouTube.Captions.Download" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "CaptionsDownload'" PrefixI True) ((S1 (MetaSel (Just "_capaOnBehalfOf") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_capaTlang") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_capaOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_capaId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_capaTfmt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CaptionsDownloadTfmt))))))

type Scopes CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

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

type Rs CaptionsDownload

Defined in Network.Google.Resource.YouTube.Captions.Download

type Rs CaptionsDownload = ()

type Scopes (MediaDownload CaptionsDownload)

Defined in Network.Google.Resource.YouTube.Captions.Download

type Scopes (MediaDownload CaptionsDownload) = Scopes CaptionsDownload

type Rs (MediaDownload CaptionsDownload)

Defined in Network.Google.Resource.YouTube.Captions.Download

type Rs (MediaDownload CaptionsDownload) = Stream

Request Lenses

capaOnBehalfOf :: Lens' CaptionsDownload (Maybe Text)

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

capaTlang :: Lens' CaptionsDownload (Maybe Text)

The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.

capaOnBehalfOfContentOwner :: Lens' CaptionsDownload (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.

capaId :: Lens' CaptionsDownload Text

The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

capaTfmt :: Lens' CaptionsDownload (Maybe CaptionsDownloadTfmt)

The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.