Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AdService

A class that allows the display of mobile video ads.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 25

HistoryMember
655CreateAdRewardFromDevProductId(devProductId: int64): AdReward
657GetAdAvailabilityNowAsync(adFormat: AdFormat): Variant
565GetAdTeleportInfo(): Tuple
580GetReportAdInfo(): Array
657HandleWhyThisAdClicked(advertiserName: string, payerName: string): null
612HideEudsaDisclosure(): null
657OnDemandVideoCompleteFromUI(result: ShowAdResult, encryptedAdTrackingData: string, encryptionMetadata: string, rewardDetails: string): null
573ReturnToPublisherExperience(adTeleportMethod: AdTeleportMethod): null
627SetAdGuiInteractivityHandlerInitialized(): null
655ShowRewardedVideoAdAsync(player: Player, reward: AdReward): ShowAdResult
573ShowVideoAd(): null
547AdTeleportEnded()
547AdTeleportInitiated()
587PortalPrompt(destinationId: int64, portal: Instance, requiresNoButton: bool)
617ShowDynamicEudsaDisclosure(advertiserName: string, payerName: string)
655ShowReportAdPopup(adInfo: Dictionary)
462VideoAdClosed(adShown: bool)
627adGuiRegisterUI(adGui: Instance)
657onDemandVideoPlayInUI(data: Dictionary): VideoFrame
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 3

HistoryMember
657GetAdAvailability(adFormat: AdFormat): Variant
657AdAvailabilityChanged(adFormat: AdFormat, adAvailabilityResult: Variant)
655ShowStaticEudsaDisclosure()

Description

This AdService was a service for displaying mobile video ads as a form of monetization. It has been superseded by Immersive Ads which should be used instead to serve ad units to visitors of your experience.

History 50

Members 25

AdTeleportEnded

Parameters (0)
No parameters.

History 1

AdTeleportInitiated

Parameters (0)
No parameters.

History 1

CreateAdRewardFromDevProductId

Parameters (1)
devProductIdint64
Returns (1)
AdReward

History 1

GetAdAvailabilityNowAsync

Parameters (1)
adFormatAdFormat
Returns (1)
Variant
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

GetAdTeleportInfo

Parameters (0)
No parameters.
Returns (1)
Tuple

History 1

GetReportAdInfo

Parameters (0)
No parameters.
Returns (1)
Array

History 1

HandleWhyThisAdClicked

Parameters (2)
advertiserNamestring
payerNamestring
Returns (1)
null

History 1

HideEudsaDisclosure

Parameters (0)
No parameters.
Returns (1)
null

History 1

OnDemandVideoCompleteFromUI

Parameters (4)
resultShowAdResult
encryptedAdTrackingDatastring
rewardDetailsstring
Returns (1)
null

History 1

PortalPrompt

Parameters (3)
destinationIdint64
portalInstance
requiresNoButtonbool

History 2

ReturnToPublisherExperience

Parameters (1)
adTeleportMethodAdTeleportMethod
Returns (1)
null

History 2

SetAdGuiInteractivityHandlerInitialized

Parameters (0)
No parameters.
Returns (1)
null

History 1

ShowDynamicEudsaDisclosure

Parameters (2)
advertiserNamestring
payerNamestring

History 1

ShowReportAdPopup

Parameters (1)
adInfoDictionary

History 1

ShowRewardedVideoAdAsync

Parameters (2)
playerPlayer
rewardAdReward
Returns (1)
ShowAdResult
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

ShowVideoAd

Parameters (0)
No parameters.
Returns (1)
null

Show mobile video advertisements.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 6

Tags: [Deprecated]

VideoAdClosed

Parameters (1)
adShownbool

Fires when an AdService video closes.

This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 6

Tags: [Deprecated]

adGuiRegisterUI

Parameters (1)
adGuiInstance

History 1

onDemandVideoPlayInUI

Parameters (1)
dataDictionary
Returns (1)
VideoFrame

History 1

Removed members 3

AdAvailabilityChanged

Parameters (2)
adFormatAdFormat
adAvailabilityResultVariant

History 2

GetAdAvailability

Parameters (1)
adFormatAdFormat
Returns (1)
Variant

History 2

ShowStaticEudsaDisclosure

Parameters (0)
No parameters.

History 2

Settings