Network.Google.Resource.YouTube.LiveBroadcasts.List

Returns a list of YouTube broadcasts that match the API request parameters.

See: YouTube Data API Reference for youtube.liveBroadcasts.list.

REST Resource

type LiveBroadcastsListResource = "youtube" :> ("v3" :> ("liveBroadcasts" :> (QueryParam "part" Text :> (QueryParam "mine" Bool :> (QueryParam "broadcastStatus" LiveBroadcastsListBroadcastStatus :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "broadcastType" LiveBroadcastsListBroadcastType :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "id" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] LiveBroadcastListResponse))))))))))))

A resource alias for youtube.liveBroadcasts.list method which the LiveBroadcastsList request conforms to.

Creating a Request

liveBroadcastsList

Arguments

:: Text

lblPart

-> LiveBroadcastsList

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

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

• lblPart
• lblMine
• lblBroadcastStatus
• lblOnBehalfOfContentOwner
• lblBroadcastType
• lblOnBehalfOfContentOwnerChannel
• lblId
• lblPageToken
• lblMaxResults

data LiveBroadcastsList

Returns a list of YouTube broadcasts that match the API request parameters.

See: liveBroadcastsList smart constructor.

Instances

Eq LiveBroadcastsList

Methods

(==) :: LiveBroadcastsList -> LiveBroadcastsList -> Bool

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

Data LiveBroadcastsList

Methods

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

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

toConstr :: LiveBroadcastsList -> Constr

dataTypeOf :: LiveBroadcastsList -> DataType

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

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

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

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

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

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

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

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

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

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

Show LiveBroadcastsList

Methods

showsPrec :: Int -> LiveBroadcastsList -> ShowS

show :: LiveBroadcastsList -> String

showList :: [LiveBroadcastsList] -> ShowS

Generic LiveBroadcastsList

Associated Types

type Rep LiveBroadcastsList :: * -> *

Methods

from :: LiveBroadcastsList -> Rep LiveBroadcastsList x

to :: Rep LiveBroadcastsList x -> LiveBroadcastsList

GoogleRequest LiveBroadcastsList

Associated Types

type Rs LiveBroadcastsList :: *

type Scopes LiveBroadcastsList :: [Symbol]

Methods

requestClient :: LiveBroadcastsList -> Client (Rs LiveBroadcastsList)

type Rep LiveBroadcastsList

type Rep LiveBroadcastsList = D1 (MetaData "LiveBroadcastsList" "Network.Google.Resource.YouTube.LiveBroadcasts.List" "gogol-youtube-0.2.0-1ZihBky57dEGhFo5f57ZgQ" False) (C1 (MetaCons "LiveBroadcastsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lblPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_lblMine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_lblBroadcastStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LiveBroadcastsListBroadcastStatus))) (S1 (MetaSel (Just Symbol "_lblOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lblBroadcastType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LiveBroadcastsListBroadcastType)) (S1 (MetaSel (Just Symbol "_lblOnBehalfOfContentOwnerChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lblId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lblPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lblMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word32))))))))

type Scopes LiveBroadcastsList

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

type Rs LiveBroadcastsList

type Rs LiveBroadcastsList = LiveBroadcastListResponse

Request Lenses

lblPart :: Lens' LiveBroadcastsList Text

The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.

lblMine :: Lens' LiveBroadcastsList (Maybe Bool)

The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts.

lblBroadcastStatus :: Lens' LiveBroadcastsList (Maybe LiveBroadcastsListBroadcastStatus)

The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.

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

lblBroadcastType :: Lens' LiveBroadcastsList LiveBroadcastsListBroadcastType

The broadcastType parameter filters the API response to only include broadcasts with the specified type. This is only compatible with the mine filter for now.

lblOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsList (Maybe Text)

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.

lblId :: Lens' LiveBroadcastsList (Maybe Text)

The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID.

lblPageToken :: Lens' LiveBroadcastsList (Maybe Text)

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

lblMaxResults :: Lens' LiveBroadcastsList Word32

The maxResults parameter specifies the maximum number of items that should be returned in the result set.