gogol-youtube-0.0.1: Google YouTube Data SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.YouTube.Types

Contents

Description

 

Synopsis

Service Configuration

youTubeService :: Service Source

Default request referring to version v3 of the YouTube Data API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

youtubeUploadScope :: OAuthScope Source

Manage your YouTube videos

youtubeScope :: OAuthScope Source

Manage your YouTube account

youtubepartnerScope :: OAuthScope Source

View and manage your assets and associated content on YouTube

youtubeForceSslScope :: OAuthScope Source

Manage your YouTube account

youtubeReadonlyScope :: OAuthScope Source

View your YouTube account

youtubepartnerChannelAuditScope :: OAuthScope Source

View private information of your YouTube channel relevant during the audit process with a YouTube partner

ContentRatingCceRating

data ContentRatingCceRating Source

The video's rating from Portugal's Comissão de Classificação de Espect´culos.

Constructors

CCEM12
cceM12
CCEM16
cceM16
CCEM18
cceM18
CCEM4
cceM4
CCEM6
cceM6
CceUnrated
cceUnrated

Instances

ContentRatingChfilmRating

data ContentRatingChfilmRating Source

The video's rating in Switzerland.

Constructors

CHFILM0
chfilm0
CHFILM12
chfilm12
CHFILM16
chfilm16
CHFILM18
chfilm18
CHFILM6
chfilm6
ChfilmUnrated
chfilmUnrated

Instances

SubscriptionSubscriberSnippet

data SubscriptionSubscriberSnippet Source

Basic details about a subscription's subscriber including title, description, channel ID and thumbnails.

See: subscriptionSubscriberSnippet smart constructor.

Instances

subscriptionSubscriberSnippet :: SubscriptionSubscriberSnippet Source

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

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

sssChannelId :: Lens' SubscriptionSubscriberSnippet (Maybe Text) Source

The channel ID of the subscriber.

sssThumbnails :: Lens' SubscriptionSubscriberSnippet (Maybe ThumbnailDetails) Source

Thumbnails for this subscriber.

sssTitle :: Lens' SubscriptionSubscriberSnippet (Maybe Text) Source

The title of the subscriber.

sssDescription :: Lens' SubscriptionSubscriberSnippet (Maybe Text) Source

The description of the subscriber.

ContentRatingMccaaRating

data ContentRatingMccaaRating Source

The video's rating from Malta's Film Age-Classification Board.

Constructors

MCCAA12
mccaa12
Mccaa12a
mccaa12a
MCCAA14
mccaa14
MCCAA15
mccaa15
MCCAA16
mccaa16
MCCAA18
mccaa18
MccaaPg
mccaaPg
MccaaU
mccaaU
MccaaUnrated
mccaaUnrated

Instances

VideosListChart

data VideosListChart Source

The chart parameter identifies the chart that you want to retrieve.

Constructors

MostPopular

mostPopular Return the most popular videos for the specified content region and video category.

Instances

IngestionInfo

data IngestionInfo Source

Describes information necessary for ingesting an RTMP or an HTTP stream.

See: ingestionInfo smart constructor.

Instances

ingestionInfo :: IngestionInfo Source

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

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

iiBackupIngestionAddress :: Lens' IngestionInfo (Maybe Text) Source

The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL.

iiIngestionAddress :: Lens' IngestionInfo (Maybe Text) Source

The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format: STREAM_URL/STREAM_NAME

iiStreamName :: Lens' IngestionInfo (Maybe Text) Source

The HTTP or RTMP stream name that YouTube assigns to the video stream.

ChannelAuditDetails

data ChannelAuditDetails Source

The auditDetails object encapsulates channel data that is relevant for YouTube Partners during the audit process.

See: channelAuditDetails smart constructor.

Instances

channelAuditDetails :: ChannelAuditDetails Source

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

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

cadContentIdClaimsGoodStanding :: Lens' ChannelAuditDetails (Maybe Bool) Source

Whether or not the channel has any unresolved claims.

cadOverallGoodStanding :: Lens' ChannelAuditDetails (Maybe Bool) Source

Describes the general state of the channel. This field will always show if there are any issues whatsoever with the channel. Currently this field represents the result of the logical and operation over the community guidelines good standing, the copyright strikes good standing and the content ID claims good standing, but this may change in the future.

cadCopyrightStrikesGoodStanding :: Lens' ChannelAuditDetails (Maybe Bool) Source

Whether or not the channel has any copyright strikes.

cadCommUnityGuidelinesGoodStanding :: Lens' ChannelAuditDetails (Maybe Bool) Source

Whether or not the channel respects the community guidelines.

Thumbnail

data Thumbnail Source

A thumbnail is an image representing a YouTube resource.

See: thumbnail smart constructor.

Instances

thumbnail :: Thumbnail Source

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

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

tHeight :: Lens' Thumbnail (Maybe Word32) Source

(Optional) Height of the thumbnail image.

tURL :: Lens' Thumbnail (Maybe Text) Source

The thumbnail image's URL.

tWidth :: Lens' Thumbnail (Maybe Word32) Source

(Optional) Width of the thumbnail image.

ContentRatingMpaaRating

data ContentRatingMpaaRating Source

The video's Motion Picture Association of America (MPAA) rating.

Constructors

MpaaG
mpaaG
MPAANC17
mpaaNc17
MpaaPg
mpaaPg
MPAAPG13
mpaaPg13
MpaaR
mpaaR
MpaaUnrated
mpaaUnrated

Instances

CaptionSnippetTrackKind

data CaptionSnippetTrackKind Source

The caption track's type.

Constructors

Asr
ASR
Forced
forced
Standard
standard

Instances

VideoSnippetLiveBroadcastContent

data VideoSnippetLiveBroadcastContent Source

Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.

Constructors

Live
live
None
none
Upcoming
upcoming

Instances

ChannelConversionPingContext

data ChannelConversionPingContext Source

Defines the context of the ping.

Constructors

Cview
cview
Subscribe
subscribe
Unsubscribe
unsubscribe

Instances

ActivityContentDetailsRecommendation

data ActivityContentDetailsRecommendation Source

Information that identifies the recommended resource.

See: activityContentDetailsRecommendation smart constructor.

Instances

activityContentDetailsRecommendation :: ActivityContentDetailsRecommendation Source

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

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

acdrResourceId :: Lens' ActivityContentDetailsRecommendation (Maybe ResourceId) Source

The resourceId object contains information that identifies the recommended resource.

acdrSeedResourceId :: Lens' ActivityContentDetailsRecommendation (Maybe ResourceId) Source

The seedResourceId object contains information about the resource that caused the recommendation.

acdrReason :: Lens' ActivityContentDetailsRecommendation (Maybe ActivityContentDetailsRecommendationReason) Source

The reason that the resource is recommended to the user.

ContentRatingRcnofRating

data ContentRatingRcnofRating Source

The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film.

Constructors

RcnofI
rcnofI
RcnofIi
rcnofIi
RcnofIii
rcnofIii
RcnofIv
rcnofIv
RcnofUnrated
rcnofUnrated
RcnofV
rcnofV
RcnofVi
rcnofVi

Instances

PlayListListResponse

data PlayListListResponse Source

Instances

playListListResponse :: PlayListListResponse Source

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

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

pllrEtag :: Lens' PlayListListResponse (Maybe Text) Source

Etag of this resource.

pllrTokenPagination :: Lens' PlayListListResponse (Maybe TokenPagination) Source

pllrNextPageToken :: Lens' PlayListListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

pllrPageInfo :: Lens' PlayListListResponse (Maybe PageInfo) Source

pllrKind :: Lens' PlayListListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#playlistListResponse".

pllrItems :: Lens' PlayListListResponse [PlayList] Source

A list of playlists that match the request criteria.

pllrVisitorId :: Lens' PlayListListResponse (Maybe Text) Source

The visitorId identifies the visitor.

pllrEventId :: Lens' PlayListListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

pllrPrevPageToken :: Lens' PlayListListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

VideoStatusPrivacyStatus

data VideoStatusPrivacyStatus Source

The video's privacy status.

Constructors

Private
private
Public
public
UnListed
unlisted

Instances

ChannelSectionSnippet

data ChannelSectionSnippet Source

Basic details about a channel section, including title, style and position.

See: channelSectionSnippet smart constructor.

Instances

channelSectionSnippet :: ChannelSectionSnippet Source

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

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

cssStyle :: Lens' ChannelSectionSnippet (Maybe ChannelSectionSnippetStyle) Source

The style of the channel section.

cssChannelId :: Lens' ChannelSectionSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel that published the channel section.

cssLocalized :: Lens' ChannelSectionSnippet (Maybe ChannelSectionLocalization) Source

Localized title, read-only.

cssTitle :: Lens' ChannelSectionSnippet (Maybe Text) Source

The channel section's title for multiple_playlists and multiple_channels.

cssType :: Lens' ChannelSectionSnippet (Maybe ChannelSectionSnippetType) Source

The type of the channel section.

cssPosition :: Lens' ChannelSectionSnippet (Maybe Word32) Source

The position of the channel section in the channel.

cssDefaultLanguage :: Lens' ChannelSectionSnippet (Maybe Text) Source

The language of the channel section's default title and description.

ChannelStatus

data ChannelStatus Source

JSON template for the status part of a channel.

See: channelStatus smart constructor.

Instances

channelStatus :: ChannelStatus Source

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

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

csIsLinked :: Lens' ChannelStatus (Maybe Bool) Source

If true, then the user is linked to either a YouTube username or G+ account. Otherwise, the user doesn't have a public YouTube identity.

csLongUploadsStatus :: Lens' ChannelStatus (Maybe ChannelStatusLongUploadsStatus) Source

The long uploads status of this channel. See

csPrivacyStatus :: Lens' ChannelStatus (Maybe ChannelStatusPrivacyStatus) Source

Privacy status of the channel.

LiveBroadcastStatusLifeCycleStatus

data LiveBroadcastStatusLifeCycleStatus Source

The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

Constructors

LBSLCSAbandoned
abandoned
LBSLCSComplete
complete
LBSLCSCompleteStarting
completeStarting
LBSLCSCreated
created
LBSLCSLive
live
LBSLCSLiveStarting
liveStarting
LBSLCSReady
ready
LBSLCSReclaimed
reclaimed
LBSLCSRevoked
revoked
LBSLCSTestStarting
testStarting
LBSLCSTesting
testing

Instances

CaptionSnippetFailureReason

data CaptionSnippetFailureReason Source

The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.

Constructors

ProcessingFailed
processingFailed
UnknownFormat
unknownFormat
UnsupportedFormat
unsupportedFormat

Instances

PromotedItem

data PromotedItem Source

Describes a single promoted item.

See: promotedItem smart constructor.

Instances

promotedItem :: PromotedItem Source

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

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

piCustomMessage :: Lens' PromotedItem (Maybe Text) Source

A custom message to display for this promotion. This field is currently ignored unless the promoted item is a website.

piPromotedByContentOwner :: Lens' PromotedItem (Maybe Bool) Source

If true, the content owner's name will be used when displaying the promotion. This field can only be set when the update is made on behalf of the content owner.

piId :: Lens' PromotedItem (Maybe PromotedItemId) Source

Identifies the promoted item.

piTiming :: Lens' PromotedItem (Maybe InvideoTiming) Source

The temporal position within the video where the promoted item will be displayed. If present, it overrides the default timing.

VideoProcessingDetailsProcessingFailureReason

data VideoProcessingDetailsProcessingFailureReason Source

The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.

Constructors

Other
other
StreamingFailed
streamingFailed
TranscodeFailed
transcodeFailed
UploadFailed
uploadFailed

Instances

InvideoPositionType

data InvideoPositionType Source

Defines the position type.

Constructors

Corner
corner

Instances

LiveStreamSnippet

data LiveStreamSnippet Source

Instances

liveStreamSnippet :: LiveStreamSnippet Source

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

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

lssPublishedAt :: Lens' LiveStreamSnippet (Maybe UTCTime) Source

The date and time that the stream was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

lssChannelId :: Lens' LiveStreamSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel that is transmitting the stream.

lssIsDefaultStream :: Lens' LiveStreamSnippet (Maybe Bool) Source

lssTitle :: Lens' LiveStreamSnippet (Maybe Text) Source

The stream's title. The value must be between 1 and 128 characters long.

lssDescription :: Lens' LiveStreamSnippet (Maybe Text) Source

The stream's description. The value cannot be longer than 10000 characters.

ContentRatingFskRating

data ContentRatingFskRating Source

The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating.

Constructors

FSK0
fsk0
FSK12
fsk12
FSK16
fsk16
FSK18
fsk18
FSK6
fsk6
FskUnrated
fskUnrated

Instances

SearchResult

data SearchResult Source

A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.

See: searchResult smart constructor.

Instances

searchResult :: SearchResult Source

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

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

srEtag :: Lens' SearchResult (Maybe Text) Source

Etag of this resource.

srSnippet :: Lens' SearchResult (Maybe SearchResultSnippet) Source

The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.

srKind :: Lens' SearchResult Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult".

srId :: Lens' SearchResult (Maybe ResourceId) Source

The id object contains information that can be used to uniquely identify the resource that matches the search request.

ContentRatingMekuRating

data ContentRatingMekuRating Source

The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute).

Constructors

MEKU12
meku12
MEKU16
meku16
MEKU18
meku18
MEKU7
meku7
MekuS
mekuS
MekuUnrated
mekuUnrated

Instances

TokenPagination

data TokenPagination Source

Stub token pagination template to suppress results.

See: tokenPagination smart constructor.

Instances

tokenPagination :: TokenPagination Source

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

ResourceId

data ResourceId Source

A resource id is a generic reference that points to another YouTube resource.

See: resourceId smart constructor.

Instances

resourceId :: ResourceId Source

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

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

riKind :: Lens' ResourceId (Maybe Text) Source

The type of the API resource.

riChannelId :: Lens' ResourceId (Maybe Text) Source

The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.

riVideoId :: Lens' ResourceId (Maybe Text) Source

The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.

riPlayListId :: Lens' ResourceId (Maybe Text) Source

The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.

VideoContentDetailsDefinition

data VideoContentDetailsDefinition Source

The value of definition indicates whether the video is available in high definition or only in standard definition.

Constructors

HD
hd
SD
sd

Instances

ContentRatingEefilmRating

data ContentRatingEefilmRating Source

The video's rating in Estonia.

Constructors

EEFILMK12
eefilmK12
EEFILMK14
eefilmK14
EEFILMK16
eefilmK16
EEFILMK6
eefilmK6
EefilmL
eefilmL
EEFILMMS12
eefilmMs12
EEFILMMS6
eefilmMs6
EefilmPere
eefilmPere
EefilmUnrated
eefilmUnrated

Instances

SearchListResponse

data SearchListResponse Source

Instances

searchListResponse :: SearchListResponse Source

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

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

slrEtag :: Lens' SearchListResponse (Maybe Text) Source

Etag of this resource.

slrTokenPagination :: Lens' SearchListResponse (Maybe TokenPagination) Source

slrNextPageToken :: Lens' SearchListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

slrPageInfo :: Lens' SearchListResponse (Maybe PageInfo) Source

slrKind :: Lens' SearchListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#searchListResponse".

slrItems :: Lens' SearchListResponse [SearchResult] Source

A list of results that match the search criteria.

slrVisitorId :: Lens' SearchListResponse (Maybe Text) Source

The visitorId identifies the visitor.

slrEventId :: Lens' SearchListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

slrPrevPageToken :: Lens' SearchListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

LiveBroadcastStatusPrivacyStatus

data LiveBroadcastStatusPrivacyStatus Source

The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.

Constructors

LBSPSPrivate
private
LBSPSPublic
public
LBSPSUnListed
unlisted

Instances

LiveBroadcastTopicDetails

data LiveBroadcastTopicDetails Source

Instances

liveBroadcastTopicDetails :: LiveBroadcastTopicDetails Source

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

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

lbtdTopics :: Lens' LiveBroadcastTopicDetails [LiveBroadcastTopic] Source

PlayListStatus

data PlayListStatus Source

Instances

playListStatus :: PlayListStatus Source

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

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

plsPrivacyStatus :: Lens' PlayListStatus (Maybe PlayListStatusPrivacyStatus) Source

The playlist's privacy status.

ChannelListResponse

data ChannelListResponse Source

Instances

channelListResponse :: ChannelListResponse Source

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

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

clrEtag :: Lens' ChannelListResponse (Maybe Text) Source

Etag of this resource.

clrTokenPagination :: Lens' ChannelListResponse (Maybe TokenPagination) Source

clrNextPageToken :: Lens' ChannelListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

clrPageInfo :: Lens' ChannelListResponse (Maybe PageInfo) Source

clrKind :: Lens' ChannelListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#channelListResponse".

clrItems :: Lens' ChannelListResponse [Channel] Source

A list of channels that match the request criteria.

clrVisitorId :: Lens' ChannelListResponse (Maybe Text) Source

The visitorId identifies the visitor.

clrEventId :: Lens' ChannelListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

clrPrevPageToken :: Lens' ChannelListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

CaptionsDownloadTfmt

data CaptionsDownloadTfmt Source

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.

Constructors

Sbv

sbv SubViewer subtitle.

Scc

scc Scenarist Closed Caption format.

Srt

srt SubRip subtitle.

Ttml

ttml Timed Text Markup Language caption.

Vtt

vtt Web Video Text Tracks caption.

Instances

PromotedItemIdType

data PromotedItemIdType Source

Describes the type of the promoted item.

Constructors

PIITRecentUpload
recentUpload
PIITVideo
video
PIITWebsite
website

Instances

ContentRatingPefilmRating

data ContentRatingPefilmRating Source

The video's rating in Peru.

Constructors

PEFILM14
pefilm14
PEFILM18
pefilm18
PefilmPg
pefilmPg
PefilmPt
pefilmPt
PefilmUnrated
pefilmUnrated

Instances

VideoAbuseReportReasonListResponse

data VideoAbuseReportReasonListResponse Source

Instances

videoAbuseReportReasonListResponse :: VideoAbuseReportReasonListResponse Source

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

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

varrlrEtag :: Lens' VideoAbuseReportReasonListResponse (Maybe Text) Source

Etag of this resource.

varrlrKind :: Lens' VideoAbuseReportReasonListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReasonListResponse".

varrlrItems :: Lens' VideoAbuseReportReasonListResponse [VideoAbuseReportReason] Source

A list of valid abuse reasons that are used with video.ReportAbuse.

varrlrVisitorId :: Lens' VideoAbuseReportReasonListResponse (Maybe Text) Source

The visitorId identifies the visitor.

varrlrEventId :: Lens' VideoAbuseReportReasonListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

SearchResultSnippetLiveBroadcastContent

data SearchResultSnippetLiveBroadcastContent Source

It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.

Constructors

SRSLBCLive
live
SRSLBCNone
none
SRSLBCUpcoming
upcoming

Instances

LiveBroadcastContentDetails

data LiveBroadcastContentDetails Source

Detailed settings of a broadcast.

See: liveBroadcastContentDetails smart constructor.

Instances

liveBroadcastContentDetails :: LiveBroadcastContentDetails Source

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

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

lbcdEnableContentEncryption :: Lens' LiveBroadcastContentDetails (Maybe Bool) Source

This setting indicates whether YouTube should enable content encryption for the broadcast.

lbcdEnableLowLatency :: Lens' LiveBroadcastContentDetails (Maybe Bool) Source

lbcdEnableEmbed :: Lens' LiveBroadcastContentDetails (Maybe Bool) Source

This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.

lbcdStartWithSlate :: Lens' LiveBroadcastContentDetails (Maybe Bool) Source

This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.

lbcdMonitorStream :: Lens' LiveBroadcastContentDetails (Maybe MonitorStreamInfo) Source

The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly.

lbcdBoundStreamId :: Lens' LiveBroadcastContentDetails (Maybe Text) Source

This value uniquely identifies the live stream bound to the broadcast.

lbcdRecordFromStart :: Lens' LiveBroadcastContentDetails (Maybe Bool) Source

Automatically start recording after the event goes live. The default value for this property is true. Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback.

lbcdEnableClosedCaptions :: Lens' LiveBroadcastContentDetails (Maybe Bool) Source

This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.

lbcdEnableDvr :: Lens' LiveBroadcastContentDetails (Maybe Bool) Source

This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends.

ContentRatingAnatelRating

data ContentRatingAnatelRating Source

The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television.

Constructors

AnatelA
anatelA
AnatelF
anatelF
AnatelI
anatelI
ANATELI10
anatelI10
ANATELI12
anatelI12
ANATELI7
anatelI7
AnatelR
anatelR
AnatelUnrated
anatelUnrated

Instances

