TwurpleAuthenticationGetting dataExamplesFAQMigration

Classes

EventSubChannelAdBreakBeginEventEventSubChannelBanEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatSettingsUpdateEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEvent

EventSubChannelAdBreakBeginEvent

An EventSub event representing an ad break beginning in a broadcaster channel.

Overview

Properties

broadcasterDisplayName

Type: string

The broadcaster's user display name for the channel the ad was run on.

broadcasterId

Type: string

The broadcaster's user ID for the channel the ad was run on.

broadcasterName

Type: string

The broadcaster's user login for the channel the ad was run on.

durationSeconds

Type: number

Length in seconds of the mid-roll ad break requested.

isAutomatic

Type: boolean

Indicates if the ad was automatically scheduled via Ads Manager.

requesterDisplayName

Type: string

The display name of the user that requested the ad.

requesterId

Type: string

The ID of the user that requested the ad. For automatic ads, this will be the ID of the broadcaster.

requesterName

Type: string

The login of the user that requested the ad.

startDate

Type: Date

The date/time when the ad break started.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getRequester()

async

Gets more information about the user that requested the ad.

Return type: HelixUser