SearchListOrder

data SearchListOrder Source

The order parameter specifies the method that will be used to order resources in the API response.

Constructors

Date

date Resources are sorted in reverse chronological order based on the date they were created.

Rating

rating Resources are sorted from highest to lowest rating.

Relevance

relevance Resources are sorted based on their relevance to the search query. This is the default value for this parameter.

Title

title Resources are sorted alphabetically by title.

VideoCount

videoCount Channels are sorted in descending order of their number of uploaded videos.

ViewCount

viewCount Resources are sorted from highest to lowest number of views.

Instances

ChannelSection

data ChannelSection Source

Instances

channelSection :: ChannelSection Source

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

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

csEtag :: Lens' ChannelSection (Maybe Text) Source

Etag of this resource.

csSnippet :: Lens' ChannelSection (Maybe ChannelSectionSnippet) Source

The snippet object contains basic details about the channel section, such as its type, style and title.

csKind :: Lens' ChannelSection Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".

csContentDetails :: Lens' ChannelSection (Maybe ChannelSectionContentDetails) Source

The contentDetails object contains details about the channel section content, such as a list of playlists or channels featured in the section.

csTargeting :: Lens' ChannelSection (Maybe ChannelSectionTargeting) Source

The targeting object contains basic targeting settings about the channel section.

csId :: Lens' ChannelSection (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel section.

csLocalizations :: Lens' ChannelSection (Maybe ChannelSectionLocalizations) Source

Localizations for different languages

ContentRatingCccRating

data ContentRatingCccRating Source

The video's Consejo de Calificación Cinematográfica (Chile) rating.

Constructors

CCC14
ccc14
CCC18
ccc18
Ccc18s
ccc18s
Ccc18v
ccc18v
CCC6
ccc6
CccTe
cccTe
CccUnrated
cccUnrated

Instances

ChannelContentDetailsRelatedPlayLists

data ChannelContentDetailsRelatedPlayLists Source

Instances

channelContentDetailsRelatedPlayLists :: ChannelContentDetailsRelatedPlayLists Source

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

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

ccdrplFavorites :: Lens' ChannelContentDetailsRelatedPlayLists (Maybe Text) Source

The ID of the playlist that contains the channel"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

ccdrplWatchHistory :: Lens' ChannelContentDetailsRelatedPlayLists (Maybe Text) Source

The ID of the playlist that contains the channel"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

ccdrplWatchLater :: Lens' ChannelContentDetailsRelatedPlayLists (Maybe Text) Source

The ID of the playlist that contains the channel"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

ccdrplUploads :: Lens' ChannelContentDetailsRelatedPlayLists (Maybe Text) Source

The ID of the playlist that contains the channel"s uploaded videos. Use the videos.insert method to upload new videos and the videos.delete method to delete previously uploaded videos.

ccdrplLikes :: Lens' ChannelContentDetailsRelatedPlayLists (Maybe Text) Source

The ID of the playlist that contains the channel"s liked videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.

LiveStream

data LiveStream Source

A live stream describes a live ingestion point.

See: liveStream smart constructor.

Instances

liveStream :: LiveStream Source

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

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

lsStatus :: Lens' LiveStream (Maybe LiveStreamStatus) Source

The status object contains information about live stream's status.

lsEtag :: Lens' LiveStream (Maybe Text) Source

Etag of this resource.

lsSnippet :: Lens' LiveStream (Maybe LiveStreamSnippet) Source

The snippet object contains basic details about the stream, including its channel, title, and description.

lsKind :: Lens' LiveStream Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#liveStream".

lsContentDetails :: Lens' LiveStream (Maybe LiveStreamContentDetails) Source

The content_details object contains information about the stream, including the closed captions ingestion URL.

lsId :: Lens' LiveStream (Maybe Text) Source

The ID that YouTube assigns to uniquely identify the stream.

lsCdn :: Lens' LiveStream (Maybe CdnSettings) Source

The cdn object defines the live stream's content delivery network (CDN) settings. These settings provide details about the manner in which you stream your content to YouTube.

ActivityContentDetailsFavorite

data ActivityContentDetailsFavorite Source

Information about a video that was marked as a favorite video.

See: activityContentDetailsFavorite smart constructor.

Instances

activityContentDetailsFavorite :: ActivityContentDetailsFavorite Source

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

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

acdfResourceId :: Lens' ActivityContentDetailsFavorite (Maybe ResourceId) Source

The resourceId object contains information that identifies the resource that was marked as a favorite.

VideoContentDetails

data VideoContentDetails Source

Details about the content of a YouTube Video.

See: videoContentDetails smart constructor.

Instances

videoContentDetails :: VideoContentDetails Source

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

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

vcdCountryRestriction :: Lens' VideoContentDetails (Maybe AccessPolicy) Source

The countryRestriction object contains information about the countries where a video is (or is not) viewable.

vcdDefinition :: Lens' VideoContentDetails (Maybe VideoContentDetailsDefinition) Source

The value of definition indicates whether the video is available in high definition or only in standard definition.

vcdDimension :: Lens' VideoContentDetails (Maybe Text) Source

The value of dimension indicates whether the video is available in 3D or in 2D.

vcdCaption :: Lens' VideoContentDetails (Maybe VideoContentDetailsCaption) Source

The value of captions indicates whether the video has captions or not.

vcdRegionRestriction :: Lens' VideoContentDetails (Maybe VideoContentDetailsRegionRestriction) Source

The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.

vcdDuration :: Lens' VideoContentDetails (Maybe Text) Source

The length of the video. The tag value is an ISO 8601 duration in the format PTS, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.

vcdContentRating :: Lens' VideoContentDetails (Maybe ContentRating) Source

Specifies the ratings that the video received under various rating schemes.

vcdLicensedContent :: Lens' VideoContentDetails (Maybe Bool) Source

The value of is_license_content indicates whether the video is licensed content.

CaptionSnippetAudioTrackType

data CaptionSnippetAudioTrackType Source

The type of audio track associated with the caption track.

Constructors

Commentary
commentary
Descriptive
descriptive
Primary
primary
Unknown
unknown

Instances

ImageSettings

data ImageSettings Source

Branding properties for images associated with the channel.

See: imageSettings smart constructor.

Instances

imageSettings :: ImageSettings Source

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

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

isBannerMobileLowImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Mobile size low resolution (320x88).

isBannerTabletExtraHdImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Tablet size extra high resolution (2560x424).

isSmallBrandedBannerImageImapScript :: Lens' ImageSettings (Maybe LocalizedProperty) Source

The image map script for the small banner image.

isBannerTvHighImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. TV size high resolution (1920x1080).

isBannerMobileHdImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Mobile size high resolution (1280x360).

isBannerTvMediumImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. TV size medium resolution (1280x720).

isBannerTvImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. TV size extra high resolution (2120x1192).

isBannerTabletImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Tablet size (1707x283).

isBannerMobileImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Mobile size (640x175).

isTrackingImageURL :: Lens' ImageSettings (Maybe Text) Source

The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.

isBannerMobileMediumHdImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Mobile size medium/high resolution (960x263).

isLargeBrandedBannerImageURL :: Lens' ImageSettings (Maybe LocalizedProperty) Source

The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page.

isBannerExternalURL :: Lens' ImageSettings (Maybe Text) Source

This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.

isBackgRoundImageURL :: Lens' ImageSettings (Maybe LocalizedProperty) Source

The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k.

isSmallBrandedBannerImageURL :: Lens' ImageSettings (Maybe LocalizedProperty) Source

The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page.

isBannerImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Desktop size (1060x175).

isWatchIconImageURL :: Lens' ImageSettings (Maybe Text) Source

The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels.

isBannerTvLowImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. TV size low resolution (854x480).

isBannerMobileExtraHdImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Mobile size high resolution (1440x395).

isLargeBrandedBannerImageImapScript :: Lens' ImageSettings (Maybe LocalizedProperty) Source

The image map script for the large banner image.

isBannerTabletLowImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Tablet size low resolution (1138x188).

isBannerTabletHdImageURL :: Lens' ImageSettings (Maybe Text) Source

Banner image. Tablet size high resolution (2276x377).

VideoTopicDetails

data VideoTopicDetails Source

Freebase topic information related to the video.

See: videoTopicDetails smart constructor.

Instances

videoTopicDetails :: VideoTopicDetails Source

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

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

vtdTopicIds :: Lens' VideoTopicDetails [Text] Source

A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API.

vtdRelevantTopicIds :: Lens' VideoTopicDetails [Text] Source

Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API.

ActivityContentDetailsComment

data ActivityContentDetailsComment Source

Information about a resource that received a comment.

See: activityContentDetailsComment smart constructor.

Instances

activityContentDetailsComment :: ActivityContentDetailsComment Source

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

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

acdcResourceId :: Lens' ActivityContentDetailsComment (Maybe ResourceId) Source

The resourceId object contains information that identifies the resource associated with the comment.

ChannelStatusPrivacyStatus

data ChannelStatusPrivacyStatus Source

Privacy status of the channel.

Constructors

CSPSPrivate
private
CSPSPublic
public
CSPSUnListed
unlisted

Instances

LiveBroadcastStatus

data LiveBroadcastStatus Source

Instances

liveBroadcastStatus :: LiveBroadcastStatus Source

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

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

lbsLiveBroadcastPriority :: Lens' LiveBroadcastStatus (Maybe LiveBroadcastStatusLiveBroadcastPriority) Source

Priority of the live broadcast event (internal state).

lbsRecordingStatus :: Lens' LiveBroadcastStatus (Maybe LiveBroadcastStatusRecordingStatus) Source

The broadcast's recording status.

lbsLifeCycleStatus :: Lens' LiveBroadcastStatus (Maybe LiveBroadcastStatusLifeCycleStatus) Source

The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.

lbsPrivacyStatus :: Lens' LiveBroadcastStatus (Maybe LiveBroadcastStatusPrivacyStatus) Source

The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.

ActivityContentDetailsUpload

data ActivityContentDetailsUpload Source

Information about the uploaded video.

See: activityContentDetailsUpload smart constructor.

Instances

activityContentDetailsUpload :: ActivityContentDetailsUpload Source

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

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

acduVideoId :: Lens' ActivityContentDetailsUpload (Maybe Text) Source

The ID that YouTube uses to uniquely identify the uploaded video.

ActivityContentDetailsPlayListItem

data ActivityContentDetailsPlayListItem Source

Information about a new playlist item.

See: activityContentDetailsPlayListItem smart constructor.

Instances

activityContentDetailsPlayListItem :: ActivityContentDetailsPlayListItem Source

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

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

acdpliResourceId :: Lens' ActivityContentDetailsPlayListItem (Maybe ResourceId) Source

The resourceId object contains information about the resource that was added to the playlist.

acdpliPlayListId :: Lens' ActivityContentDetailsPlayListItem (Maybe Text) Source

The value that YouTube uses to uniquely identify the playlist.

acdpliPlayListItemId :: Lens' ActivityContentDetailsPlayListItem (Maybe Text) Source

ID of the item within the playlist.

ActivityContentDetailsSocial

data ActivityContentDetailsSocial Source

Details about a social network post.

See: activityContentDetailsSocial smart constructor.

Instances

activityContentDetailsSocial :: ActivityContentDetailsSocial Source

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

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

acdsResourceId :: Lens' ActivityContentDetailsSocial (Maybe ResourceId) Source

The resourceId object encapsulates information that identifies the resource associated with a social network post.

acdsImageURL :: Lens' ActivityContentDetailsSocial (Maybe Text) Source

An image of the post's author.

acdsAuthor :: Lens' ActivityContentDetailsSocial (Maybe Text) Source

The author of the social network post.

acdsReferenceURL :: Lens' ActivityContentDetailsSocial (Maybe Text) Source

The URL of the social network post.

acdsType :: Lens' ActivityContentDetailsSocial (Maybe ActivityContentDetailsSocialType) Source

The name of the social network.

VideoSuggestionsEditorSuggestionsItem

data VideoSuggestionsEditorSuggestionsItem Source

Constructors

AudioQuietAudioSwap
audioQuietAudioSwap
VideoAutoLevels
videoAutoLevels
VideoCrop
videoCrop
VideoStabilize
videoStabilize

Instances

ContentRatingCatvfrRating

data ContentRatingCatvfrRating Source

The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.

Constructors

Catvfr13plus
catvfr13plus
Catvfr16plus
catvfr16plus
Catvfr18plus
catvfr18plus
Catvfr8plus
catvfr8plus
CatvfrG
catvfrG
CatvfrUnrated
catvfrUnrated

Instances

ContentRatingCnaRating

data ContentRatingCnaRating Source

The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA).

Constructors

CNA12
cna12
CNA15
cna15
CNA18
cna18
Cna18plus
cna18plus
CnaAp
cnaAp
CnaUnrated
cnaUnrated

Instances

ContentRatingChvrsRating

data ContentRatingChvrsRating Source

The video's Canadian Home Video Rating System (CHVRS) rating.

Constructors

Chvrs14a
chvrs14a
Chvrs18a
chvrs18a
ChvrsE
chvrsE
ChvrsG
chvrsG
ChvrsPg
chvrsPg
ChvrsR
chvrsR
ChvrsUnrated
chvrsUnrated

Instances

ActivityContentDetailsSubscription

data ActivityContentDetailsSubscription Source

Information about a channel that a user subscribed to.

See: activityContentDetailsSubscription smart constructor.

Instances

activityContentDetailsSubscription :: ActivityContentDetailsSubscription Source

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

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

aResourceId :: Lens' ActivityContentDetailsSubscription (Maybe ResourceId) Source

The resourceId object contains information that identifies the resource that the user subscribed to.

ActivityContentDetailsLike

data ActivityContentDetailsLike Source

Information about a resource that received a positive (like) rating.

See: activityContentDetailsLike smart constructor.

Instances

activityContentDetailsLike :: ActivityContentDetailsLike Source

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

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

acdlResourceId :: Lens' ActivityContentDetailsLike (Maybe ResourceId) Source

The resourceId object contains information that identifies the rated resource.

PlayListContentDetails

data PlayListContentDetails Source

Instances

playListContentDetails :: PlayListContentDetails Source

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

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

plcdItemCount :: Lens' PlayListContentDetails (Maybe Word32) Source

The number of videos in the playlist.

ContentRatingIncaaRating

data ContentRatingIncaaRating Source

The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating.

Constructors

IncaaAtp
incaaAtp
IncaaC
incaaC
INCAASAM13
incaaSam13
INCAASAM16
incaaSam16
INCAASAM18
incaaSam18
IncaaUnrated
incaaUnrated

Instances

ContentRatingSmsaRating

data ContentRatingSmsaRating Source

The video's rating from Statens medieråd (Sweden's National Media Council).

Constructors

SMSA11
smsa11
SMSA15
smsa15
SMSA7
smsa7
SmsaA
smsaA
SmsaUnrated
smsaUnrated

Instances

PageInfo

data PageInfo Source

Paging details for lists of resources, including total number of items available and number of resources returned in a single page.

See: pageInfo smart constructor.

Instances

pageInfo :: PageInfo Source

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

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

piResultsPerPage :: Lens' PageInfo (Maybe Int32) Source

The number of results included in the API response.

piTotalResults :: Lens' PageInfo (Maybe Int32) Source

The total number of results in the result set.

ContentRatingCbfcRating

data ContentRatingCbfcRating Source

The video's Central Board of Film Certification (CBFC - India) rating.

Constructors

CbfcA
cbfcA
CbfcS
cbfcS
CbfcU
cbfcU
CbfcUA
cbfcUA
CbfcUnrated
cbfcUnrated

Instances

VideoStatus

data VideoStatus Source

Basic details about a video category, such as its localized title.

See: videoStatus smart constructor.

Instances

videoStatus :: VideoStatus Source

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

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

vsFailureReason :: Lens' VideoStatus (Maybe VideoStatusFailureReason) Source

This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.

vsPublicStatsViewable :: Lens' VideoStatus (Maybe Bool) Source

This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled.

vsRejectionReason :: Lens' VideoStatus (Maybe VideoStatusRejectionReason) Source

This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.

vsPublishAt :: Lens' VideoStatus (Maybe UTCTime) Source

The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

vsUploadStatus :: Lens' VideoStatus (Maybe VideoStatusUploadStatus) Source

The status of the uploaded video.

vsPrivacyStatus :: Lens' VideoStatus (Maybe VideoStatusPrivacyStatus) Source

The video's privacy status.

vsEmbeddable :: Lens' VideoStatus (Maybe Bool) Source

This value indicates if the video can be embedded on another website.

vsLicense :: Lens' VideoStatus (Maybe VideoStatusLicense) Source

The video's license.

ContentRatingKfcbRating

data ContentRatingKfcbRating Source

The video's rating from the Kenya Film Classification Board.

Constructors

Kfcb16plus
kfcb16plus
KfcbG
kfcbG
KfcbPg
kfcbPg
KfcbR
kfcbR
KfcbUnrated
kfcbUnrated

Instances

VideoFileDetails

data VideoFileDetails Source

Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information.

See: videoFileDetails smart constructor.

Instances

videoFileDetails :: VideoFileDetails Source

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

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

vfdBitrateBps :: Lens' VideoFileDetails (Maybe Word64) Source

The uploaded video file's combined (video and audio) bitrate in bits per second.

vfdCreationTime :: Lens' VideoFileDetails (Maybe Text) Source

The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM

vfdRecordingLocation :: Lens' VideoFileDetails (Maybe GeoPoint) Source

Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.

vfdDurationMs :: Lens' VideoFileDetails (Maybe Word64) Source

The length of the uploaded video in milliseconds.

vfdFileSize :: Lens' VideoFileDetails (Maybe Word64) Source

The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.

vfdFileType :: Lens' VideoFileDetails (Maybe VideoFileDetailsFileType) Source

The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.

vfdContainer :: Lens' VideoFileDetails (Maybe Text) Source

The uploaded video file's container format.

vfdVideoStreams :: Lens' VideoFileDetails [VideoFileDetailsVideoStream] Source

A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.

vfdAudioStreams :: Lens' VideoFileDetails [VideoFileDetailsAudioStream] Source

A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.

vfdFileName :: Lens' VideoFileDetails (Maybe Text) Source

The uploaded file's name. This field is present whether a video file or another type of file was uploaded.

ThumbnailSetResponse

data ThumbnailSetResponse Source

Instances

thumbnailSetResponse :: ThumbnailSetResponse Source

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

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

tsrEtag :: Lens' ThumbnailSetResponse (Maybe Text) Source

Etag of this resource.

tsrKind :: Lens' ThumbnailSetResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#thumbnailSetResponse".

tsrItems :: Lens' ThumbnailSetResponse [ThumbnailDetails] Source

A list of thumbnails.

tsrVisitorId :: Lens' ThumbnailSetResponse (Maybe Text) Source

The visitorId identifies the visitor.

tsrEventId :: Lens' ThumbnailSetResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

LiveStreamConfigurationIssueSeverity

data LiveStreamConfigurationIssueSeverity Source

How severe this issue is to the stream.

Constructors

Error'
error
Info
info
Warning
warning

Instances

LiveBroadcastListResponse

data LiveBroadcastListResponse Source

Instances

liveBroadcastListResponse :: LiveBroadcastListResponse Source

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

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

lblrEtag :: Lens' LiveBroadcastListResponse (Maybe Text) Source

Etag of this resource.

lblrTokenPagination :: Lens' LiveBroadcastListResponse (Maybe TokenPagination) Source

lblrNextPageToken :: Lens' LiveBroadcastListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

lblrPageInfo :: Lens' LiveBroadcastListResponse (Maybe PageInfo) Source

lblrKind :: Lens' LiveBroadcastListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcastListResponse".

lblrItems :: Lens' LiveBroadcastListResponse [LiveBroadcast] Source

A list of broadcasts that match the request criteria.

lblrVisitorId :: Lens' LiveBroadcastListResponse (Maybe Text) Source

The visitorId identifies the visitor.

lblrEventId :: Lens' LiveBroadcastListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

lblrPrevPageToken :: Lens' LiveBroadcastListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

ChannelContentDetails

data ChannelContentDetails Source

Details about the content of a channel.

See: channelContentDetails smart constructor.

Instances

channelContentDetails :: ChannelContentDetails Source

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

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

ccdRelatedPlayLists :: Lens' ChannelContentDetails (Maybe ChannelContentDetailsRelatedPlayLists) Source

ccdGooglePlusUserId :: Lens' ChannelContentDetails (Maybe Text) Source

The googlePlusUserId object identifies the Google+ profile ID associated with this channel.

SearchListVideoDefinition

data SearchListVideoDefinition Source

The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

SLVDAny

any Return all videos, regardless of their resolution.

SLVDHigh

high Only retrieve HD videos.

SLVDStandard

standard Only retrieve videos in standard definition.

Instances

ActivityContentDetailsChannelItem

data ActivityContentDetailsChannelItem Source

Details about a resource which was added to a channel.

See: activityContentDetailsChannelItem smart constructor.

Instances

activityContentDetailsChannelItem :: ActivityContentDetailsChannelItem Source

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

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

acdciResourceId :: Lens' ActivityContentDetailsChannelItem (Maybe ResourceId) Source

The resourceId object contains information that identifies the resource that was added to the channel.

VideoListResponse

data VideoListResponse Source

Instances

videoListResponse :: VideoListResponse Source

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

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

vlrEtag :: Lens' VideoListResponse (Maybe Text) Source

Etag of this resource.

vlrTokenPagination :: Lens' VideoListResponse (Maybe TokenPagination) Source

vlrNextPageToken :: Lens' VideoListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

vlrPageInfo :: Lens' VideoListResponse (Maybe PageInfo) Source

vlrKind :: Lens' VideoListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse".

vlrItems :: Lens' VideoListResponse [Video] Source

A list of videos that match the request criteria.

vlrVisitorId :: Lens' VideoListResponse (Maybe Text) Source

The visitorId identifies the visitor.

vlrEventId :: Lens' VideoListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

vlrPrevPageToken :: Lens' VideoListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

VideoMonetizationDetails

data VideoMonetizationDetails Source

Details about monetization of a YouTube Video.

See: videoMonetizationDetails smart constructor.

Instances

videoMonetizationDetails :: VideoMonetizationDetails Source

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

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

vmdAccess :: Lens' VideoMonetizationDetails (Maybe AccessPolicy) Source

The value of access indicates whether the video can be monetized or not.

VideoAgeGatingVideoGameRating

data VideoAgeGatingVideoGameRating Source

Video game rating, if any.

Constructors

Anyone
anyone
M15Plus
m15Plus
M16Plus
m16Plus
M17Plus
m17Plus

Instances

ContentRatingLsfRating

data ContentRatingLsfRating Source

The video's rating from Indonesia's Lembaga Sensor Film.

Constructors

LSF13
lsf13
LSF17
lsf17
LSF21
lsf21
LsfA
lsfA
LsfBo
lsfBo
LsfD
lsfD
LsfR
lsfR
LsfSu
lsfSu
LsfUnrated
lsfUnrated

Instances

VideoSuggestionsTagSuggestion

data VideoSuggestionsTagSuggestion Source

A single tag suggestion with it's relevance information.

See: videoSuggestionsTagSuggestion smart constructor.

Instances

videoSuggestionsTagSuggestion :: VideoSuggestionsTagSuggestion Source

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

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

vstsTag :: Lens' VideoSuggestionsTagSuggestion (Maybe Text) Source

The keyword tag suggested for the video.

vstsCategoryRestricts :: Lens' VideoSuggestionsTagSuggestion [Text] Source

A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.

ActivitySnippet

data ActivitySnippet Source

Basic details about an activity, including title, description, thumbnails, activity type and group.

See: activitySnippet smart constructor.

Instances

activitySnippet :: ActivitySnippet Source

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

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

asPublishedAt :: Lens' ActivitySnippet (Maybe UTCTime) Source

The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

asChannelTitle :: Lens' ActivitySnippet (Maybe Text) Source

Channel title for the channel responsible for this activity

asChannelId :: Lens' ActivitySnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel associated with the activity.

asThumbnails :: Lens' ActivitySnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the resource that is primarily associated with the activity. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

asGroupId :: Lens' ActivitySnippet (Maybe Text) Source

The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.

asTitle :: Lens' ActivitySnippet (Maybe Text) Source

The title of the resource primarily associated with the activity.

asType :: Lens' ActivitySnippet (Maybe ActivitySnippetType) Source

The type of activity that the resource describes.

asDescription :: Lens' ActivitySnippet (Maybe Text) Source

The description of the resource primarily associated with the activity.

ChannelTopicDetails

data ChannelTopicDetails Source

Freebase topic information related to the channel.

See: channelTopicDetails smart constructor.

Instances

channelTopicDetails :: ChannelTopicDetails Source

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

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

ctdTopicIds :: Lens' ChannelTopicDetails [Text] Source

A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.

ContentRatingBfvcRating

data ContentRatingBfvcRating Source

The video's rating from Thailand's Board of Film and Video Censors.

Constructors

BFVC13
bfvc13
BFVC15
bfvc15
BFVC18
bfvc18
BFVC20
bfvc20
BfvcB
bfvcB
BfvcE
bfvcE
BfvcG
bfvcG
BfvcUnrated
bfvcUnrated

Instances

LiveBroadcastTopicType

data LiveBroadcastTopicType Source

The type of the topic.

Constructors

VideoGame
videoGame

Instances

VideoCategoryListResponse

data VideoCategoryListResponse Source

Instances

videoCategoryListResponse :: VideoCategoryListResponse Source

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

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

vclrEtag :: Lens' VideoCategoryListResponse (Maybe Text) Source

Etag of this resource.

vclrTokenPagination :: Lens' VideoCategoryListResponse (Maybe TokenPagination) Source

vclrNextPageToken :: Lens' VideoCategoryListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

vclrPageInfo :: Lens' VideoCategoryListResponse (Maybe PageInfo) Source

vclrKind :: Lens' VideoCategoryListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategoryListResponse".

vclrItems :: Lens' VideoCategoryListResponse [VideoCategory] Source

A list of video categories that can be associated with YouTube videos. In this map, the video category ID is the map key, and its value is the corresponding videoCategory resource.

vclrVisitorId :: Lens' VideoCategoryListResponse (Maybe Text) Source

The visitorId identifies the visitor.

vclrEventId :: Lens' VideoCategoryListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

vclrPrevPageToken :: Lens' VideoCategoryListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

VideoProcessingDetails

data VideoProcessingDetails Source

Describes processing status and progress and availability of some other Video resource parts.

See: videoProcessingDetails smart constructor.

Instances

videoProcessingDetails :: VideoProcessingDetails Source

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

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

vpdProcessingFailureReason :: Lens' VideoProcessingDetails (Maybe VideoProcessingDetailsProcessingFailureReason) Source

The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.

vpdProcessingIssuesAvailability :: Lens' VideoProcessingDetails (Maybe Text) Source

This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.

vpdProcessingProgress :: Lens' VideoProcessingDetails (Maybe VideoProcessingDetailsProcessingProgress) Source

The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.

vpdThumbnailsAvailability :: Lens' VideoProcessingDetails (Maybe Text) Source

This value indicates whether thumbnail images have been generated for the video.

vpdTagSuggestionsAvailability :: Lens' VideoProcessingDetails (Maybe Text) Source

This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.

vpdProcessingStatus :: Lens' VideoProcessingDetails (Maybe VideoProcessingDetailsProcessingStatus) Source

The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.

vpdEditorSuggestionsAvailability :: Lens' VideoProcessingDetails (Maybe Text) Source

This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.

vpdFileDetailsAvailability :: Lens' VideoProcessingDetails (Maybe Text) Source

This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.

CommentThreadSnippet

data CommentThreadSnippet Source

Basic details about a comment thread.

See: commentThreadSnippet smart constructor.

Instances

commentThreadSnippet :: CommentThreadSnippet Source

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

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

ctsIsPublic :: Lens' CommentThreadSnippet (Maybe Bool) Source

Whether the thread (and therefore all its comments) is visible to all YouTube users.

ctsChannelId :: Lens' CommentThreadSnippet (Maybe Text) Source

The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.

ctsCanReply :: Lens' CommentThreadSnippet (Maybe Bool) Source

Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.

ctsVideoId :: Lens' CommentThreadSnippet (Maybe Text) Source

The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment.

ctsTotalReplyCount :: Lens' CommentThreadSnippet (Maybe Word32) Source

The total number of replies (not including the top level comment).

ctsTopLevelComment :: Lens' CommentThreadSnippet (Maybe Comment) Source

The top level comment of this thread.

SearchListVideoDuration

data SearchListVideoDuration Source

The videoDuration parameter filters video search results based on their duration. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

Any

any Do not filter video search results based on their duration. This is the default value.

Long

long Only include videos longer than 20 minutes.

Medium

medium Only include videos that are between four and 20 minutes long (inclusive).

Short

short Only include videos that are less than four minutes long.

Instances

SearchListVideoCaption

data SearchListVideoCaption Source

The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

SLVCAny

any Do not filter results based on caption availability.

SLVCClosedCaption

closedCaption Only include videos that have captions.

SLVCNone

none Only include videos that do not have captions.

Instances

VideosListMyRating

data VideosListMyRating Source

Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.

Constructors

Dislike

dislike Returns only videos disliked by the authenticated user.

Like

like Returns only video liked by the authenticated user.

Instances

ChannelSectionListResponse

data ChannelSectionListResponse Source

Instances

channelSectionListResponse :: ChannelSectionListResponse Source

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

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

cslrEtag :: Lens' ChannelSectionListResponse (Maybe Text) Source

Etag of this resource.

cslrKind :: Lens' ChannelSectionListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse".

cslrItems :: Lens' ChannelSectionListResponse [ChannelSection] Source

A list of ChannelSections that match the request criteria.

cslrVisitorId :: Lens' ChannelSectionListResponse (Maybe Text) Source

The visitorId identifies the visitor.

cslrEventId :: Lens' ChannelSectionListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

CommentSnippetViewerRating

data CommentSnippetViewerRating Source

The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

Constructors

CSVRDislike
dislike
CSVRLike
like
CSVRNone
none
CSVRUnspecified
unspecified

Instances

VideoAbuseReportReason

data VideoAbuseReportReason Source

A videoAbuseReportReason resource identifies a reason that a video could be reported as abusive. Video abuse report reasons are used with video.ReportAbuse.

See: videoAbuseReportReason smart constructor.

Instances

videoAbuseReportReason :: VideoAbuseReportReason Source

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

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

varrEtag :: Lens' VideoAbuseReportReason (Maybe Text) Source

Etag of this resource.

varrSnippet :: Lens' VideoAbuseReportReason (Maybe VideoAbuseReportReasonSnippet) Source

The snippet object contains basic details about the abuse report reason.

varrKind :: Lens' VideoAbuseReportReason Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#videoAbuseReportReason".

varrId :: Lens' VideoAbuseReportReason (Maybe Text) Source

The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID.

LiveStreamConfigurationIssue

data LiveStreamConfigurationIssue Source

Instances

liveStreamConfigurationIssue :: LiveStreamConfigurationIssue Source

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

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

lsciSeverity :: Lens' LiveStreamConfigurationIssue (Maybe LiveStreamConfigurationIssueSeverity) Source

How severe this issue is to the stream.

lsciReason :: Lens' LiveStreamConfigurationIssue (Maybe Text) Source

The short-form reason for this issue.

lsciType :: Lens' LiveStreamConfigurationIssue (Maybe LiveStreamConfigurationIssueType) Source

The kind of error happening.

lsciDescription :: Lens' LiveStreamConfigurationIssue (Maybe Text) Source

The long-form description of the issue and how to resolve it.

Channel

data Channel Source

A channel resource contains information about a YouTube channel.

See: channel smart constructor.

Instances

channel :: Channel Source

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

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

chaStatus :: Lens' Channel (Maybe ChannelStatus) Source

The status object encapsulates information about the privacy status of the channel.

chaEtag :: Lens' Channel (Maybe Text) Source

Etag of this resource.

chaAuditDetails :: Lens' Channel (Maybe ChannelAuditDetails) Source

The auditionDetails object encapsulates channel data that is relevant for YouTube Partners during the audition process.

chaContentOwnerDetails :: Lens' Channel (Maybe ChannelContentOwnerDetails) Source

The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.

chaSnippet :: Lens' Channel (Maybe ChannelSnippet) Source

The snippet object contains basic details about the channel, such as its title, description, and thumbnail images.

chaKind :: Lens' Channel Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#channel".

chaTopicDetails :: Lens' Channel (Maybe ChannelTopicDetails) Source

The topicDetails object encapsulates information about Freebase topics associated with the channel.

chaContentDetails :: Lens' Channel (Maybe ChannelContentDetails) Source

The contentDetails object encapsulates information about the channel's content.

chaConversionPings :: Lens' Channel (Maybe ChannelConversionPings) Source

The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.

chaBrandingSettings :: Lens' Channel (Maybe ChannelBrandingSettings) Source

The brandingSettings object encapsulates information about the branding of the channel.

chaId :: Lens' Channel (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel.

chaInvideoPromotion :: Lens' Channel (Maybe InvideoPromotion) Source

The invideoPromotion object encapsulates information about promotion campaign associated with the channel.

chaStatistics :: Lens' Channel (Maybe ChannelStatistics) Source

The statistics object encapsulates statistics for the channel.

chaLocalizations :: Lens' Channel (Maybe ChannelLocalizations) Source

Localizations for different languages

ChannelSectionTargeting

data ChannelSectionTargeting Source

ChannelSection targeting setting.

See: channelSectionTargeting smart constructor.

Instances

channelSectionTargeting :: ChannelSectionTargeting Source

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

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

cstRegions :: Lens' ChannelSectionTargeting [Text] Source

The region the channel section is targeting.

cstCountries :: Lens' ChannelSectionTargeting [Text] Source

The country the channel section is targeting.

cstLanguages :: Lens' ChannelSectionTargeting [Text] Source

The language the channel section is targeting.

ContentRatingFcbmRating

data ContentRatingFcbmRating Source

The video's rating from Malaysia's Film Censorship Board.

Constructors

FCBM18
fcbm18
Fcbm18pa
fcbm18pa
Fcbm18pl
fcbm18pl
Fcbm18sg
fcbm18sg
Fcbm18sx
fcbm18sx
FCBMP13
fcbmP13
FCBMPG13
fcbmPg13
FcbmU
fcbmU
FcbmUnrated
fcbmUnrated

Instances

LiveStreamListResponse

data LiveStreamListResponse Source

Instances

liveStreamListResponse :: LiveStreamListResponse Source

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

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

lslrEtag :: Lens' LiveStreamListResponse (Maybe Text) Source

Etag of this resource.

lslrTokenPagination :: Lens' LiveStreamListResponse (Maybe TokenPagination) Source

lslrNextPageToken :: Lens' LiveStreamListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

lslrPageInfo :: Lens' LiveStreamListResponse (Maybe PageInfo) Source

lslrKind :: Lens' LiveStreamListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#liveStreamListResponse".

lslrItems :: Lens' LiveStreamListResponse [LiveStream] Source

A list of live streams that match the request criteria.

lslrVisitorId :: Lens' LiveStreamListResponse (Maybe Text) Source

The visitorId identifies the visitor.

lslrEventId :: Lens' LiveStreamListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

lslrPrevPageToken :: Lens' LiveStreamListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

LiveBroadcastsListBroadcastStatus

data LiveBroadcastsListBroadcastStatus Source

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

Constructors

LBLBSActive

active Return current live broadcasts.

LBLBSAll

all Return all broadcasts.

LBLBSCompleted

completed Return broadcasts that have already ended.

LBLBSUpcoming

upcoming Return broadcasts that have not yet started.

Instances

ContentRatingMoctwRating

data ContentRatingMoctwRating Source

The video's rating from Taiwan's Ministry of Culture (文化部).

Constructors

MoctwG
moctwG
MoctwP
moctwP
MoctwPg
moctwPg
MoctwR
moctwR
MoctwUnrated
moctwUnrated

Instances

ContentRatingBmukkRating

data ContentRatingBmukkRating Source

The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur).

Constructors

BMUKK10
bmukk10
BMUKK12
bmukk12
BMUKK14
bmukk14
BMUKK16
bmukk16
BMUKK6
bmukk6
BMUKK8
bmukk8
BmukkAa
bmukkAa
BmukkUnrated
bmukkUnrated

Instances

ChannelLocalizations

data ChannelLocalizations Source

Localizations for different languages

See: channelLocalizations smart constructor.

Instances

channelLocalizations Source

Arguments

:: HashMap Text ChannelLocalization

clAddtional

-> ChannelLocalizations 

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

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

clAddtional :: Lens' ChannelLocalizations (HashMap Text ChannelLocalization) Source

The language tag, using string since map_key require simple types.

PlayListSnippet

data PlayListSnippet Source

Basic details about a playlist, including title, description and thumbnails.

See: playListSnippet smart constructor.

Instances

playListSnippet :: PlayListSnippet Source

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

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

plsPublishedAt :: Lens' PlayListSnippet (Maybe UTCTime) Source

The date and time that the playlist was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

plsChannelTitle :: Lens' PlayListSnippet (Maybe Text) Source

The channel title of the channel that the video belongs to.

plsChannelId :: Lens' PlayListSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel that published the playlist.

plsThumbnails :: Lens' PlayListSnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the playlist. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

plsLocalized :: Lens' PlayListSnippet (Maybe PlayListLocalization) Source

Localized title and description, read-only.

plsTitle :: Lens' PlayListSnippet (Maybe Text) Source

The playlist's title.

plsDescription :: Lens' PlayListSnippet (Maybe Text) Source

The playlist's description.

plsTags :: Lens' PlayListSnippet [Text] Source

Keyword tags associated with the playlist.

plsDefaultLanguage :: Lens' PlayListSnippet (Maybe Text) Source

The language of the playlist's default title and description.

ContentRatingIcaaRating

data ContentRatingIcaaRating Source

The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating.

Constructors

ICAA12
icaa12
ICAA13
icaa13
ICAA16
icaa16
ICAA18
icaa18
ICAA7
icaa7
IcaaApta
icaaApta
IcaaUnrated
icaaUnrated
IcaaX
icaaX

Instances

VideoGetRatingResponse

data VideoGetRatingResponse Source

Instances

videoGetRatingResponse :: VideoGetRatingResponse Source

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

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

vgrrEtag :: Lens' VideoGetRatingResponse (Maybe Text) Source

Etag of this resource.

vgrrKind :: Lens' VideoGetRatingResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse".

vgrrItems :: Lens' VideoGetRatingResponse [VideoRating] Source

A list of ratings that match the request criteria.

vgrrVisitorId :: Lens' VideoGetRatingResponse (Maybe Text) Source

The visitorId identifies the visitor.

vgrrEventId :: Lens' VideoGetRatingResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

VideoAbuseReportReasonSnippet

data VideoAbuseReportReasonSnippet Source

Basic details about a video category, such as its localized title.

See: videoAbuseReportReasonSnippet smart constructor.

Instances

videoAbuseReportReasonSnippet :: VideoAbuseReportReasonSnippet Source

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

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

varrsSecondaryReasons :: Lens' VideoAbuseReportReasonSnippet [VideoAbuseReportSecondaryReason] Source

The secondary reasons associated with this reason, if any are available. (There might be 0 or more.)

varrsLabel :: Lens' VideoAbuseReportReasonSnippet (Maybe Text) Source

The localized label belonging to this abuse report reason.

VideoStatusRejectionReason

data VideoStatusRejectionReason Source

This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.

Constructors

Claim
claim
Copyright
copyright
Duplicate
duplicate
InAppropriate
inappropriate
Length
length
TermsOfUse
termsOfUse
Trademark
trademark
UploaderAccountClosed
uploaderAccountClosed
UploaderAccountSuspended
uploaderAccountSuspended

Instances

Caption

data Caption Source

A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.

See: caption smart constructor.

Instances

caption :: Caption Source

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

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

capEtag :: Lens' Caption (Maybe Text) Source

Etag of this resource.

capSnippet :: Lens' Caption (Maybe CaptionSnippet) Source

The snippet object contains basic details about the caption.

capKind :: Lens' Caption Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#caption".

capId :: Lens' Caption (Maybe Text) Source

The ID that YouTube uses to uniquely identify the caption track.

VideoContentDetailsRegionRestriction

data VideoContentDetailsRegionRestriction Source

DEPRECATED Region restriction of the video.

See: videoContentDetailsRegionRestriction smart constructor.

Instances

videoContentDetailsRegionRestriction :: VideoContentDetailsRegionRestriction Source

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

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

vcdrrAllowed :: Lens' VideoContentDetailsRegionRestriction [Text] Source

A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.

vcdrrBlocked :: Lens' VideoContentDetailsRegionRestriction [Text] Source

A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.

InvideoTiming

data InvideoTiming Source

Describes a temporal position of a visual widget inside a video.

See: invideoTiming smart constructor.

Instances

invideoTiming :: InvideoTiming Source

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

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

itDurationMs :: Lens' InvideoTiming (Maybe Word64) Source

Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.

itOffSetMs :: Lens' InvideoTiming (Maybe Word64) Source

Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.

itType :: Lens' InvideoTiming (Maybe InvideoTimingType) Source

Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.

PlayListLocalizations

data PlayListLocalizations Source

Localizations for different languages

See: playListLocalizations smart constructor.

Instances

playListLocalizations Source

Arguments

:: HashMap Text PlayListLocalization

pllAddtional

-> PlayListLocalizations 

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

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

pllAddtional :: Lens' PlayListLocalizations (HashMap Text PlayListLocalization) Source

The language tag, using string since map_key require simple types.

ContentRatingCzfilmRating

data ContentRatingCzfilmRating Source

The video's rating in the Czech Republic.

Constructors

CZFILM12
czfilm12
CZFILM14
czfilm14
CZFILM18
czfilm18
CzfilmU
czfilmU
CzfilmUnrated
czfilmUnrated

Instances

VideoProcessingDetailsProcessingProgress

data VideoProcessingDetailsProcessingProgress Source

Video processing progress and completion time estimate.

See: videoProcessingDetailsProcessingProgress smart constructor.

Instances

videoProcessingDetailsProcessingProgress :: VideoProcessingDetailsProcessingProgress Source

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

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

vpdppTimeLeftMs :: Lens' VideoProcessingDetailsProcessingProgress (Maybe Word64) Source

An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.

vpdppPartsTotal :: Lens' VideoProcessingDetailsProcessingProgress (Maybe Word64) Source

An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.

vpdppPartsProcessed :: Lens' VideoProcessingDetailsProcessingProgress (Maybe Word64) Source

The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.

ChannelSnippet

data ChannelSnippet Source

Basic details about a channel, including title, description and thumbnails.

See: channelSnippet smart constructor.

Instances

channelSnippet :: ChannelSnippet Source

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

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

csPublishedAt :: Lens' ChannelSnippet (Maybe UTCTime) Source

The date and time that the channel was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

csCountry :: Lens' ChannelSnippet (Maybe Text) Source

The country of the channel.

csThumbnails :: Lens' ChannelSnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the channel. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

csLocalized :: Lens' ChannelSnippet (Maybe ChannelLocalization) Source

Localized title and description, read-only.

csTitle :: Lens' ChannelSnippet (Maybe Text) Source

The channel's title.

csDescription :: Lens' ChannelSnippet (Maybe Text) Source

The description of the channel.

csDefaultLanguage :: Lens' ChannelSnippet (Maybe Text) Source

The language of the channel's default title and description.

ThumbnailDetails

data ThumbnailDetails Source

Internal representation of thumbnails for a YouTube resource.

See: thumbnailDetails smart constructor.

Instances

thumbnailDetails :: ThumbnailDetails Source

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

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

tdMedium :: Lens' ThumbnailDetails (Maybe Thumbnail) Source

The medium quality image for this resource.

tdMaxres :: Lens' ThumbnailDetails (Maybe Thumbnail) Source

The maximum resolution quality image for this resource.

tdDefault :: Lens' ThumbnailDetails (Maybe Thumbnail) Source

The default image for this resource.

tdStandard :: Lens' ThumbnailDetails (Maybe Thumbnail) Source

The standard quality image for this resource.

tdHigh :: Lens' ThumbnailDetails (Maybe Thumbnail) Source

The high quality image for this resource.

MonitorStreamInfo

data MonitorStreamInfo Source

Settings and Info of the monitor stream

See: monitorStreamInfo smart constructor.

Instances

monitorStreamInfo :: MonitorStreamInfo Source

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

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

msiBroadcastStreamDelayMs :: Lens' MonitorStreamInfo (Maybe Word32) Source

If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay.

msiEmbedHTML :: Lens' MonitorStreamInfo (Maybe Text) Source

HTML code that embeds a player that plays the monitor stream.

msiEnableMonitorStream :: Lens' MonitorStreamInfo (Maybe Bool) Source

This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. You need to set this value to true if you intend to have a broadcast delay for your event. Note: This property cannot be updated once the broadcast is in the testing or live state.

ContentRatingRussiaRating

data ContentRatingRussiaRating Source

The video's National Film Registry of the Russian Federation (MKRF - Russia) rating.

Constructors

RUSSIA0
russia0
RUSSIA12
russia12
RUSSIA16
russia16
RUSSIA18
russia18
RUSSIA6
russia6
RussiaUnrated
russiaUnrated

Instances

ContentRatingCicfRating

data ContentRatingCicfRating Source

The video's rating from the Commission de Contrôle des Films (Belgium).

Constructors

CicfE
cicfE
CicfKntEna
cicfKntEna
CicfKtEa
cicfKtEa
CicfUnrated
cicfUnrated

Instances

ContentRatingFmocRating

data ContentRatingFmocRating Source

This property has been deprecated. Use the contentDetails.contentRating.cncRating instead.

Constructors

FMOC10
fmoc10
FMOC12
fmoc12
FMOC16
fmoc16
FMOC18
fmoc18
FmocE
fmocE
FmocU
fmocU
FmocUnrated
fmocUnrated

Instances

LiveBroadcastsTransitionBroadcastStatus

data LiveBroadcastsTransitionBroadcastStatus Source

The broadcastStatus parameter identifies the state to which the broadcast is changing. Note that to transition a broadcast to either the testing or live state, the status.streamStatus must be active for the stream that the broadcast is bound to.

Constructors

LBTBSComplete

complete The broadcast is over. YouTube stops transmitting video.

LBTBSLive

live The broadcast is visible to its audience. YouTube transmits video to the broadcast's monitor stream and its broadcast stream.

LBTBSTesting

testing Start testing the broadcast. YouTube transmits video to the broadcast's monitor stream. Note that you can only transition a broadcast to the testing state if its contentDetails.monitorStream.enableMonitorStream property is set to true.

Instances

I18nRegion

data I18nRegion Source

A i18nRegion resource identifies a region where YouTube is available.

See: i18nRegion smart constructor.

Instances

i18nRegion :: I18nRegion Source

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

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

irEtag :: Lens' I18nRegion (Maybe Text) Source

Etag of this resource.

irSnippet :: Lens' I18nRegion (Maybe I18nRegionSnippet) Source

The snippet object contains basic details about the i18n region, such as region code and human-readable name.

irKind :: Lens' I18nRegion Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegion".

irId :: Lens' I18nRegion (Maybe Text) Source

The ID that YouTube uses to uniquely identify the i18n region.

ChannelStatistics

data ChannelStatistics Source

Statistics about a channel: number of subscribers, number of videos in the channel, etc.

See: channelStatistics smart constructor.

Instances

channelStatistics :: ChannelStatistics Source

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

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

csCommentCount :: Lens' ChannelStatistics (Maybe Word64) Source

The number of comments for the channel.

csSubscriberCount :: Lens' ChannelStatistics (Maybe Word64) Source

The number of subscribers that the channel has.

csVideoCount :: Lens' ChannelStatistics (Maybe Word64) Source

The number of videos uploaded to the channel.

csHiddenSubscriberCount :: Lens' ChannelStatistics (Maybe Bool) Source

Whether or not the number of subscribers is shown for this user.

csViewCount :: Lens' ChannelStatistics (Maybe Word64) Source

The number of times the channel has been viewed.

ChannelId

data ChannelId Source

Instances

channelId :: ChannelId Source

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

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

ciValue :: Lens' ChannelId (Maybe Text) Source

ContentRatingNbcRating

data ContentRatingNbcRating Source

The video's rating from the Maldives National Bureau of Classification.

Constructors

Nbc12plus
nbc12plus
Nbc15plus
nbc15plus
Nbc18plus
nbc18plus
Nbc18plusr
nbc18plusr
NbcG
nbcG
NbcPg
nbcPg
NbcPu
nbcPu
NbcUnrated
nbcUnrated

Instances

LiveBroadcastStatusLiveBroadcastPriority

data LiveBroadcastStatusLiveBroadcastPriority Source

Priority of the live broadcast event (internal state).

Constructors

High
high
Low
low
Normal
normal

Instances

LiveStreamHealthStatusStatus

data LiveStreamHealthStatusStatus Source

The status code of this stream

Constructors

Bad
bad
Good
good
NoData
noData
OK
ok
Revoked
revoked

Instances

ActivityContentDetails

data ActivityContentDetails Source

Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc.

See: activityContentDetails smart constructor.

Instances

activityContentDetails :: ActivityContentDetails Source

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

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

acdPromotedItem :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsPromotedItem) Source

The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem.

acdChannelItem :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsChannelItem) Source

The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.

acdBulletin :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsBulletin) Source

The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.

acdFavorite :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsFavorite) Source

The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.

acdUpload :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsUpload) Source

The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.

acdComment :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsComment) Source

The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.

acdSocial :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsSocial) Source

The social object contains details about a social network post. This property is only present if the snippet.type is social.

acdSubscription :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsSubscription) Source

The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.

acdPlayListItem :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsPlayListItem) Source

The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.

acdLike :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsLike) Source

The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.

acdRecommendation :: Lens' ActivityContentDetails (Maybe ActivityContentDetailsRecommendation) Source

The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.

VideoCategory

data VideoCategory Source

A videoCategory resource identifies a category that has been or could be associated with uploaded videos.

See: videoCategory smart constructor.

Instances

videoCategory :: VideoCategory Source

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

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

vcEtag :: Lens' VideoCategory (Maybe Text) Source

Etag of this resource.

vcSnippet :: Lens' VideoCategory (Maybe VideoCategorySnippet) Source

The snippet object contains basic details about the video category, including its title.

vcKind :: Lens' VideoCategory Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#videoCategory".

vcId :: Lens' VideoCategory (Maybe Text) Source

The ID that YouTube uses to uniquely identify the video category.

VideoRatingRating

data VideoRatingRating Source

Constructors

VRRDislike
dislike
VRRLike
like
VRRNone
none
VRRUnspecified
unspecified

Instances

VideoSuggestionsProcessingWarningsItem

data VideoSuggestionsProcessingWarningsItem Source

Constructors

HasEditList
hasEditlist
InconsistentResolution
inconsistentResolution
ProblematicAudioCodec
problematicAudioCodec
ProblematicVideoCodec
problematicVideoCodec
UnknownAudioCodec
unknownAudioCodec
UnknownContainer
unknownContainer
UnknownVideoCodec
unknownVideoCodec

Instances

VideoLocalizations

data VideoLocalizations Source

List with all localizations.

See: videoLocalizations smart constructor.

Instances

videoLocalizations Source

Arguments

:: HashMap Text VideoLocalization

vlAddtional

-> VideoLocalizations 

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

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

vlAddtional :: Lens' VideoLocalizations (HashMap Text VideoLocalization) Source

The language tag, using string since map_key require simple types.

ChannelSectionContentDetails

data ChannelSectionContentDetails Source

Details about a channelsection, including playlists and channels.

See: channelSectionContentDetails smart constructor.

Instances

channelSectionContentDetails :: ChannelSectionContentDetails Source

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

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

cscdChannels :: Lens' ChannelSectionContentDetails [Text] Source

The channel ids for type multiple_channels.

cscdPlayLists :: Lens' ChannelSectionContentDetails [Text] Source

The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.

InvideoPositionCornerPosition

data InvideoPositionCornerPosition Source

Describes in which corner of the video the visual widget will appear.

Constructors

BottomLeft
bottomLeft
BottomRight
bottomRight
TopLeft
topLeft
TopRight
topRight

Instances

Video

data Video Source

A video resource represents a YouTube video.

See: video smart constructor.

Instances

video :: Video Source

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

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

vStatus :: Lens' Video (Maybe VideoStatus) Source

The status object contains information about the video's uploading, processing, and privacy statuses.

vEtag :: Lens' Video (Maybe Text) Source

Etag of this resource.

vProjectDetails :: Lens' Video (Maybe VideoProjectDetails) Source

The projectDetails object contains information about the project specific video metadata.

vRecordingDetails :: Lens' Video (Maybe VideoRecordingDetails) Source

The recordingDetails object encapsulates information about the location, date and address where the video was recorded.

vSnippet :: Lens' Video (Maybe VideoSnippet) Source

The snippet object contains basic details about the video, such as its title, description, and category.

vKind :: Lens' Video Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#video".

vTopicDetails :: Lens' Video (Maybe VideoTopicDetails) Source

The topicDetails object encapsulates information about Freebase topics associated with the video.

vContentDetails :: Lens' Video (Maybe VideoContentDetails) Source

The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.

vConversionPings :: Lens' Video (Maybe VideoConversionPings) Source

The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.

vAgeGating :: Lens' Video (Maybe VideoAgeGating) Source

Age restriction details related to a video. This data can only be retrieved by the video owner.

vFileDetails :: Lens' Video (Maybe VideoFileDetails) Source

The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.

vSuggestions :: Lens' Video (Maybe VideoSuggestions) Source

The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.

vId :: Lens' Video (Maybe Text) Source

The ID that YouTube uses to uniquely identify the video.

vStatistics :: Lens' Video (Maybe VideoStatistics) Source

The statistics object contains statistics about the video.

vLocalizations :: Lens' Video (Maybe VideoLocalizations) Source

List with all localizations.

vLiveStreamingDetails :: Lens' Video (Maybe VideoLiveStreamingDetails) Source

The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.

vPlayer :: Lens' Video (Maybe VideoPlayer) Source

The player object contains information that you would use to play the video in an embedded player.

vProcessingDetails :: Lens' Video (Maybe VideoProcessingDetails) Source

The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.

vMonetizationDetails :: Lens' Video (Maybe VideoMonetizationDetails) Source

The monetizationDetails object encapsulates information about the monetization status of the video.

LiveBroadcast

data LiveBroadcast Source

A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.

See: liveBroadcast smart constructor.

Instances

liveBroadcast :: LiveBroadcast Source

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

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

lbStatus :: Lens' LiveBroadcast (Maybe LiveBroadcastStatus) Source

The status object contains information about the event's status.

lbEtag :: Lens' LiveBroadcast (Maybe Text) Source

Etag of this resource.

lbSnippet :: Lens' LiveBroadcast (Maybe LiveBroadcastSnippet) Source

The snippet object contains basic details about the event, including its title, description, start time, and end time.

lbKind :: Lens' LiveBroadcast Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".

lbTopicDetails :: Lens' LiveBroadcast (Maybe LiveBroadcastTopicDetails) Source

lbContentDetails :: Lens' LiveBroadcast (Maybe LiveBroadcastContentDetails) Source

The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.

lbId :: Lens' LiveBroadcast (Maybe Text) Source

The ID that YouTube assigns to uniquely identify the broadcast.

lbStatistics :: Lens' LiveBroadcast (Maybe LiveBroadcastStatistics) Source

The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.

ChannelStatusLongUploadsStatus

data ChannelStatusLongUploadsStatus Source

The long uploads status of this channel. See

Constructors

Allowed
allowed
Disallowed
disallowed
Eligible
eligible
LongUploadsUnspecified
longUploadsUnspecified

Instances

LiveStreamContentDetails

data LiveStreamContentDetails Source

Detailed settings of a stream.

See: liveStreamContentDetails smart constructor.

Instances

liveStreamContentDetails :: LiveStreamContentDetails Source

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

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

lscdClosedCaptionsIngestionURL :: Lens' LiveStreamContentDetails (Maybe Text) Source

The ingestion URL where the closed captions of this stream are sent.

lscdIsReusable :: Lens' LiveStreamContentDetails (Maybe Bool) Source

Indicates whether the stream is reusable, which means that it can be bound to multiple broadcasts. It is common for broadcasters to reuse the same stream for many different broadcasts if those broadcasts occur at different times. If you set this value to false, then the stream will not be reusable, which means that it can only be bound to one broadcast. Non-reusable streams differ from reusable streams in the following ways: - A non-reusable stream can only be bound to one broadcast. - A non-reusable stream might be deleted by an automated process after the broadcast ends. - The liveStreams.list method does not list non-reusable streams if you call the method and set the mine parameter to true. The only way to use that method to retrieve the resource for a non-reusable stream is to use the id parameter to identify the stream.

ContentRatingCscfRating

data ContentRatingCscfRating Source

The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF).

Constructors

CSCF12
cscf12
CSCF16
cscf16
CSCF18
cscf18
CSCF6
cscf6
CSCF9
cscf9
CscfA
cscfA
CscfAl
cscfAl
CscfUnrated
cscfUnrated

Instances

LiveBroadcastStatusRecordingStatus

data LiveBroadcastStatusRecordingStatus Source

The broadcast's recording status.

Constructors

NotRecording
notRecording
Recorded
recorded
Recording
recording

Instances

VideoFileDetailsVideoStreamRotation

data VideoFileDetailsVideoStreamRotation Source

The amount that YouTube needs to rotate the original source content to properly display the video.

Constructors

VFDVSRClockwise
clockwise
VFDVSRCounterClockwise
counterClockwise
VFDVSRNone
none
VFDVSROther
other
VFDVSRUpsideDown
upsideDown

Instances

PropertyValue

data PropertyValue Source

A pair Property / Value.

See: propertyValue smart constructor.

Instances

propertyValue :: PropertyValue Source

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

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

pvProperty :: Lens' PropertyValue (Maybe Text) Source

A property.

pvValue :: Lens' PropertyValue (Maybe Text) Source

The property's value.

ContentRatingRtcRating

data ContentRatingRtcRating Source

The video's General Directorate of Radio, Television and Cinematography (Mexico) rating.

Constructors

RtcA
rtcA
RtcAa
rtcAa
RtcB
rtcB
RTCB15
rtcB15
RtcC
rtcC
RtcD
rtcD
RtcUnrated
rtcUnrated

Instances

VideoSnippet

data VideoSnippet Source

Basic details about a video, including title, description, uploader, thumbnails and category.

See: videoSnippet smart constructor.

Instances

videoSnippet :: VideoSnippet Source

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

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

vsDefaultAudioLanguage :: Lens' VideoSnippet (Maybe Text) Source

The default_audio_language property specifies the language spoken in the video's default audio track.

vsPublishedAt :: Lens' VideoSnippet (Maybe UTCTime) Source

The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

vsChannelTitle :: Lens' VideoSnippet (Maybe Text) Source

Channel title for the channel that the video belongs to.

vsChannelId :: Lens' VideoSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.

vsThumbnails :: Lens' VideoSnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

vsLocalized :: Lens' VideoSnippet (Maybe VideoLocalization) Source

Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)

vsCategoryId :: Lens' VideoSnippet (Maybe Text) Source

The YouTube video category associated with the video.

vsTitle :: Lens' VideoSnippet (Maybe Text) Source

The video's title.

vsLiveBroadcastContent :: Lens' VideoSnippet (Maybe VideoSnippetLiveBroadcastContent) Source

Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.

vsDescription :: Lens' VideoSnippet (Maybe Text) Source

The video's description.

vsTags :: Lens' VideoSnippet [Text] Source

A list of keyword tags associated with the video. Tags may contain spaces.

vsDefaultLanguage :: Lens' VideoSnippet (Maybe Text) Source

The language of the videos's default snippet.

CommentThreadsListModerationStatus

data CommentThreadsListModerationStatus Source

Set this parameter to limit the returned comment threads to a particular moderation state. Note: This parameter is not supported for use in conjunction with the id parameter.

Constructors

HeldForReview

heldForReview Retrieve comment threads that are awaiting review by a moderator. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment are awaiting review.

LikelySpam

likelySpam Retrieve comment threads classified as likely to be spam. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment is considered likely to be spam.

Published

published Retrieve threads of published comments. This is the default value. A comment thread can be included in the response if its top-level comment has been published.

Instances

LiveBroadcastSnippet

data LiveBroadcastSnippet Source

Instances

liveBroadcastSnippet :: LiveBroadcastSnippet Source

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

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

lbsActualEndTime :: Lens' LiveBroadcastSnippet (Maybe UTCTime) Source

The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

lbsLiveChatId :: Lens' LiveBroadcastSnippet (Maybe Text) Source

The id of the live chat for this broadcast.

lbsPublishedAt :: Lens' LiveBroadcastSnippet (Maybe UTCTime) Source

The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

lbsScheduledEndTime :: Lens' LiveBroadcastSnippet (Maybe UTCTime) Source

The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

lbsChannelId :: Lens' LiveBroadcastSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.

lbsScheduledStartTime :: Lens' LiveBroadcastSnippet (Maybe UTCTime) Source

The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

lbsThumbnails :: Lens' LiveBroadcastSnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

lbsTitle :: Lens' LiveBroadcastSnippet (Maybe Text) Source

The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource.

lbsActualStartTime :: Lens' LiveBroadcastSnippet (Maybe UTCTime) Source

The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

lbsIsDefaultBroadcast :: Lens' LiveBroadcastSnippet (Maybe Bool) Source

lbsDescription :: Lens' LiveBroadcastSnippet (Maybe Text) Source

The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource.

ContentRatingSmaisRating

data ContentRatingSmaisRating Source

The video's rating in Iceland.

Constructors

SMAIS12
smais12
SMAIS14
smais14
SMAIS16
smais16
SMAIS18
smais18
SMAIS7
smais7
SmaisL
smaisL
SmaisUnrated
smaisUnrated

Instances

AccessPolicy

data AccessPolicy Source

Rights management policy for YouTube resources.

See: accessPolicy smart constructor.

Instances

accessPolicy :: AccessPolicy Source

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

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

apException :: Lens' AccessPolicy [Text] Source

A list of region codes that identify countries where the default policy do not apply.

apAllowed :: Lens' AccessPolicy (Maybe Bool) Source

The value of allowed indicates whether the access to the policy is allowed or denied by default.

ContentRatingYtRating

data ContentRatingYtRating Source

A rating that YouTube uses to identify age-restricted content.

Constructors

YtAgeRestricted
ytAgeRestricted

Instances

CommentThreadListResponse

data CommentThreadListResponse Source

Instances

commentThreadListResponse :: CommentThreadListResponse Source

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

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

ctlrEtag :: Lens' CommentThreadListResponse (Maybe Text) Source

Etag of this resource.

ctlrTokenPagination :: Lens' CommentThreadListResponse (Maybe TokenPagination) Source

ctlrNextPageToken :: Lens' CommentThreadListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

ctlrPageInfo :: Lens' CommentThreadListResponse (Maybe PageInfo) Source

ctlrKind :: Lens' CommentThreadListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#commentThreadListResponse".

ctlrItems :: Lens' CommentThreadListResponse [CommentThread] Source

A list of comment threads that match the request criteria.

ctlrVisitorId :: Lens' CommentThreadListResponse (Maybe Text) Source

The visitorId identifies the visitor.

ctlrEventId :: Lens' CommentThreadListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

WatchSettings

data WatchSettings Source

Branding properties for the watch.

See: watchSettings smart constructor.

Instances

watchSettings :: WatchSettings Source

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

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

wsFeaturedPlayListId :: Lens' WatchSettings (Maybe Text) Source

An ID that uniquely identifies a playlist that displays next to the video player.

wsBackgRoundColor :: Lens' WatchSettings (Maybe Text) Source

The text color for the video watch page's branded area.

wsTextColor :: Lens' WatchSettings (Maybe Text) Source

The background color for the video watch page's branded area.

CdnSettings

data CdnSettings Source

Brief description of the live stream cdn settings.

See: cdnSettings smart constructor.

Instances

cdnSettings :: CdnSettings Source

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

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

csIngestionInfo :: Lens' CdnSettings (Maybe IngestionInfo) Source

The ingestionInfo object contains information that YouTube provides that you need to transmit your RTMP or HTTP stream to YouTube.

csFormat :: Lens' CdnSettings (Maybe Text) Source

The format of the video stream that you are sending to Youtube.

csIngestionType :: Lens' CdnSettings (Maybe CdnSettingsIngestionType) Source

The method or protocol used to transmit the video stream.

VideoContentDetailsCaption

data VideoContentDetailsCaption Source

The value of captions indicates whether the video has captions or not.

Constructors

False'
false
True'
true

Instances

LiveBroadcastStatistics

data LiveBroadcastStatistics Source

Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts.

See: liveBroadcastStatistics smart constructor.

Instances

liveBroadcastStatistics :: LiveBroadcastStatistics Source

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

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

lbsTotalChatCount :: Lens' LiveBroadcastStatistics (Maybe Word64) Source

The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.

lbsConcurrentViewers :: Lens' LiveBroadcastStatistics (Maybe Word64) Source

The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.

SubscriptionsListOrder

data SubscriptionsListOrder Source

The order parameter specifies the method that will be used to sort resources in the API response.

Constructors

SLOAlphabetical

alphabetical Sort alphabetically.

SLORelevance

relevance Sort by relevance.

SLOUnread

unread Sort by order of activity.

Instances

VideoCategorySnippet

data VideoCategorySnippet Source

Basic details about a video category, such as its localized title.

See: videoCategorySnippet smart constructor.

Instances

videoCategorySnippet :: VideoCategorySnippet Source

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

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

vcsAssignable :: Lens' VideoCategorySnippet (Maybe Bool) Source

vcsChannelId :: Lens' VideoCategorySnippet Text Source

The YouTube channel that created the video category.

vcsTitle :: Lens' VideoCategorySnippet (Maybe Text) Source

The video category's title.

I18nLanguage

data I18nLanguage Source

An i18nLanguage resource identifies a UI language currently supported by YouTube.

See: i18nLanguage smart constructor.

Instances

i18nLanguage :: I18nLanguage Source

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

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

ilEtag :: Lens' I18nLanguage (Maybe Text) Source

Etag of this resource.

ilSnippet :: Lens' I18nLanguage (Maybe I18nLanguageSnippet) Source

The snippet object contains basic details about the i18n language, such as language code and human-readable name.

ilKind :: Lens' I18nLanguage Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguage".

ilId :: Lens' I18nLanguage (Maybe Text) Source

The ID that YouTube uses to uniquely identify the i18n language.

ContentRatingBbfcRating

data ContentRatingBbfcRating Source

The video's British Board of Film Classification (BBFC) rating.

Constructors

BBFC12
bbfc12
Bbfc12a
bbfc12a
BBFC15
bbfc15
BBFC18
bbfc18
BbfcPg
bbfcPg
BBFCR18
bbfcR18
BbfcU
bbfcU
BbfcUnrated
bbfcUnrated

Instances

VideoStatistics

data VideoStatistics Source

Statistics about the video, such as the number of times the video was viewed or liked.

See: videoStatistics smart constructor.

Instances

videoStatistics :: VideoStatistics Source

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

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

vsLikeCount :: Lens' VideoStatistics (Maybe Word64) Source

The number of users who have indicated that they liked the video by giving it a positive rating.

vsCommentCount :: Lens' VideoStatistics (Maybe Word64) Source

The number of comments for the video.

vsFavoriteCount :: Lens' VideoStatistics (Maybe Word64) Source

The number of users who currently have the video marked as a favorite video.

vsDislikeCount :: Lens' VideoStatistics (Maybe Word64) Source

The number of users who have indicated that they disliked the video by giving it a negative rating.

vsViewCount :: Lens' VideoStatistics (Maybe Word64) Source

The number of times the video has been viewed.

ActivityListResponse

data ActivityListResponse Source

Instances

activityListResponse :: ActivityListResponse Source

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

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

alrEtag :: Lens' ActivityListResponse (Maybe Text) Source

Etag of this resource.

alrTokenPagination :: Lens' ActivityListResponse (Maybe TokenPagination) Source

alrNextPageToken :: Lens' ActivityListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

alrPageInfo :: Lens' ActivityListResponse (Maybe PageInfo) Source

alrKind :: Lens' ActivityListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#activityListResponse".

alrItems :: Lens' ActivityListResponse [Activity] Source

A list of activities, or events, that match the request criteria.

alrVisitorId :: Lens' ActivityListResponse (Maybe Text) Source

The visitorId identifies the visitor.

alrEventId :: Lens' ActivityListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

alrPrevPageToken :: Lens' ActivityListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

ContentRatingTvpgRating

data ContentRatingTvpgRating Source

The video's TV Parental Guidelines (TVPG) rating.

Constructors

PG14
pg14
TvpgG
tvpgG
TvpgMa
tvpgMa
TvpgPg
tvpgPg
TvpgUnrated
tvpgUnrated
TvpgY
tvpgY
TVPGY7
tvpgY7
TvpgY7Fv
tvpgY7Fv

Instances

CommentsListTextFormat

data CommentsListTextFormat Source

This parameter indicates whether the API should return comments formatted as HTML or as plain text.

Constructors

HTML

html Returns the comments in HTML format. This is the default value.

PlainText

plainText Returns the comments in plain text format.

Instances

VideosRateRating

data VideosRateRating Source

Specifies the rating to record.

Constructors

VDislike

dislike Records that the authenticated user disliked the video.

VLike

like Records that the authenticated user liked the video.

VNone

none Removes any rating that the authenticated user had previously set for the video.

Instances

ActivityContentDetailsBulletin

data ActivityContentDetailsBulletin Source

Details about a channel bulletin post.

See: activityContentDetailsBulletin smart constructor.

Instances

activityContentDetailsBulletin :: ActivityContentDetailsBulletin Source

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

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

acdbResourceId :: Lens' ActivityContentDetailsBulletin (Maybe ResourceId) Source

The resourceId object contains information that identifies the resource associated with a bulletin post.

CaptionSnippetStatus

data CaptionSnippetStatus Source

The caption track's status.

Constructors

Failed
failed
Serving
serving
Syncing
syncing

Instances

VideoAbuseReport

data VideoAbuseReport Source

Instances

videoAbuseReport :: VideoAbuseReport Source

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

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

varSecondaryReasonId :: Lens' VideoAbuseReport (Maybe Text) Source

The ID of this abuse report secondary reason.

varReasonId :: Lens' VideoAbuseReport (Maybe Text) Source

The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID.

varVideoId :: Lens' VideoAbuseReport (Maybe Text) Source

The ID that YouTube uses to uniquely identify the video.

varLanguage :: Lens' VideoAbuseReport (Maybe Text) Source

The language that the content was viewed in.

varComments :: Lens' VideoAbuseReport (Maybe Text) Source

Additional comments regarding the abuse report.

ContentRatingSkfilmRating

data ContentRatingSkfilmRating Source

The video's rating in Slovakia.

Constructors

SkfilmG
skfilmG
SKFILMP2
skfilmP2
SKFILMP5
skfilmP5
SKFILMP8
skfilmP8
SkfilmUnrated
skfilmUnrated

Instances

ChannelSectionSnippetType

data ChannelSectionSnippetType Source

The type of the channel section.

Constructors

AllPlayLists
allPlaylists
ChannelsectionTypeUndefined
channelsectionTypeUndefined
CompletedEvents
completedEvents
LikedPlayLists
likedPlaylists
Likes
likes
LiveEvents
liveEvents
MultipleChannels
multipleChannels
MultiplePlayLists
multiplePlaylists
PopularUploads
popularUploads
PostedPlayLists
postedPlaylists
PostedVideos
postedVideos
RecentActivity
recentActivity
RecentPosts
recentPosts
RecentUploads
recentUploads
SinglePlayList
singlePlaylist
Subscriptions
subscriptions
UpcomingEvents
upcomingEvents

Instances

VideoProcessingDetailsProcessingStatus

data VideoProcessingDetailsProcessingStatus Source

The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.

Constructors

VPDPSFailed
failed
VPDPSProcessing
processing
VPDPSSucceeded
succeeded
VPDPSTerminated
terminated

Instances

ActivityContentDetailsPromotedItemCtaType

data ActivityContentDetailsPromotedItemCtaType Source

The type of call-to-action, a message to the user indicating action that can be taken.

Constructors

Unspecified
unspecified
VisitAdvertiserSite
visitAdvertiserSite

Instances

VideoFileDetailsAudioStream

data VideoFileDetailsAudioStream Source

Information about an audio stream.

See: videoFileDetailsAudioStream smart constructor.

Instances

videoFileDetailsAudioStream :: VideoFileDetailsAudioStream Source

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

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

vfdasBitrateBps :: Lens' VideoFileDetailsAudioStream (Maybe Word64) Source

The audio stream's bitrate, in bits per second.

vfdasVendor :: Lens' VideoFileDetailsAudioStream (Maybe Text) Source

A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.

vfdasCodec :: Lens' VideoFileDetailsAudioStream (Maybe Text) Source

The audio codec that the stream uses.

vfdasChannelCount :: Lens' VideoFileDetailsAudioStream (Maybe Word32) Source

The number of audio channels that the stream contains.

I18nRegionListResponse

data I18nRegionListResponse Source

Instances

i18nRegionListResponse :: I18nRegionListResponse Source

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

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

irlrEtag :: Lens' I18nRegionListResponse (Maybe Text) Source

Etag of this resource.

irlrKind :: Lens' I18nRegionListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#i18nRegionListResponse".

irlrItems :: Lens' I18nRegionListResponse [I18nRegion] Source

A list of regions where YouTube is available. In this map, the i18n region ID is the map key, and its value is the corresponding i18nRegion resource.

irlrVisitorId :: Lens' I18nRegionListResponse (Maybe Text) Source

The visitorId identifies the visitor.

irlrEventId :: Lens' I18nRegionListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

SearchListChannelType

data SearchListChannelType Source

The channelType parameter lets you restrict a search to a particular type of channel.

Constructors

SLCTAny

any Return all channels.

SLCTShow

show Only retrieve shows.

Instances

GuideCategorySnippet

data GuideCategorySnippet Source

Basic details about a guide category.

See: guideCategorySnippet smart constructor.

Instances

guideCategorySnippet :: GuideCategorySnippet Source

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

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

gcsChannelId :: Lens' GuideCategorySnippet Text Source

gcsTitle :: Lens' GuideCategorySnippet (Maybe Text) Source

Description of the guide category.

ContentRatingKmrbRating

data ContentRatingKmrbRating Source

The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea.

Constructors

Kmrb12plus
kmrb12plus
Kmrb15plus
kmrb15plus
KmrbAll
kmrbAll
KmrbR
kmrbR
KmrbTeenr
kmrbTeenr
KmrbUnrated
kmrbUnrated

Instances

ContentRatingOflcRating

data ContentRatingOflcRating Source

The video's Office of Film and Literature Classification (OFLC - New Zealand) rating.

Constructors

OflcG
oflcG
OflcM
oflcM
OflcPg
oflcPg
OFLCR13
oflcR13
OFLCR15
oflcR15
OFLCR16
oflcR16
OFLCR18
oflcR18
OFLCRP13
oflcRp13
OFLCRP16
oflcRp16
OflcUnrated
oflcUnrated

Instances

ContentRatingCNCRating

data ContentRatingCNCRating Source

Rating system in France - Commission de classification cinematographique

Constructors

CNC10
cnc10
CNC12
cnc12
CNC16
cnc16
CNC18
cnc18
CNCE
cncE
CNCT
cncT
CNCUnrated
cncUnrated

Instances

CaptionListResponse

data CaptionListResponse Source

Instances

captionListResponse :: CaptionListResponse Source

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

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

cEtag :: Lens' CaptionListResponse (Maybe Text) Source

Etag of this resource.

cKind :: Lens' CaptionListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#captionListResponse".

cItems :: Lens' CaptionListResponse [Caption] Source

A list of captions that match the request criteria.

cVisitorId :: Lens' CaptionListResponse (Maybe Text) Source

The visitorId identifies the visitor.

cEventId :: Lens' CaptionListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

PlayListItemStatus

data PlayListItemStatus Source

Information about the playlist item's privacy status.

See: playListItemStatus smart constructor.

Instances

playListItemStatus :: PlayListItemStatus Source

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

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

plisPrivacyStatus :: Lens' PlayListItemStatus (Maybe PlayListItemStatusPrivacyStatus) Source

This resource's privacy status.

InvideoPosition

data InvideoPosition Source

Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one.

See: invideoPosition smart constructor.

Instances

invideoPosition :: InvideoPosition Source

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

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

ipCornerPosition :: Lens' InvideoPosition (Maybe InvideoPositionCornerPosition) Source

Describes in which corner of the video the visual widget will appear.

ipType :: Lens' InvideoPosition (Maybe InvideoPositionType) Source

Defines the position type.

ContentRatingGrfilmRating

data ContentRatingGrfilmRating Source

The video's rating in Greece.

Constructors

GrfilmE
grfilmE
GrfilmK
grfilmK
GRFILMK13
grfilmK13
GRFILMK17
grfilmK17
GrfilmUnrated
grfilmUnrated

Instances

CommentThreadsListOrder

data CommentThreadsListOrder Source

The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

Constructors

CTLORelevance

relevance Order by relevance.

CTLOTime

time Order by time.

Instances

LiveStreamHealthStatus

data LiveStreamHealthStatus Source

Instances

liveStreamHealthStatus :: LiveStreamHealthStatus Source

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

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

lshsStatus :: Lens' LiveStreamHealthStatus (Maybe LiveStreamHealthStatusStatus) Source

The status code of this stream

lshsConfigurationIssues :: Lens' LiveStreamHealthStatus [LiveStreamConfigurationIssue] Source

The configurations issues on this stream

lshsLastUpdateTimeSeconds :: Lens' LiveStreamHealthStatus (Maybe Word64) Source

The last time this status was updated (in seconds)

ChannelSectionLocalizations

data ChannelSectionLocalizations Source

Localizations for different languages

See: channelSectionLocalizations smart constructor.

Instances

channelSectionLocalizations Source

Arguments

:: HashMap Text ChannelSectionLocalization

cslAddtional

-> ChannelSectionLocalizations 

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

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

cslAddtional :: Lens' ChannelSectionLocalizations (HashMap Text ChannelSectionLocalization) Source

The language tag, using string since map_key require simple types.

ContentRatingIlfilmRating

data ContentRatingIlfilmRating Source

The video's rating in Israel.

Constructors

ILFILM12
ilfilm12
ILFILM16
ilfilm16
ILFILM18
ilfilm18
IlfilmAa
ilfilmAa
IlfilmUnrated
ilfilmUnrated

Instances

SubscriptionListResponse

data SubscriptionListResponse Source

Instances

subscriptionListResponse :: SubscriptionListResponse Source

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

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

sEtag :: Lens' SubscriptionListResponse (Maybe Text) Source

Etag of this resource.

sTokenPagination :: Lens' SubscriptionListResponse (Maybe TokenPagination) Source

sNextPageToken :: Lens' SubscriptionListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

sPageInfo :: Lens' SubscriptionListResponse (Maybe PageInfo) Source

sKind :: Lens' SubscriptionListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#subscriptionListResponse".

sItems :: Lens' SubscriptionListResponse [Subscription] Source

A list of subscriptions that match the request criteria.

sVisitorId :: Lens' SubscriptionListResponse (Maybe Text) Source

The visitorId identifies the visitor.

sEventId :: Lens' SubscriptionListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

sPrevPageToken :: Lens' SubscriptionListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

ContentRatingNbcplRating

data ContentRatingNbcplRating Source

The video's rating in Poland.

Constructors

Nbcpl18plus
nbcpl18plus
NbcplI
nbcplI
NbcplIi
nbcplIi
NbcplIii
nbcplIii
NbcplIv
nbcplIv
NbcplUnrated
nbcplUnrated

Instances

VideoStatusUploadStatus

data VideoStatusUploadStatus Source

The status of the uploaded video.

Constructors

VSUSDeleted
deleted
VSUSFailed
failed
VSUSProcessed
processed
VSUSRejected
rejected
VSUSUploaded
uploaded

Instances

VideoLocalization

data VideoLocalization Source

Localized versions of certain video properties (e.g. title).

See: videoLocalization smart constructor.

Instances

videoLocalization :: VideoLocalization Source

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

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

vlTitle :: Lens' VideoLocalization (Maybe Text) Source

Localized version of the video's title.

vlDescription :: Lens' VideoLocalization (Maybe Text) Source

Localized version of the video's description.

ContentRatingRteRating

data ContentRatingRteRating Source

The video's rating from Ireland's Raidió Teilifís Éireann.

Constructors

RteCh
rteCh
RteGa
rteGa
RteMa
rteMa
RtePs
rtePs
RteUnrated
rteUnrated

Instances

CommentListResponse

data CommentListResponse Source

Instances

commentListResponse :: CommentListResponse Source

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

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

comEtag :: Lens' CommentListResponse (Maybe Text) Source

Etag of this resource.

comTokenPagination :: Lens' CommentListResponse (Maybe TokenPagination) Source

comNextPageToken :: Lens' CommentListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

comPageInfo :: Lens' CommentListResponse (Maybe PageInfo) Source

comKind :: Lens' CommentListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#commentListResponse".

comItems :: Lens' CommentListResponse [Comment] Source

A list of comments that match the request criteria.

comVisitorId :: Lens' CommentListResponse (Maybe Text) Source

The visitorId identifies the visitor.

comEventId :: Lens' CommentListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

VideoPlayer

data VideoPlayer Source

Player to be used for a video playback.

See: videoPlayer smart constructor.

Instances

videoPlayer :: VideoPlayer Source

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

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

vpEmbedHTML :: Lens' VideoPlayer (Maybe Text) Source

An tag that embeds a player that will play the video.

PromotedItemId

data PromotedItemId Source

Describes a single promoted item id. It is a union of various possible types.

See: promotedItemId smart constructor.

Instances

promotedItemId :: PromotedItemId Source

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

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

piiRecentlyUploadedBy :: Lens' PromotedItemId (Maybe Text) Source

If type is recentUpload, this field identifies the channel from which to take the recent upload. If missing, the channel is assumed to be the same channel for which the invideoPromotion is set.

piiVideoId :: Lens' PromotedItemId (Maybe Text) Source

If the promoted item represents a video, this field represents the unique YouTube ID identifying it. This field will be present only if type has the value video.

piiWebsiteURL :: Lens' PromotedItemId (Maybe Text) Source

If the promoted item represents a website, this field represents the url pointing to the website. This field will be present only if type has the value website.

piiType :: Lens' PromotedItemId (Maybe PromotedItemIdType) Source

Describes the type of the promoted item.

CommentThreadsListTextFormat

data CommentThreadsListTextFormat Source

Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.

Constructors

CTLTFHTML

html Returns the comments in HTML format. This is the default value.

CTLTFPlainText

plainText Returns the comments in plain text format.

Instances

LocalizedString

data LocalizedString Source

Instances

localizedString :: LocalizedString Source

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

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

lsValue :: Lens' LocalizedString (Maybe Text) Source

lsLanguage :: Lens' LocalizedString (Maybe Text) Source

ContentRatingIfcoRating

data ContentRatingIfcoRating Source

The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information.

Constructors

IFCO12
ifco12
Ifco12a
ifco12a
IFCO15
ifco15
Ifco15a
ifco15a
IFCO16
ifco16
IFCO18
ifco18
IfcoG
ifcoG
IfcoPg
ifcoPg
IfcoUnrated
ifcoUnrated

Instances

PlayListItemListResponse

data PlayListItemListResponse Source

Instances

playListItemListResponse :: PlayListItemListResponse Source

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

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

plilrEtag :: Lens' PlayListItemListResponse (Maybe Text) Source

Etag of this resource.

plilrTokenPagination :: Lens' PlayListItemListResponse (Maybe TokenPagination) Source

plilrNextPageToken :: Lens' PlayListItemListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

plilrPageInfo :: Lens' PlayListItemListResponse (Maybe PageInfo) Source

plilrKind :: Lens' PlayListItemListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItemListResponse".

plilrItems :: Lens' PlayListItemListResponse [PlayListItem] Source

A list of playlist items that match the request criteria.

plilrVisitorId :: Lens' PlayListItemListResponse (Maybe Text) Source

The visitorId identifies the visitor.

plilrEventId :: Lens' PlayListItemListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

plilrPrevPageToken :: Lens' PlayListItemListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

CommentsSetModerationStatusModerationStatus

data CommentsSetModerationStatusModerationStatus Source

Identifies the new moderation status of the specified comments.

Constructors

CSMSMSHeldForReview

heldForReview Marks a comment as awaiting review by a moderator.

CSMSMSPublished

published Clears a comment for public display.

CSMSMSRejected

rejected Rejects a comment as being unfit for display. This action also effectively hides all replies to the rejected comment. Note: The API does not currently provide a way to list or otherwise discover rejected comments. However, you can change the moderation status of a rejected comment if you still know its ID. If you were to change the moderation status of a rejected comment, the comment replies would subsequently be discoverable again as well.

Instances

GuideCategory

data GuideCategory Source

A guideCategory resource identifies a category that YouTube algorithmically assigns based on a channel's content or other indicators, such as the channel's popularity. The list is similar to video categories, with the difference being that a video's uploader can assign a video category but only YouTube can assign a channel category.

See: guideCategory smart constructor.

Instances

guideCategory :: GuideCategory Source

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

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

gcEtag :: Lens' GuideCategory (Maybe Text) Source

Etag of this resource.

gcSnippet :: Lens' GuideCategory (Maybe GuideCategorySnippet) Source

The snippet object contains basic details about the category, such as its title.

gcKind :: Lens' GuideCategory Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategory".

gcId :: Lens' GuideCategory (Maybe Text) Source

The ID that YouTube uses to uniquely identify the guide category.

VideoConversionPings

data VideoConversionPings Source

Instances

videoConversionPings :: VideoConversionPings Source

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

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

vcpPings :: Lens' VideoConversionPings [VideoConversionPing] Source

Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

SearchResultSnippet

data SearchResultSnippet Source

Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.

See: searchResultSnippet smart constructor.

Instances

searchResultSnippet :: SearchResultSnippet Source

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

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

srsPublishedAt :: Lens' SearchResultSnippet (Maybe UTCTime) Source

The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

srsChannelTitle :: Lens' SearchResultSnippet (Maybe Text) Source

The title of the channel that published the resource that the search result identifies.

srsChannelId :: Lens' SearchResultSnippet (Maybe Text) Source

The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.

srsThumbnails :: Lens' SearchResultSnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

srsTitle :: Lens' SearchResultSnippet (Maybe Text) Source

The title of the search result.

srsLiveBroadcastContent :: Lens' SearchResultSnippet (Maybe SearchResultSnippetLiveBroadcastContent) Source

It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.

srsDescription :: Lens' SearchResultSnippet (Maybe Text) Source

A description of the search result.

ActivityContentDetailsSocialType

data ActivityContentDetailsSocialType Source

The name of the social network.

Constructors

ACDSTFacebook
facebook
ACDSTGooglePlus
googlePlus
ACDSTTwitter
twitter
ACDSTUnspecified
unspecified

Instances

ContentRatingMedietilsynetRating

data ContentRatingMedietilsynetRating Source

The video's rating from Medietilsynet, the Norwegian Media Authority.

Constructors

MEDIETILSYNET11
medietilsynet11
MEDIETILSYNET12
medietilsynet12
MEDIETILSYNET15
medietilsynet15
MEDIETILSYNET18
medietilsynet18
MEDIETILSYNET6
medietilsynet6
MEDIETILSYNET7
medietilsynet7
MEDIETILSYNET9
medietilsynet9
MedietilsynetA
medietilsynetA
MedietilsynetUnrated
medietilsynetUnrated

Instances

PlayListItemStatusPrivacyStatus

data PlayListItemStatusPrivacyStatus Source

This resource's privacy status.

Constructors

PLISPSPrivate
private
PLISPSPublic
public
PLISPSUnListed
unlisted

Instances

SubscriptionContentDetailsActivityType

data SubscriptionContentDetailsActivityType Source

The type of activity this subscription is for (only uploads, everything).

Constructors

All
all
Uploads
uploads

Instances

ContentRatingFpbRating

data ContentRatingFpbRating Source

The video's rating from South Africa's Film and Publication Board.

Constructors

Fpb1012Pg
fpb1012Pg
FPB13
fpb13
FPB16
fpb16
FPB18
fpb18
Fpb79Pg
fpb79Pg
FpbA
fpbA
FpbPg
fpbPg
FpbUnrated
fpbUnrated
FPBX18
fpbX18
FpbXx
fpbXx

Instances

SearchListVideoDimension

data SearchListVideoDimension Source

The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

S2D

2d Restrict search results to exclude 3D videos.

S3D

3d Restrict search results to only include 3D videos.

SAny

any Include both 3D and non-3D videos in returned results. This is the default value.

Instances

LiveBroadcastTopicSnippet

data LiveBroadcastTopicSnippet Source

Instances

liveBroadcastTopicSnippet :: LiveBroadcastTopicSnippet Source

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

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

lbtsName :: Lens' LiveBroadcastTopicSnippet (Maybe Text) Source

The name of the topic.

lbtsReleaseDate :: Lens' LiveBroadcastTopicSnippet (Maybe Text) Source

The date at which the topic was released. Filled for types: videoGame

ContentRatingNkclvRating

data ContentRatingNkclvRating Source

The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia).

Constructors

Nkclv12plus
nkclv12plus
Nkclv18plus
nkclv18plus
Nkclv7plus
nkclv7plus
NkclvU
nkclvU
NkclvUnrated
nkclvUnrated

Instances

Activity

data Activity Source

An activity resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.

See: activity smart constructor.

Instances

activity :: Activity Source

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

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

aEtag :: Lens' Activity (Maybe Text) Source

Etag of this resource.

aSnippet :: Lens' Activity (Maybe ActivitySnippet) Source

The snippet object contains basic details about the activity, including the activity's type and group ID.

aKind :: Lens' Activity Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#activity".

aContentDetails :: Lens' Activity (Maybe ActivityContentDetails) Source

The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.

aId :: Lens' Activity (Maybe Text) Source

The ID that YouTube uses to uniquely identify the activity.

InvideoPromotion

data InvideoPromotion Source

Describes an invideo promotion campaign consisting of multiple promoted items. A campaign belongs to a single channel_id.

See: invideoPromotion smart constructor.

Instances

invideoPromotion :: InvideoPromotion Source

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

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

ipUseSmartTiming :: Lens' InvideoPromotion (Maybe Bool) Source

Indicates whether the channel's promotional campaign uses "smart timing." This feature attempts to show promotions at a point in the video when they are more likely to be clicked and less likely to disrupt the viewing experience. This feature also picks up a single promotion to show on each video.

ipItems :: Lens' InvideoPromotion [PromotedItem] Source

List of promoted items in decreasing priority.

ipDefaultTiming :: Lens' InvideoPromotion (Maybe InvideoTiming) Source

The default temporal position within the video where the promoted item will be displayed. Can be overriden by more specific timing in the item.

ipPosition :: Lens' InvideoPromotion (Maybe InvideoPosition) Source

The spatial position within the video where the promoted item will be displayed.

InvideoBranding

data InvideoBranding Source

Instances

invideoBranding :: InvideoBranding Source

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

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

ibImageURL :: Lens' InvideoBranding (Maybe Text) Source

ibTargetChannelId :: Lens' InvideoBranding (Maybe Text) Source

ibTiming :: Lens' InvideoBranding (Maybe InvideoTiming) Source

ibImageBytes :: Lens' InvideoBranding (Maybe Word8) Source

ibPosition :: Lens' InvideoBranding (Maybe InvideoPosition) Source

ChannelBannerResource

data ChannelBannerResource Source

A channel banner returned as the response to a channel_banner.insert call.

See: channelBannerResource smart constructor.

Instances

channelBannerResource :: ChannelBannerResource Source

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

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

cbrEtag :: Lens' ChannelBannerResource (Maybe Text) Source

Etag of this resource.

cbrKind :: Lens' ChannelBannerResource Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#channelBannerResource".

cbrURL :: Lens' ChannelBannerResource (Maybe Text) Source

The URL of this banner image.

SearchListVideoType

data SearchListVideoType Source

The videoType parameter lets you restrict a search to a particular type of videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

SLVTAny

any Return all videos.

SLVTEpisode

episode Only retrieve episodes of shows.

SLVTMovie

movie Only retrieve movies.

Instances

I18nLanguageListResponse

data I18nLanguageListResponse Source

Instances

i18nLanguageListResponse :: I18nLanguageListResponse Source

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

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

illrEtag :: Lens' I18nLanguageListResponse (Maybe Text) Source

Etag of this resource.

illrKind :: Lens' I18nLanguageListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#i18nLanguageListResponse".

illrItems :: Lens' I18nLanguageListResponse [I18nLanguage] Source

A list of supported i18n languages. In this map, the i18n language ID is the map key, and its value is the corresponding i18nLanguage resource.

illrVisitorId :: Lens' I18nLanguageListResponse (Maybe Text) Source

The visitorId identifies the visitor.

illrEventId :: Lens' I18nLanguageListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

PlayListPlayer

data PlayListPlayer Source

Instances

playListPlayer :: PlayListPlayer Source

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

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

plpEmbedHTML :: Lens' PlayListPlayer (Maybe Text) Source

An tag that embeds a player that will play the playlist.

ContentRatingMibacRating

data ContentRatingMibacRating Source

The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy).

Constructors

MibacT
mibacT
MibacUnrated
mibacUnrated
MibacVap
mibacVap
MIBACVM12
mibacVm12
MIBACVM14
mibacVm14
MIBACVM18
mibacVm18

Instances

ContentRatingResorteviolenciaRating

data ContentRatingResorteviolenciaRating Source

The video's rating in Venezuela.

Constructors

ResorteviolenciaA
resorteviolenciaA
ResorteviolenciaB
resorteviolenciaB
ResorteviolenciaC
resorteviolenciaC
ResorteviolenciaD
resorteviolenciaD
ResorteviolenciaE
resorteviolenciaE
ResorteviolenciaUnrated
resorteviolenciaUnrated

Instances

ContentRatingEgfilmRating

data ContentRatingEgfilmRating Source

The video's rating in Egypt.

Constructors

EGFILM18
egfilm18
EgfilmBn
egfilmBn
EgfilmGn
egfilmGn
EgfilmUnrated
egfilmUnrated

Instances

ChannelBrandingSettings

data ChannelBrandingSettings Source

Branding properties of a YouTube channel.

See: channelBrandingSettings smart constructor.

Instances

channelBrandingSettings :: ChannelBrandingSettings Source

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

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

cbsImage :: Lens' ChannelBrandingSettings (Maybe ImageSettings) Source

Branding properties for branding images.

cbsHints :: Lens' ChannelBrandingSettings [PropertyValue] Source

Additional experimental branding properties.

cbsChannel :: Lens' ChannelBrandingSettings (Maybe ChannelSettings) Source

Branding properties for the channel view.

cbsWatch :: Lens' ChannelBrandingSettings (Maybe WatchSettings) Source

Branding properties for the watch page.

CommentThread

data CommentThread Source

A comment thread represents information that applies to a top level comment and all its replies. It can also include the top level comment itself and some of the replies.

See: commentThread smart constructor.

Instances

commentThread :: CommentThread Source

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

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

ctEtag :: Lens' CommentThread (Maybe Text) Source

Etag of this resource.

ctSnippet :: Lens' CommentThread (Maybe CommentThreadSnippet) Source

The snippet object contains basic details about the comment thread and also the top level comment.

ctKind :: Lens' CommentThread Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#commentThread".

ctReplies :: Lens' CommentThread (Maybe CommentThreadReplies) Source

The replies object contains a limited number of replies (if any) to the top level comment found in the snippet.

ctId :: Lens' CommentThread (Maybe Text) Source

The ID that YouTube uses to uniquely identify the comment thread.

PlayListLocalization

data PlayListLocalization Source

Playlist localization setting

See: playListLocalization smart constructor.

Instances

playListLocalization :: PlayListLocalization Source

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

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

pllTitle :: Lens' PlayListLocalization (Maybe Text) Source

The localized strings for playlist's title.

pllDescription :: Lens' PlayListLocalization (Maybe Text) Source

The localized strings for playlist's description.

ContentRatingMccypRating

data ContentRatingMccypRating Source

The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People.

Constructors

MCCYP11
mccyp11
MCCYP15
mccyp15
MCCYP7
mccyp7
MccypA
mccypA
MccypUnrated
mccypUnrated

Instances

PlayListStatusPrivacyStatus

data PlayListStatusPrivacyStatus Source

The playlist's privacy status.

Constructors

PLSPSPrivate
private
PLSPSPublic
public
PLSPSUnListed
unlisted

Instances

SubscriptionContentDetails

data SubscriptionContentDetails Source

Details about the content to witch a subscription refers.

See: subscriptionContentDetails smart constructor.

Instances

subscriptionContentDetails :: SubscriptionContentDetails Source

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

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

scdActivityType :: Lens' SubscriptionContentDetails (Maybe SubscriptionContentDetailsActivityType) Source

The type of activity this subscription is for (only uploads, everything).

scdTotalItemCount :: Lens' SubscriptionContentDetails (Maybe Word32) Source

The approximate number of items that the subscription points to.

scdNewItemCount :: Lens' SubscriptionContentDetails (Maybe Word32) Source

The number of new items in the subscription since its content was last read.

LiveBroadcastTopic

data LiveBroadcastTopic Source

Instances

liveBroadcastTopic :: LiveBroadcastTopic Source

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

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

lbtSnippet :: Lens' LiveBroadcastTopic (Maybe LiveBroadcastTopicSnippet) Source

Information about the topic matched.

lbtUnmatched :: Lens' LiveBroadcastTopic (Maybe Bool) Source

If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.

lbtType :: Lens' LiveBroadcastTopic (Maybe LiveBroadcastTopicType) Source

The type of the topic.

ContentRatingCsaRating

data ContentRatingCsaRating Source

The video's rating from France's Conseil supérieur de l?audiovisuel, which rates broadcast content.

Constructors

CSA10
csa10
CSA12
csa12
CSA16
csa16
CSA18
csa18
CsaInterdiction
csaInterdiction
CsaT
csaT
CsaUnrated
csaUnrated

Instances

ChannelConversionPings

data ChannelConversionPings Source

The conversionPings object encapsulates information about conversion pings that need to be respected by the channel.

See: channelConversionPings smart constructor.

Instances

channelConversionPings :: ChannelConversionPings Source

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

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

ccpPings :: Lens' ChannelConversionPings [ChannelConversionPing] Source

Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

LocalizedProperty

data LocalizedProperty Source

Instances

localizedProperty :: LocalizedProperty Source

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

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

lpDefault :: Lens' LocalizedProperty (Maybe Text) Source

lpLocalized :: Lens' LocalizedProperty [LocalizedString] Source

lpDefaultLanguage :: Lens' LocalizedProperty (Maybe LanguageTag) Source

The language of the default property.

ChannelSectionSnippetStyle

data ChannelSectionSnippetStyle Source

The style of the channel section.

Constructors

ChannelsectionStyleUndefined
channelsectionStyleUndefined
HorizontalRow
horizontalRow
VerticalList
verticalList

Instances

ChannelLocalization

data ChannelLocalization Source

Channel localization setting

See: channelLocalization smart constructor.

Instances

channelLocalization :: ChannelLocalization Source

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

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

clTitle :: Lens' ChannelLocalization (Maybe Text) Source

The localized strings for channel's title.

clDescription :: Lens' ChannelLocalization (Maybe Text) Source

The localized strings for channel's description.

PlayListItemContentDetails

data PlayListItemContentDetails Source

Instances

playListItemContentDetails :: PlayListItemContentDetails Source

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

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

plicdStartAt :: Lens' PlayListItemContentDetails (Maybe Text) Source

The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.

plicdNote :: Lens' PlayListItemContentDetails (Maybe Text) Source

A user-generated note for this item.

plicdVideoId :: Lens' PlayListItemContentDetails (Maybe Text) Source

The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request.

plicdEndAt :: Lens' PlayListItemContentDetails (Maybe Text) Source

The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.

ContentRatingEirinRating

data ContentRatingEirinRating Source

The video's Eirin (映倫) rating. Eirin is the Japanese rating system.

Constructors

EirinG
eirinG
EIRINPG12
eirinPg12
EirinR15plus
eirinR15plus
EirinR18plus
eirinR18plus
EirinUnrated
eirinUnrated

Instances

VideoSuggestionsProcessingHintsItem

data VideoSuggestionsProcessingHintsItem Source

Constructors

NonStreamableMov
nonStreamableMov
SendBestQualityVideo
sendBestQualityVideo

Instances

VideoAgeGating

data VideoAgeGating Source

Instances

videoAgeGating :: VideoAgeGating Source

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

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

vagAlcoholContent :: Lens' VideoAgeGating (Maybe Bool) Source

Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.

vagRestricted :: Lens' VideoAgeGating (Maybe Bool) Source

Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.

vagVideoGameRating :: Lens' VideoAgeGating (Maybe VideoAgeGatingVideoGameRating) Source

Video game rating, if any.

ContentRatingNfrcRating

data ContentRatingNfrcRating Source

The video's rating from the Bulgarian National Film Center.

Constructors

NfrcA
nfrcA
NfrcB
nfrcB
NfrcC
nfrcC
NfrcD
nfrcD
NfrcUnrated
nfrcUnrated
NfrcX
nfrcX

Instances

ActivitySnippetType

data ActivitySnippetType Source

The type of activity that the resource describes.

Constructors

ASTBulletin
bulletin
ASTChannelItem
channelItem
ASTComment
comment
ASTFavorite
favorite
ASTLike
like
ASTPlayListItem
playlistItem
ASTPromotedItem
promotedItem
ASTRecommendation
recommendation
ASTSocial
social
ASTSubscription
subscription
ASTUpload
upload

Instances

ContentRatingMocRating

data ContentRatingMocRating Source

The video's Ministerio de Cultura (Colombia) rating.

Constructors

MOC12
moc12
MOC15
moc15
MOC18
moc18
MOC7
moc7
MocBanned
mocBanned
MocE
mocE
MocT
mocT
MocUnrated
mocUnrated
MocX
mocX

Instances

SearchListVideoEmbeddable

data SearchListVideoEmbeddable Source

The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

SLVEAny

any Return all videos, embeddable or not.

SLVETrue'

true Only retrieve embeddable videos.

Instances

LanguageTag

data LanguageTag Source

Instances

languageTag :: LanguageTag Source

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

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

ltValue :: Lens' LanguageTag (Maybe Text) Source

SearchListEventType

data SearchListEventType Source

The eventType parameter restricts a search to broadcast events. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

SLETCompleted

completed Only include completed broadcasts.

SLETLive

live Only include active broadcasts.

SLETUpcoming

upcoming Only include upcoming broadcasts.

Instances

VideoFileDetailsVideoStream

data VideoFileDetailsVideoStream Source

Information about a video stream.

See: videoFileDetailsVideoStream smart constructor.

Instances

videoFileDetailsVideoStream :: VideoFileDetailsVideoStream Source

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

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

vfdvsHeightPixels :: Lens' VideoFileDetailsVideoStream (Maybe Word32) Source

The encoded video content's height in pixels.

vfdvsBitrateBps :: Lens' VideoFileDetailsVideoStream (Maybe Word64) Source

The video stream's bitrate, in bits per second.

vfdvsVendor :: Lens' VideoFileDetailsVideoStream (Maybe Text) Source

A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.

vfdvsRotation :: Lens' VideoFileDetailsVideoStream (Maybe VideoFileDetailsVideoStreamRotation) Source

The amount that YouTube needs to rotate the original source content to properly display the video.

vfdvsFrameRateFps :: Lens' VideoFileDetailsVideoStream (Maybe Double) Source

The video stream's frame rate, in frames per second.

vfdvsCodec :: Lens' VideoFileDetailsVideoStream (Maybe Text) Source

The video codec that the stream uses.

vfdvsAspectRatio :: Lens' VideoFileDetailsVideoStream (Maybe Double) Source

The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.

vfdvsWidthPixels :: Lens' VideoFileDetailsVideoStream (Maybe Word32) Source

The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.

ChannelConversionPing

data ChannelConversionPing Source

Pings that the app shall fire (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.

See: channelConversionPing smart constructor.

Instances

channelConversionPing :: ChannelConversionPing Source

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

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

ccpContext :: Lens' ChannelConversionPing (Maybe ChannelConversionPingContext) Source

Defines the context of the ping.

ccpConversionURL :: Lens' ChannelConversionPing (Maybe Text) Source

The url (without the schema) that the player shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D cview%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.

PlayListItem

data PlayListItem Source

A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.

See: playListItem smart constructor.

Instances

playListItem :: PlayListItem Source

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

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

pliStatus :: Lens' PlayListItem (Maybe PlayListItemStatus) Source

The status object contains information about the playlist item's privacy status.

pliEtag :: Lens' PlayListItem (Maybe Text) Source

Etag of this resource.

pliSnippet :: Lens' PlayListItem (Maybe PlayListItemSnippet) Source

The snippet object contains basic details about the playlist item, such as its title and position in the playlist.

pliKind :: Lens' PlayListItem Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#playlistItem".

pliContentDetails :: Lens' PlayListItem (Maybe PlayListItemContentDetails) Source

The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video.

pliId :: Lens' PlayListItem (Maybe Text) Source

The ID that YouTube uses to uniquely identify the playlist item.

ActivityContentDetailsRecommendationReason

data ActivityContentDetailsRecommendationReason Source

The reason that the resource is recommended to the user.

Constructors

ACDRRUnspecified
unspecified
ACDRRVideoFavorited
videoFavorited
ACDRRVideoLiked
videoLiked
ACDRRVideoWatched
videoWatched

Instances

ContentRatingKijkwijzerRating

data ContentRatingKijkwijzerRating Source

voor de Classificatie van Audiovisuele Media (Netherlands).

Constructors

KIJKWIJZER12
kijkwijzer12
KIJKWIJZER16
kijkwijzer16
KIJKWIJZER18
kijkwijzer18
KIJKWIJZER6
kijkwijzer6
KIJKWIJZER9
kijkwijzer9
KijkwijzerAl
kijkwijzerAl
KijkwijzerUnrated
kijkwijzerUnrated

Instances

VideoSuggestionsProcessingErrorsItem

data VideoSuggestionsProcessingErrorsItem Source

Constructors

ArchiveFile
archiveFile
AudioFile
audioFile
DocFile
docFile
ImageFile
imageFile
NotAVideoFile
notAVideoFile
ProjectFile
projectFile

Instances

VideoFileDetailsFileType

data VideoFileDetailsFileType Source

The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.

Constructors

VFDFTArchive
archive
VFDFTAudio
audio
VFDFTDocument
document
VFDFTImage
image
VFDFTOther
other
VFDFTProject
project
VFDFTVideo
video

Instances

ContentRatingMtrcbRating

data ContentRatingMtrcbRating Source

The video's rating from the Movie and Television Review and Classification Board (Philippines).

Constructors

MtrcbG
mtrcbG
MtrcbPg
mtrcbPg
MTRCBR13
mtrcbR13
MTRCBR16
mtrcbR16
MTRCBR18
mtrcbR18
MtrcbUnrated
mtrcbUnrated
MtrcbX
mtrcbX

Instances

ContentRatingFcoRating

data ContentRatingFcoRating Source

The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration.

Constructors

FcoI
fcoI
FcoIi
fcoIi
FcoIia
fcoIia
FcoIib
fcoIib
FcoIii
fcoIii
FcoUnrated
fcoUnrated

Instances

GuideCategoryListResponse

data GuideCategoryListResponse Source

Instances

guideCategoryListResponse :: GuideCategoryListResponse Source

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

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

gclrEtag :: Lens' GuideCategoryListResponse (Maybe Text) Source

Etag of this resource.

gclrTokenPagination :: Lens' GuideCategoryListResponse (Maybe TokenPagination) Source

gclrNextPageToken :: Lens' GuideCategoryListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

gclrPageInfo :: Lens' GuideCategoryListResponse (Maybe PageInfo) Source

gclrKind :: Lens' GuideCategoryListResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#guideCategoryListResponse".

gclrItems :: Lens' GuideCategoryListResponse [GuideCategory] Source

A list of categories that can be associated with YouTube channels. In this map, the category ID is the map key, and its value is the corresponding guideCategory resource.

gclrVisitorId :: Lens' GuideCategoryListResponse (Maybe Text) Source

The visitorId identifies the visitor.

gclrEventId :: Lens' GuideCategoryListResponse (Maybe Text) Source

Serialized EventId of the request which produced this response.

gclrPrevPageToken :: Lens' GuideCategoryListResponse (Maybe Text) Source

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

CaptionSnippet

data CaptionSnippet Source

Basic details about a caption track, such as its language and name.

See: captionSnippet smart constructor.

Instances

captionSnippet :: CaptionSnippet Source

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

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

csFailureReason :: Lens' CaptionSnippet (Maybe CaptionSnippetFailureReason) Source

The reason that YouTube failed to process the caption track. This property is only present if the state property's value is failed.

csStatus :: Lens' CaptionSnippet (Maybe CaptionSnippetStatus) Source

The caption track's status.

csLastUpdated :: Lens' CaptionSnippet (Maybe UTCTime) Source

The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

csTrackKind :: Lens' CaptionSnippet (Maybe CaptionSnippetTrackKind) Source

The caption track's type.

csIsDraft :: Lens' CaptionSnippet (Maybe Bool) Source

Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false.

csIsCC :: Lens' CaptionSnippet (Maybe Bool) Source

Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false.

csVideoId :: Lens' CaptionSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the video associated with the caption track.

csName :: Lens' CaptionSnippet (Maybe Text) Source

The name of the caption track. The name is intended to be visible to the user as an option during playback.

csIsLarge :: Lens' CaptionSnippet (Maybe Bool) Source

Indicates whether the caption track uses large text for the vision-impaired. The default value is false.

csLanguage :: Lens' CaptionSnippet (Maybe Text) Source

The language of the caption track. The property value is a BCP-47 language tag.

csIsAutoSynced :: Lens' CaptionSnippet (Maybe Bool) Source

Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. For example, when calling the captions.insert or captions.update methods, you can set the sync parameter to true to instruct YouTube to sync the uploaded track to the video. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions.

csIsEasyReader :: Lens' CaptionSnippet (Maybe Bool) Source

Indicates whether caption track is formatted for "easy reader," meaning it is at a third-grade level for language learners. The default value is false.

csAudioTrackType :: Lens' CaptionSnippet (Maybe CaptionSnippetAudioTrackType) Source

The type of audio track associated with the caption track.

Comment

data Comment Source

A comment represents a single YouTube comment.

See: comment smart constructor.

Instances

comment :: Comment Source

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

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

ccEtag :: Lens' Comment (Maybe Text) Source

Etag of this resource.

ccSnippet :: Lens' Comment (Maybe CommentSnippet) Source

The snippet object contains basic details about the comment.

ccKind :: Lens' Comment Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#comment".

ccId :: Lens' Comment (Maybe Text) Source

The ID that YouTube uses to uniquely identify the comment.

I18nRegionSnippet

data I18nRegionSnippet Source

Basic details about an i18n region, such as region code and human-readable name.

See: i18nRegionSnippet smart constructor.

Instances

i18nRegionSnippet :: I18nRegionSnippet Source

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

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

irsName :: Lens' I18nRegionSnippet (Maybe Text) Source

The human-readable name of the region.

irsGl :: Lens' I18nRegionSnippet (Maybe Text) Source

The region code as a 2-letter ISO country code.

LiveStreamConfigurationIssueType

data LiveStreamConfigurationIssueType Source

The kind of error happening.

Constructors

AudioBitrateHigh
audioBitrateHigh
AudioBitrateLow
audioBitrateLow
AudioBitrateMismatch
audioBitrateMismatch
AudioCodec
audioCodec
AudioCodecMismatch
audioCodecMismatch
AudioSampleRate
audioSampleRate
AudioSampleRateMismatch
audioSampleRateMismatch
AudioStereoMismatch
audioStereoMismatch
AudioTooManyChannels
audioTooManyChannels
BadContainer
badContainer
BitrateHigh
bitrateHigh
BitrateLow
bitrateLow
FrameRateHigh
frameRateHigh
FramerateMismatch
framerateMismatch
GopMismatch
gopMismatch
GopSizeLong
gopSizeLong
GopSizeOver
gopSizeOver
GopSizeShort
gopSizeShort
InterlacedVideo
interlacedVideo
MultipleAudioStreams
multipleAudioStreams
MultipleVideoStreams
multipleVideoStreams
NoAudioStream
noAudioStream
NoVideoStream
noVideoStream
OpenGop
openGop
ResolutionMismatch
resolutionMismatch
VideoBitrateMismatch
videoBitrateMismatch
VideoCodec
videoCodec
VideoCodecMismatch
videoCodecMismatch
VideoIngestionStarved
videoIngestionStarved
VideoInterlaceMismatch
videoInterlaceMismatch
VideoProFileMismatch
videoProfileMismatch
VideoResolutionSuboptimal
videoResolutionSuboptimal
VideoResolutionUnsupported
videoResolutionUnsupported

Instances

SearchListSafeSearch

data SearchListSafeSearch Source

The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.

Constructors

SLSSModerate

moderate YouTube will filter some content from search results and, at the least, will filter content that is restricted in your locale. Based on their content, search results could be removed from search results or demoted in search results. This is the default parameter value.

SLSSNone

none YouTube will not filter the search result set.

SLSSStrict

strict YouTube will try to exclude all restricted content from the search result set. Based on their content, search results could be removed from search results or demoted in search results.

Instances

Subscription

data Subscription Source

A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.

See: subscription smart constructor.

Instances

subscription :: Subscription Source

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

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

subEtag :: Lens' Subscription (Maybe Text) Source

Etag of this resource.

subSubscriberSnippet :: Lens' Subscription (Maybe SubscriptionSubscriberSnippet) Source

The subscriberSnippet object contains basic details about the sbuscriber.

subSnippet :: Lens' Subscription (Maybe SubscriptionSnippet) Source

The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.

subKind :: Lens' Subscription Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#subscription".

subContentDetails :: Lens' Subscription (Maybe SubscriptionContentDetails) Source

The contentDetails object contains basic statistics about the subscription.

subId :: Lens' Subscription (Maybe Text) Source

The ID that YouTube uses to uniquely identify the subscription.

SearchListVideoSyndicated

data SearchListVideoSyndicated Source

The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

SLVSAny

any Return all videos, syndicated or not.

SLVSTrue'

true Only retrieve syndicated videos.

Instances

ContentRatingDjctqRatingReasonsItem

data ContentRatingDjctqRatingReasonsItem Source

Constructors

DjctqCriminalActs
djctqCriminalActs
DjctqDrugs
djctqDrugs
DjctqExplicitSex
djctqExplicitSex
DjctqExtremeViolence
djctqExtremeViolence
DjctqIllegalDrugs
djctqIllegalDrugs
DjctqImpactingContent
djctqImpactingContent
DjctqInAppropriateLanguage
djctqInappropriateLanguage
DjctqLegalDrugs
djctqLegalDrugs
DjctqNudity
djctqNudity
DjctqSex
djctqSex
DjctqSexualContent
djctqSexualContent
DjctqViolence
djctqViolence

Instances

VideoRecordingDetails

data VideoRecordingDetails Source

Recording information associated with the video.

See: videoRecordingDetails smart constructor.

Instances

videoRecordingDetails :: VideoRecordingDetails Source

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

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

vrdLocation :: Lens' VideoRecordingDetails (Maybe GeoPoint) Source

The geolocation information associated with the video.

vrdLocationDescription :: Lens' VideoRecordingDetails (Maybe Text) Source

The text description of the location where the video was recorded.

vrdRecordingDate :: Lens' VideoRecordingDetails (Maybe UTCTime) Source

The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.

CdnSettingsIngestionType

data CdnSettingsIngestionType Source

The method or protocol used to transmit the video stream.

Constructors

Dash
dash
Rtmp
rtmp

Instances

InvideoTimingType

data InvideoTimingType Source

Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.

Constructors

OffSetFromEnd
offsetFromEnd
OffSetFromStart
offsetFromStart

Instances

VideoRating

data VideoRating Source

Instances

videoRating :: VideoRating Source

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

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

vRating :: Lens' VideoRating (Maybe VideoRatingRating) Source

vVideoId :: Lens' VideoRating (Maybe Text) Source

ContentRatingAgcomRating

data ContentRatingAgcomRating Source

The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM).

Constructors

AgcomT
agcomT
AgcomUnrated
agcomUnrated
AGCOMVM14
agcomVm14
AGCOMVM18
agcomVm18

Instances

CommentSnippet

data CommentSnippet Source

Basic details about a comment, such as its author and text.

See: commentSnippet smart constructor.

Instances

commentSnippet :: CommentSnippet Source

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

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

cViewerRating :: Lens' CommentSnippet (Maybe CommentSnippetViewerRating) Source

The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future.

cPublishedAt :: Lens' CommentSnippet (Maybe UTCTime) Source

The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

cAuthorChannelURL :: Lens' CommentSnippet (Maybe Text) Source

Link to the author's YouTube channel, if any.

cModerationStatus :: Lens' CommentSnippet (Maybe CommentSnippetModerationStatus) Source

The comment's moderation status. Will not be set if the comments were requested through the id filter.

cLikeCount :: Lens' CommentSnippet (Maybe Word32) Source

The total number of likes this comment has received.

cChannelId :: Lens' CommentSnippet (Maybe Text) Source

The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel.

cTextOriginal :: Lens' CommentSnippet (Maybe Text) Source

The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author.

cVideoId :: Lens' CommentSnippet (Maybe Text) Source

The ID of the video the comment refers to, if any.

cTextDisplay :: Lens' CommentSnippet (Maybe Text) Source

The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc.

cAuthorProFileImageURL :: Lens' CommentSnippet (Maybe Text) Source

The URL for the avatar of the user who posted the comment.

cAuthorDisplayName :: Lens' CommentSnippet (Maybe Text) Source

The name of the user who posted the comment.

cUpdatedAt :: Lens' CommentSnippet (Maybe UTCTime) Source

The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

cAuthorChannelId :: Lens' CommentSnippet (Maybe ChannelId) Source

The id of the author's YouTube channel, if any.

cCanRate :: Lens' CommentSnippet (Maybe Bool) Source

Whether the current viewer can rate this comment.

cAuthorGoogleplusProFileURL :: Lens' CommentSnippet (Maybe Text) Source

Link to the author's Google+ profile, if any.

cParentId :: Lens' CommentSnippet (Maybe Text) Source

The unique id of the parent comment, only set for replies.

LiveStreamStatus

data LiveStreamStatus Source

Brief description of the live stream status.

See: liveStreamStatus smart constructor.

Instances

liveStreamStatus :: LiveStreamStatus Source

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

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

lssStreamStatus :: Lens' LiveStreamStatus (Maybe LiveStreamStatusStreamStatus) Source

lssHealthStatus :: Lens' LiveStreamStatus (Maybe LiveStreamHealthStatus) Source

The health status of the stream.

VideoSuggestions

data VideoSuggestions Source

Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions.

See: videoSuggestions smart constructor.

Instances

videoSuggestions :: VideoSuggestions Source

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

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

vsProcessingErrors :: Lens' VideoSuggestions [VideoSuggestionsProcessingErrorsItem] Source

A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.

vsProcessingHints :: Lens' VideoSuggestions [VideoSuggestionsProcessingHintsItem] Source

A list of suggestions that may improve YouTube's ability to process the video.

vsEditorSuggestions :: Lens' VideoSuggestions [VideoSuggestionsEditorSuggestionsItem] Source

A list of video editing operations that might improve the video quality or playback experience of the uploaded video.

vsProcessingWarnings :: Lens' VideoSuggestions [VideoSuggestionsProcessingWarningsItem] Source

A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.

vsTagSuggestions :: Lens' VideoSuggestions [VideoSuggestionsTagSuggestion] Source

A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.

VideoConversionPingContext

data VideoConversionPingContext Source

Defines the context of the ping.

Constructors

VCPCComment
comment
VCPCDislike
dislike
VCPCLike
like
VCPCShare
share

Instances

CommentSnippetModerationStatus

data CommentSnippetModerationStatus Source

The comment's moderation status. Will not be set if the comments were requested through the id filter.

Constructors

CSMSHeldForReview
heldForReview
CSMSLikelySpam
likelySpam
CSMSPublished
published
CSMSRejected
rejected

Instances

PlayListItemSnippet

data PlayListItemSnippet Source

Basic details about a playlist, including title, description and thumbnails.

See: playListItemSnippet smart constructor.

Instances

playListItemSnippet :: PlayListItemSnippet Source

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

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

plisResourceId :: Lens' PlayListItemSnippet (Maybe ResourceId) Source

The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.

plisPublishedAt :: Lens' PlayListItemSnippet (Maybe UTCTime) Source

The date and time that the item was added to the playlist. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

plisChannelTitle :: Lens' PlayListItemSnippet (Maybe Text) Source

Channel title for the channel that the playlist item belongs to.

plisChannelId :: Lens' PlayListItemSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the user that added the item to the playlist.

plisThumbnails :: Lens' PlayListItemSnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

plisTitle :: Lens' PlayListItemSnippet (Maybe Text) Source

The item's title.

plisPlayListId :: Lens' PlayListItemSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the playlist that the playlist item is in.

plisDescription :: Lens' PlayListItemSnippet (Maybe Text) Source

The item's description.

plisPosition :: Lens' PlayListItemSnippet (Maybe Word32) Source

The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.

VideoProjectDetails

data VideoProjectDetails Source

Project specific details about the content of a YouTube Video.

See: videoProjectDetails smart constructor.

Instances

videoProjectDetails :: VideoProjectDetails Source

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

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

vpdTags :: Lens' VideoProjectDetails [Text] Source

A list of project tags associated with the video during the upload.

SearchListVideoLicense

data SearchListVideoLicense Source

The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Constructors

SLVLAny

any Return all videos, regardless of which license they have, that match the query parameters.

SLVLCreativeCommon

creativeCommon Only return videos that have a Creative Commons license. Users can reuse videos with this license in other videos that they create. Learn more.

SLVLYouTube

youtube Only return videos that have the standard YouTube license.

Instances

ContentRating

data ContentRating Source

Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 66

See: contentRating smart constructor.

Instances

contentRating :: ContentRating Source

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

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

crPefilmRating :: Lens' ContentRating (Maybe ContentRatingPefilmRating) Source

The video's rating in Peru.

crCccRating :: Lens' ContentRating (Maybe ContentRatingCccRating) Source

The video's Consejo de Calificación Cinematográfica (Chile) rating.

crAnatelRating :: Lens' ContentRating (Maybe ContentRatingAnatelRating) Source

The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television.

crMpaaRating :: Lens' ContentRating (Maybe ContentRatingMpaaRating) Source

The video's Motion Picture Association of America (MPAA) rating.

crCceRating :: Lens' ContentRating (Maybe ContentRatingCceRating) Source

The video's rating from Portugal's Comissão de Classificação de Espect´culos.

crMccaaRating :: Lens' ContentRating (Maybe ContentRatingMccaaRating) Source

The video's rating from Malta's Film Age-Classification Board.

crChfilmRating :: Lens' ContentRating (Maybe ContentRatingChfilmRating) Source

The video's rating in Switzerland.

crIcaaRating :: Lens' ContentRating (Maybe ContentRatingIcaaRating) Source

The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating.

crFcbmRating :: Lens' ContentRating (Maybe ContentRatingFcbmRating) Source

The video's rating from Malaysia's Film Censorship Board.

crBmukkRating :: Lens' ContentRating (Maybe ContentRatingBmukkRating) Source

The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur).

crMoctwRating :: Lens' ContentRating (Maybe ContentRatingMoctwRating) Source

The video's rating from Taiwan's Ministry of Culture (文化部).

crNfvcbRating :: Lens' ContentRating (Maybe ContentRatingNfvcbRating) Source

The video's rating from Nigeria's National Film and Video Censors Board.

crDjctqRatingReasons :: Lens' ContentRating [ContentRatingDjctqRatingReasonsItem] Source

Reasons that explain why the video received its DJCQT (Brazil) rating.

crAgcomRating :: Lens' ContentRating (Maybe ContentRatingAgcomRating) Source

The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM).

crCnaRating :: Lens' ContentRating (Maybe ContentRatingCnaRating) Source

The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA).

crCatvfrRating :: Lens' ContentRating (Maybe ContentRatingCatvfrRating) Source

The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.

crCbfcRating :: Lens' ContentRating (Maybe ContentRatingCbfcRating) Source

The video's Central Board of Film Certification (CBFC - India) rating.

crKfcbRating :: Lens' ContentRating (Maybe ContentRatingKfcbRating) Source

The video's rating from the Kenya Film Classification Board.

crSmsaRating :: Lens' ContentRating (Maybe ContentRatingSmsaRating) Source

The video's rating from Statens medieråd (Sweden's National Media Council).

crChvrsRating :: Lens' ContentRating (Maybe ContentRatingChvrsRating) Source

The video's Canadian Home Video Rating System (CHVRS) rating.

crIncaaRating :: Lens' ContentRating (Maybe ContentRatingIncaaRating) Source

The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating.

crNfrcRating :: Lens' ContentRating (Maybe ContentRatingNfrcRating) Source

The video's rating from the Bulgarian National Film Center.

crCsaRating :: Lens' ContentRating (Maybe ContentRatingCsaRating) Source

The video's rating from France's Conseil supérieur de l?audiovisuel, which rates broadcast content.

crMocRating :: Lens' ContentRating (Maybe ContentRatingMocRating) Source

The video's Ministerio de Cultura (Colombia) rating.

crEirinRating :: Lens' ContentRating (Maybe ContentRatingEirinRating) Source

The video's Eirin (映倫) rating. Eirin is the Japanese rating system.

crFskRating :: Lens' ContentRating (Maybe ContentRatingFskRating) Source

The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating.

crEefilmRating :: Lens' ContentRating (Maybe ContentRatingEefilmRating) Source

The video's rating in Estonia.

crRcnofRating :: Lens' ContentRating (Maybe ContentRatingRcnofRating) Source

The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film.

crMekuRating :: Lens' ContentRating (Maybe ContentRatingMekuRating) Source

The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute).

crIlfilmRating :: Lens' ContentRating (Maybe ContentRatingIlfilmRating) Source

The video's rating in Israel.

crIfcoRating :: Lens' ContentRating (Maybe ContentRatingIfcoRating) Source

The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information.

crNbcplRating :: Lens' ContentRating (Maybe ContentRatingNbcplRating) Source

The video's rating in Poland.

crGrfilmRating :: Lens' ContentRating (Maybe ContentRatingGrfilmRating) Source

The video's rating in Greece.

crRteRating :: Lens' ContentRating (Maybe ContentRatingRteRating) Source

The video's rating from Ireland's Raidió Teilifís Éireann.

crAcbRating :: Lens' ContentRating (Maybe ContentRatingAcbRating) Source

The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming.

crCatvRating :: Lens' ContentRating (Maybe ContentRatingCatvRating) Source

Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.

crMdaRating :: Lens' ContentRating (Maybe ContentRatingMdaRating) Source

The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC).

crDjctqRating :: Lens' ContentRating (Maybe ContentRatingDjctqRating) Source

The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating.

crSmaisRating :: Lens' ContentRating (Maybe ContentRatingSmaisRating) Source

The video's rating in Iceland.

crCscfRating :: Lens' ContentRating (Maybe ContentRatingCscfRating) Source

The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF).

crTvpgRating :: Lens' ContentRating (Maybe ContentRatingTvpgRating) Source

The video's TV Parental Guidelines (TVPG) rating.

crRtcRating :: Lens' ContentRating (Maybe ContentRatingRtcRating) Source

The video's General Directorate of Radio, Television and Cinematography (Mexico) rating.

crYtRating :: Lens' ContentRating (Maybe ContentRatingYtRating) Source

A rating that YouTube uses to identify age-restricted content.

crBbfcRating :: Lens' ContentRating (Maybe ContentRatingBbfcRating) Source

The video's British Board of Film Classification (BBFC) rating.

crKijkwijzerRating :: Lens' ContentRating (Maybe ContentRatingKijkwijzerRating) Source

voor de Classificatie van Audiovisuele Media (Netherlands).

crMtrcbRating :: Lens' ContentRating (Maybe ContentRatingMtrcbRating) Source

The video's rating from the Movie and Television Review and Classification Board (Philippines).

crFcoRating :: Lens' ContentRating (Maybe ContentRatingFcoRating) Source

The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration.

crCicfRating :: Lens' ContentRating (Maybe ContentRatingCicfRating) Source

The video's rating from the Commission de Contrôle des Films (Belgium).

crCzfilmRating :: Lens' ContentRating (Maybe ContentRatingCzfilmRating) Source

The video's rating in the Czech Republic.

crNbcRating :: Lens' ContentRating (Maybe ContentRatingNbcRating) Source

The video's rating from the Maldives National Bureau of Classification.

crFmocRating :: Lens' ContentRating (Maybe ContentRatingFmocRating) Source

This property has been deprecated. Use the contentDetails.contentRating.cncRating instead.

crRussiaRating :: Lens' ContentRating (Maybe ContentRatingRussiaRating) Source

The video's National Film Registry of the Russian Federation (MKRF - Russia) rating.

crEgfilmRating :: Lens' ContentRating (Maybe ContentRatingEgfilmRating) Source

The video's rating in Egypt.

crResorteviolenciaRating :: Lens' ContentRating (Maybe ContentRatingResorteviolenciaRating) Source

The video's rating in Venezuela.

crMibacRating :: Lens' ContentRating (Maybe ContentRatingMibacRating) Source

The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy).

crMedietilsynetRating :: Lens' ContentRating (Maybe ContentRatingMedietilsynetRating) Source

The video's rating from Medietilsynet, the Norwegian Media Authority.

crMccypRating :: Lens' ContentRating (Maybe ContentRatingMccypRating) Source

The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People.

crNkclvRating :: Lens' ContentRating (Maybe ContentRatingNkclvRating) Source

The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia).

crFpbRating :: Lens' ContentRating (Maybe ContentRatingFpbRating) Source

The video's rating from South Africa's Film and Publication Board.

crLsfRating :: Lens' ContentRating (Maybe ContentRatingLsfRating) Source

The video's rating from Indonesia's Lembaga Sensor Film.

crBfvcRating :: Lens' ContentRating (Maybe ContentRatingBfvcRating) Source

The video's rating from Thailand's Board of Film and Video Censors.

crCNCRating :: Lens' ContentRating (Maybe ContentRatingCNCRating) Source

Rating system in France - Commission de classification cinematographique

crSkfilmRating :: Lens' ContentRating (Maybe ContentRatingSkfilmRating) Source

The video's rating in Slovakia.

crOflcRating :: Lens' ContentRating (Maybe ContentRatingOflcRating) Source

The video's Office of Film and Literature Classification (OFLC - New Zealand) rating.

crKmrbRating :: Lens' ContentRating (Maybe ContentRatingKmrbRating) Source

The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea.

PlayList

data PlayList Source

A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private. YouTube also uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.

See: playList smart constructor.

Instances

playList :: PlayList Source

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

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

plStatus :: Lens' PlayList (Maybe PlayListStatus) Source

The status object contains status information for the playlist.

plEtag :: Lens' PlayList (Maybe Text) Source

Etag of this resource.

plSnippet :: Lens' PlayList (Maybe PlayListSnippet) Source

The snippet object contains basic details about the playlist, such as its title and description.

plKind :: Lens' PlayList Text Source

Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".

plContentDetails :: Lens' PlayList (Maybe PlayListContentDetails) Source

The contentDetails object contains information like video count.

plId :: Lens' PlayList (Maybe Text) Source

The ID that YouTube uses to uniquely identify the playlist.

plLocalizations :: Lens' PlayList (Maybe PlayListLocalizations) Source

Localizations for different languages

plPlayer :: Lens' PlayList (Maybe PlayListPlayer) Source

The player object contains information that you would use to play the playlist in an embedded player.

LiveStreamStatusStreamStatus

data LiveStreamStatusStreamStatus Source

Constructors

LSSSSActive
active
LSSSSCreated
created
LSSSSError'
error
LSSSSInactive
inactive
LSSSSReady
ready

Instances

VideoStatusLicense

data VideoStatusLicense Source

The video's license.

Constructors

CreativeCommon
creativeCommon
YouTube
youtube

Instances

ContentRatingNfvcbRating

data ContentRatingNfvcbRating Source

The video's rating from Nigeria's National Film and Video Censors Board.

Constructors

NFVCB12
nfvcb12
Nfvcb12a
nfvcb12a
NFVCB15
nfvcb15
NFVCB18
nfvcb18
NfvcbG
nfvcbG
NfvcbPg
nfvcbPg
NfvcbRe
nfvcbRe
NfvcbUnrated
nfvcbUnrated

Instances

ChannelSettings

data ChannelSettings Source

Branding properties for the channel view.

See: channelSettings smart constructor.

Instances

channelSettings :: ChannelSettings Source

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

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

cShowRelatedChannels :: Lens' ChannelSettings (Maybe Bool) Source

Whether related channels should be proposed.

cDefaultTab :: Lens' ChannelSettings (Maybe Text) Source

Which content tab users should see when viewing the channel.

cFeaturedChannelsTitle :: Lens' ChannelSettings (Maybe Text) Source

Title for the featured channels tab.

cCountry :: Lens' ChannelSettings (Maybe Text) Source

The country of the channel.

cProFileColor :: Lens' ChannelSettings (Maybe Text) Source

A prominent color that can be rendered on this channel page.

cModerateComments :: Lens' ChannelSettings (Maybe Bool) Source

Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.

cKeywords :: Lens' ChannelSettings (Maybe Text) Source

Lists keywords associated with the channel, comma-separated.

cUnsubscribedTrailer :: Lens' ChannelSettings (Maybe Text) Source

The trailer of the channel, for users that are not subscribers.

cTrackingAnalyticsAccountId :: Lens' ChannelSettings (Maybe Text) Source

The ID for a Google Analytics account to track and measure traffic to the channels.

cFeaturedChannelsURLs :: Lens' ChannelSettings [Text] Source

The list of featured channels.

cShowBrowseView :: Lens' ChannelSettings (Maybe Bool) Source

Whether the tab to browse the videos should be displayed.

cTitle :: Lens' ChannelSettings (Maybe Text) Source

Specifies the channel title.

cDescription :: Lens' ChannelSettings (Maybe Text) Source

Specifies the channel description.

cDefaultLanguage :: Lens' ChannelSettings (Maybe Text) Source

SubscriptionSnippet

data SubscriptionSnippet Source

Basic details about a subscription, including title, description and thumbnails of the subscribed item.

See: subscriptionSnippet smart constructor.

Instances

subscriptionSnippet :: SubscriptionSnippet Source

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

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

ssResourceId :: Lens' SubscriptionSnippet (Maybe ResourceId) Source

The id object contains information about the channel that the user subscribed to.

ssPublishedAt :: Lens' SubscriptionSnippet (Maybe UTCTime) Source

The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

ssChannelTitle :: Lens' SubscriptionSnippet (Maybe Text) Source

Channel title for the channel that the subscription belongs to.

ssChannelId :: Lens' SubscriptionSnippet (Maybe Text) Source

The ID that YouTube uses to uniquely identify the subscriber's channel.

ssThumbnails :: Lens' SubscriptionSnippet (Maybe ThumbnailDetails) Source

A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

ssTitle :: Lens' SubscriptionSnippet (Maybe Text) Source

The subscription's title.

ssDescription :: Lens' SubscriptionSnippet (Maybe Text) Source

The subscription's details.

VideoLiveStreamingDetails

data VideoLiveStreamingDetails Source

Details about the live streaming metadata.

See: videoLiveStreamingDetails smart constructor.

Instances

videoLiveStreamingDetails :: VideoLiveStreamingDetails Source

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

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

vlsdActualEndTime :: Lens' VideoLiveStreamingDetails (Maybe UTCTime) Source

The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over.

vlsdConcurrentViewers :: Lens' VideoLiveStreamingDetails (Maybe Word64) Source

The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.

vlsdScheduledEndTime :: Lens' VideoLiveStreamingDetails (Maybe UTCTime) Source

The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.

vlsdScheduledStartTime :: Lens' VideoLiveStreamingDetails (Maybe UTCTime) Source

The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

vlsdActualStartTime :: Lens' VideoLiveStreamingDetails (Maybe UTCTime) Source

The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins.

ContentRatingMdaRating

data ContentRatingMdaRating Source

The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC).

Constructors

MdaG
mdaG
MDAM18
mdaM18
MDANC16
mdaNc16
MdaPg
mdaPg
MDAPG13
mdaPg13
MDAR21
mdaR21
MdaUnrated
mdaUnrated

Instances

ActivityContentDetailsPromotedItem

data ActivityContentDetailsPromotedItem Source

Details about a resource which is being promoted.

See: activityContentDetailsPromotedItem smart constructor.

Instances

activityContentDetailsPromotedItem :: ActivityContentDetailsPromotedItem Source

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

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

acdpiDestinationURL :: Lens' ActivityContentDetailsPromotedItem (Maybe Text) Source

The URL the client should direct the user to, if the user chooses to visit the advertiser's website.

acdpiClickTrackingURL :: Lens' ActivityContentDetailsPromotedItem (Maybe Text) Source

The URL the client should ping to indicate that the user clicked through on this promoted item.

acdpiForecastingURL :: Lens' ActivityContentDetailsPromotedItem [Text] Source

The list of forecasting URLs. The client should ping all of these URLs when a promoted item is not available, to indicate that a promoted item could have been shown.

acdpiDescriptionText :: Lens' ActivityContentDetailsPromotedItem (Maybe Text) Source

The text description to accompany the promoted item.

acdpiCtaType :: Lens' ActivityContentDetailsPromotedItem (Maybe ActivityContentDetailsPromotedItemCtaType) Source

The type of call-to-action, a message to the user indicating action that can be taken.

acdpiVideoId :: Lens' ActivityContentDetailsPromotedItem (Maybe Text) Source

The ID that YouTube uses to uniquely identify the promoted video.

acdpiAdTag :: Lens' ActivityContentDetailsPromotedItem (Maybe Text) Source

The URL the client should fetch to request a promoted item.

acdpiCreativeViewURL :: Lens' ActivityContentDetailsPromotedItem (Maybe Text) Source

The URL the client should ping to indicate that the user was shown this promoted item.

acdpiImpressionURL :: Lens' ActivityContentDetailsPromotedItem [Text] Source

The list of impression URLs. The client should ping all of these URLs to indicate that the user was shown this promoted item.

acdpiCustomCtaButtonText :: Lens' ActivityContentDetailsPromotedItem (Maybe Text) Source

The custom call-to-action button text. If specified, it will override the default button text for the cta_type.

ContentRatingAcbRating

data ContentRatingAcbRating Source

The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming.

Constructors

AcbC
acbC
AcbE
acbE
AcbG
acbG
AcbM
acbM
AcbMa15plus
acbMa15plus
AcbP
acbP
AcbPg
acbPg
AcbR18plus
acbR18plus
AcbUnrated
acbUnrated

Instances

VideoConversionPing

data VideoConversionPing Source

Instances

videoConversionPing :: VideoConversionPing Source

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

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

vcpContext :: Lens' VideoConversionPing (Maybe VideoConversionPingContext) Source

Defines the context of the ping.

vcpConversionURL :: Lens' VideoConversionPing (Maybe Text) Source

The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.

ContentRatingDjctqRating

data ContentRatingDjctqRating Source

The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating.

Constructors

DJCTQ10
djctq10
DJCTQ12
djctq12
DJCTQ14
djctq14
DJCTQ16
djctq16
DJCTQ18
djctq18
DjctqL
djctqL
DjctqUnrated
djctqUnrated

Instances

GeoPoint

data GeoPoint Source

Geographical coordinates of a point, in WGS84.

See: geoPoint smart constructor.

Instances

geoPoint :: GeoPoint Source

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

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

gpLatitude :: Lens' GeoPoint (Maybe Double) Source

Latitude in degrees.

gpAltitude :: Lens' GeoPoint (Maybe Double) Source

Altitude above the reference ellipsoid, in meters.

gpLongitude :: Lens' GeoPoint (Maybe Double) Source

Longitude in degrees.

CommentThreadReplies

data CommentThreadReplies Source

Comments written in (direct or indirect) reply to the top level comment.

See: commentThreadReplies smart constructor.

Instances

commentThreadReplies :: CommentThreadReplies Source

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

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

ctrComments :: Lens' CommentThreadReplies [Comment] Source

A limited number of replies. Unless the number of replies returned equals total_reply_count in the snippet the returned replies are only a subset of the total number of replies.

ChannelSectionLocalization

data ChannelSectionLocalization Source

ChannelSection localization setting

See: channelSectionLocalization smart constructor.

Instances

channelSectionLocalization :: ChannelSectionLocalization Source

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

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

cslTitle :: Lens' ChannelSectionLocalization (Maybe Text) Source

The localized strings for channel section's title.

VideoAbuseReportSecondaryReason

data VideoAbuseReportSecondaryReason Source

Instances

videoAbuseReportSecondaryReason :: VideoAbuseReportSecondaryReason Source

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

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

varsrId :: Lens' VideoAbuseReportSecondaryReason (Maybe Text) Source

The ID of this abuse report secondary reason.

varsrLabel :: Lens' VideoAbuseReportSecondaryReason (Maybe Text) Source

The localized label for this abuse report secondary reason.

VideoStatusFailureReason

data VideoStatusFailureReason Source

This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.

Constructors

Codec
codec
Conversion
conversion
EmptyFile
emptyFile
InvalidFile
invalidFile
TooSmall
tooSmall
UploadAborted
uploadAborted

Instances

ChannelContentOwnerDetails

data ChannelContentOwnerDetails Source

The contentOwnerDetails object encapsulates channel data that is relevant for YouTube Partners linked with the channel.

See: channelContentOwnerDetails smart constructor.

Instances

channelContentOwnerDetails :: ChannelContentOwnerDetails Source

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

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

ccodTimeLinked :: Lens' ChannelContentOwnerDetails (Maybe UTCTime) Source

The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

ccodContentOwner :: Lens' ChannelContentOwnerDetails (Maybe Text) Source

The ID of the content owner linked to the channel.

I18nLanguageSnippet

data I18nLanguageSnippet Source

Basic details about an i18n language, such as language code and human-readable name.

See: i18nLanguageSnippet smart constructor.

Instances

i18nLanguageSnippet :: I18nLanguageSnippet Source

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

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

ilsHl :: Lens' I18nLanguageSnippet (Maybe Text) Source

A short BCP-47 code that uniquely identifies a language.

ilsName :: Lens' I18nLanguageSnippet (Maybe Text) Source

The human-readable name of the language in the language itself.

ContentRatingCatvRating

data ContentRatingCatvRating Source

Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website.

Constructors

Catv14plus
catv14plus
Catv18plus
catv18plus
CatvC
catvC
CATVC8
catvC8
CatvG
catvG
CatvPg
catvPg
CatvUnrated
catvUnrated

Instances