AdService
CreatorHub

A class that allows the display of mobile video ads.

Instances of this class cannot be created with Instance.new.

It is a singleton that may be acquired with GetService.

Memory category	Instances

Tags: [NotCreatable, Service]

Member index 38

History		Member
655		CreateAdRewardFromDevProductId(devProductId: int64): AdReward
712		GetAdAvailabilityNowAsync(adFormat: AdFormat): Dictionary
712		GetAdAvailabilityNowForUniverseAsync(adFormat: AdFormat, universeId: int64, isUniversalAppDM: bool): Dictionary
565		GetAdTeleportInfo(): Tuple
712		GetCampaignEligibilityAsync(campaignId: string, player: Player = Player): Dictionary
580		GetReportAdInfo(): Array
657		HandleWhyThisAdClicked(advertiserName: string, payerName: string): null
612		HideEudsaDisclosure(): null
657		OnDemandVideoCompleteFromUI(result: ShowAdResult, encryptedAdTrackingData: string, encryptionMetadata: string, rewardDetails: string): null
681		RegisterAdOpportunityAsync(instance: Instance, placementId: int64?): null
712		RegisterDisclosureButton(disclosureButton: GuiButton, immersiveBrandedAdId: string): null
573		ReturnToPublisherExperience(adTeleportMethod: AdTeleportMethod): null
627		SetAdGuiInteractivityHandlerInitialized(): null
675		ShowRewardedVideoAdAsync(player: Player, reward: AdReward, placementId: int64?): ShowAdResult
692		ShowRewardedVideoAdAtClientAsync(universeId: int64): ShowAdResult
573		ShowVideoAd(): null
692		SubmitAdNotification(universeId: int64, isShowAdSuccessful: bool, earnedReward: bool, rewardProductName: string, rewardProductImageAssetId: int64): null
681		UnregisterAdOpportunity(instance: Instance): null
547		AdTeleportEnded()
547		AdTeleportInitiated()
712		CampaignEligibilityResponseFailureSignalFromClient(campaignId: string, error: string)
712		CampaignEligibilityResponseSuccessSignalFromClient(campaignId: string, response: Dictionary)
712		GetCampaignEligibilitySignalFromServer(campaignId: string)
553		ReportImpressionSignal(ad_instance_name: string, encrypted_ad_tracking_data: string, encryption_metadata: string)
553		ReportTeleportSignal(ad_instance_name: string, encrypted_ad_tracking_data: string, encryption_metadata: string, teleport_type: string, teleport_source_universe_id: int64, teleport_source_place_id: int64, teleport_dest_place_id: int64)
674		RewardedVideoAdEnded()
674		RewardedVideoAdStarted()
557		ServeAdResponseSignal(uuid: string, response: string, isError: bool)
557		ServeAdSignal(uuid: string, request: string)
617		ShowDynamicEudsaDisclosure(advertiserName: string, payerName: string)
655		ShowReportAdPopup(adInfo: Dictionary)
462		VideoAdClosed(adShown: bool)
627		adGuiRegisterUI(adGui: Instance)
675		rewardedVideoAdPlayServerToClient(rewardDetails: string)
676		rewardedVideoAdPlayServerToClientWithPlacement(rewardDetails: string, placementId: int64)
655		rewardedVideoAdResultClientToServer(result: ShowAdResult, encryptedAdTrackingData: string, encryptionMetadata: string)
712		OnImmersiveBrandedAdDisclosureButtonActivated(data: Dictionary): null
657		onDemandVideoPlayInUI(data: Dictionary): VideoFrame
67 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
670		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
702		PredictionMode: PredictionMode
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
670		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
680		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Removed member index 4

History		Member
657		GetAdAvailability(adFormat: AdFormat): Variant
657		AdAvailabilityChanged(adFormat: AdFormat, adAvailabilityResult: Variant)
688		PortalPrompt(destinationId: int64, portal: Instance, requiresNoButton: bool)
655		ShowStaticEudsaDisclosure()

Description

A service for displaying mobile video ads as a form of monetization. Use it to implement rewarded video ads in your experience.

History 70
Hide member changes

712 Add OnImmersiveBrandedAdDisclosureButtonActivated
712 Add GetCampaignEligibilitySignalFromServer
712 Add CampaignEligibilityResponseSuccessSignalFromClient
712 Add CampaignEligibilityResponseFailureSignalFromClient
712 Add RegisterDisclosureButton
712 Add GetCampaignEligibilityAsync
712 Change ReturnType of GetAdAvailabilityNowForUniverseAsync from Variant to Dictionary
712 Change ReturnType of GetAdAvailabilityNowAsync from Variant to Dictionary
692 Add SubmitAdNotification
692 Add ShowRewardedVideoAdAtClientAsync
691 Add GetAdAvailabilityNowForUniverseAsync
688 Remove PortalPrompt
681 Add UnregisterAdOpportunity
681 Add RegisterAdOpportunityAsync
676 Add rewardedVideoAdPlayServerToClientWithPlacement
675 Change Parameters of rewardedVideoAdPlayServerToClient from (rewardDetails: string, placementId: int64) to (rewardDetails: string)
675 Change Parameters of rewardedVideoAdPlayServerToClient from (rewardDetails: string) to (rewardDetails: string, placementId: int64)
675 Change Parameters of ShowRewardedVideoAdAsync from (player: Player, reward: AdReward) to (player: Player, reward: AdReward, placementId: int64?)
674 Add RewardedVideoAdStarted
674 Add RewardedVideoAdEnded
657 Add onDemandVideoPlayInUI
657 Remove AdAvailabilityChanged
657 Add OnDemandVideoCompleteFromUI
657 Add HandleWhyThisAdClicked
657 Add GetAdAvailabilityNowAsync
657 Remove GetAdAvailability
655 Add rewardedVideoAdResultClientToServer
655 Add rewardedVideoAdPlayServerToClient
655 Remove ShowStaticEudsaDisclosure
655 Add ShowReportAdPopup
655 Add AdAvailabilityChanged
655 Add ShowRewardedVideoAdAsync
655 Add GetAdAvailability
655 Add CreateAdRewardFromDevProductId
627 Add adGuiRegisterUI
627 Add SetAdGuiInteractivityHandlerInitialized
617 Add ShowDynamicEudsaDisclosure
612 Add ShowStaticEudsaDisclosure
612 Add HideEudsaDisclosure
587 Change Parameters of PortalPrompt from (destinationId: int64, player: Player, portal: Instance) to (destinationId: int64, portal: Instance, requiresNoButton: bool)
583 Add PortalPrompt
580 Add GetReportAdInfo
573 Change ReturnType of ShowVideoAd from void to null
573 Change ReturnType of ReturnToPublisherExperience from void to null
565 Add ReturnToPublisherExperience
565 Add GetAdTeleportInfo
557 Change Parameters of ServeAdSignal from (request: string) to (uuid: string, request: string)
557 Change Parameters of ServeAdResponseSignal from (response: string, isError: bool) to (uuid: string, response: string, isError: bool)
554 Change Parameters of ServeAdSignal from (uuid: string, request: string) to (request: string)
554 Change Parameters of ServeAdResponseSignal from (uuid: string, response: string, isError: bool) to (response: string, isError: bool)
555 Change Parameters of ServeAdSignal from (request: string) to (uuid: string, request: string)
555 Change Parameters of ServeAdResponseSignal from (response: string, isError: bool) to (uuid: string, response: string, isError: bool)
553 Add ServeAdSignal
553 Add ServeAdResponseSignal
553 Add ReportTeleportSignal
553 Add ReportImpressionSignal
547 Add AdTeleportInitiated
547 Add AdTeleportEnded
462 Change ThreadSafety of VideoAdClosed from to Unsafe
462 Change ThreadSafety of ShowVideoAd from to Unsafe
323 Add VideoAdClosed
323 Add ShowVideoAd
322 Remove VideoAdClosed
322 Remove ShowVideoAd
292 Change Tags of VideoAdClosed from [] to [Deprecated]
292 Change Tags of ShowVideoAd from [] to [Deprecated]
212 Change Parameters of VideoAdClosed from () to (adShown: bool)
151 Add VideoAdClosed
151 Add ShowVideoAd
151 Add AdService

Members 38

AdTeleportEnded
CreatorHub

Parameters (0)
No parameters.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

547 Add AdTeleportEnded

AdTeleportInitiated
CreatorHub

Parameters (0)
No parameters.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

547 Add AdTeleportInitiated

CampaignEligibilityResponseFailureSignalFromClient
CreatorHub

Parameters (2)
campaignId	string
error	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

712 Add CampaignEligibilityResponseFailureSignalFromClient

Tags: [Hidden]

CampaignEligibilityResponseSuccessSignalFromClient
CreatorHub

Parameters (2)
campaignId	string
response	Dictionary

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

712 Add CampaignEligibilityResponseSuccessSignalFromClient

Tags: [Hidden]

CreateAdRewardFromDevProductId
CreatorHub

Parameters (1)
devProductId	int64
Returns (1)
AdReward

Creates a reward to give users who watch an entire video ad.

Thread safety	Unsafe

History 1

655 Add CreateAdRewardFromDevProductId

GetAdAvailabilityNowAsync
CreatorHub

Parameters (1)
adFormat	AdFormat
Returns (1)
Dictionary

Checks if a video ad is available to be played to the current user inside the experience.

It will block the calling thread until completion.

Thread safety	Unsafe

History 2

712 Change ReturnType of GetAdAvailabilityNowAsync from Variant to Dictionary
657 Add GetAdAvailabilityNowAsync

Tags: [Yields]

GetAdAvailabilityNowForUniverseAsync
CreatorHub

Parameters (3)
adFormat	AdFormat
universeId	int64
isUniversalAppDM	bool
Returns (1)
Dictionary

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

712 Change ReturnType of GetAdAvailabilityNowForUniverseAsync from Variant to Dictionary
691 Add GetAdAvailabilityNowForUniverseAsync

Tags: [Yields]

GetAdTeleportInfo
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

565 Add GetAdTeleportInfo

GetCampaignEligibilityAsync
CreatorHub

Parameters (2)		Default
campaignId	string
player	Player	Player
Returns (1)
Dictionary

It will block the calling thread until completion.

Thread safety	Unsafe

History 1

712 Add GetCampaignEligibilityAsync

Tags: [Yields]

GetCampaignEligibilitySignalFromServer
CreatorHub

Parameters (1)
campaignId	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

712 Add GetCampaignEligibilitySignalFromServer

Tags: [Hidden]

GetReportAdInfo
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

580 Add GetReportAdInfo

HandleWhyThisAdClicked
CreatorHub

Parameters (2)
advertiserName	string
payerName	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

657 Add HandleWhyThisAdClicked

HideEudsaDisclosure
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

612 Add HideEudsaDisclosure

OnDemandVideoCompleteFromUI
CreatorHub

Parameters (4)
result	ShowAdResult
encryptedAdTrackingData	string
encryptionMetadata	string
rewardDetails	string
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

657 Add OnDemandVideoCompleteFromUI

OnImmersiveBrandedAdDisclosureButtonActivated
CreatorHub

Parameters (1)
data	Dictionary
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

712 Add OnImmersiveBrandedAdDisclosureButtonActivated

Tags: [NoYield]

RegisterAdOpportunityAsync
CreatorHub

Parameters (2)
instance	Instance
placementId	int64?
Returns (1)
null

It will block the calling thread until completion.

Thread safety	Unsafe

History 1

681 Add RegisterAdOpportunityAsync

Tags: [Yields]

RegisterDisclosureButton
CreatorHub

Parameters (2)
disclosureButton	GuiButton
immersiveBrandedAdId	string
Returns (1)
null

Thread safety	Unsafe

History 1

712 Add RegisterDisclosureButton

ReportImpressionSignal
CreatorHub

Parameters (3)
ad_instance_name	string
encrypted_ad_tracking_data	string
encryption_metadata	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add ReportImpressionSignal

Tags: [Hidden]

ReportTeleportSignal
CreatorHub

Parameters (7)
ad_instance_name	string
encrypted_ad_tracking_data	string
encryption_metadata	string
teleport_type	string
teleport_source_universe_id	int64
teleport_source_place_id	int64
teleport_dest_place_id	int64

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

553 Add ReportTeleportSignal

Tags: [Hidden]

ReturnToPublisherExperience
CreatorHub

Parameters (1)
adTeleportMethod	AdTeleportMethod
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

573 Change ReturnType of ReturnToPublisherExperience from void to null
565 Add ReturnToPublisherExperience

RewardedVideoAdEnded
CreatorHub

Parameters (0)
No parameters.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

674 Add RewardedVideoAdEnded

RewardedVideoAdStarted
CreatorHub

Parameters (0)
No parameters.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

674 Add RewardedVideoAdStarted

ServeAdResponseSignal
CreatorHub

Parameters (3)
uuid	string
response	string
isError	bool

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 4

557 Change Parameters of ServeAdResponseSignal from (response: string, isError: bool) to (uuid: string, response: string, isError: bool)
554 Change Parameters of ServeAdResponseSignal from (uuid: string, response: string, isError: bool) to (response: string, isError: bool)
555 Change Parameters of ServeAdResponseSignal from (response: string, isError: bool) to (uuid: string, response: string, isError: bool)
553 Add ServeAdResponseSignal

Tags: [Hidden]

ServeAdSignal
CreatorHub

Parameters (2)
uuid	string
request	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 4

557 Change Parameters of ServeAdSignal from (request: string) to (uuid: string, request: string)
554 Change Parameters of ServeAdSignal from (uuid: string, request: string) to (request: string)
555 Change Parameters of ServeAdSignal from (request: string) to (uuid: string, request: string)
553 Add ServeAdSignal

Tags: [Hidden]

SetAdGuiInteractivityHandlerInitialized
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

627 Add SetAdGuiInteractivityHandlerInitialized

ShowDynamicEudsaDisclosure
CreatorHub

Parameters (2)
advertiserName	string
payerName	string

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

617 Add ShowDynamicEudsaDisclosure

ShowReportAdPopup
CreatorHub

Parameters (1)
adInfo	Dictionary

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

655 Add ShowReportAdPopup

ShowRewardedVideoAdAsync
CreatorHub

Parameters (3)
player	Player
reward	AdReward
placementId	int64?
Returns (1)
ShowAdResult

Plays the video ad to the current user inside the experience.

It will block the calling thread until completion.

Thread safety	Unsafe

History 2

675 Change Parameters of ShowRewardedVideoAdAsync from (player: Player, reward: AdReward) to (player: Player, reward: AdReward, placementId: int64?)
655 Add ShowRewardedVideoAdAsync

Tags: [Yields]

ShowRewardedVideoAdAtClientAsync
CreatorHub

Parameters (1)
universeId	int64
Returns (1)
ShowAdResult

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

692 Add ShowRewardedVideoAdAtClientAsync

Tags: [Yields]

ShowVideoAd
CreatorHub

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

Show mobile video advertisements.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 6

573 Change ReturnType of ShowVideoAd from void to null
462 Change ThreadSafety of ShowVideoAd from to Unsafe
323 Add ShowVideoAd
322 Remove ShowVideoAd
292 Change Tags of ShowVideoAd from [] to [Deprecated]
151 Add ShowVideoAd

Tags: [Deprecated]

SubmitAdNotification
CreatorHub

Parameters (5)
universeId	int64
isShowAdSuccessful	bool
earnedReward	bool
rewardProductName	string
rewardProductImageAssetId	int64
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

692 Add SubmitAdNotification

UnregisterAdOpportunity
CreatorHub

Parameters (1)
instance	Instance
Returns (1)
null

Thread safety	Unsafe

History 1

681 Add UnregisterAdOpportunity

VideoAdClosed
CreatorHub

Parameters (1)
adShown	bool

Fires when an AdService video closes.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 6

462 Change ThreadSafety of VideoAdClosed from to Unsafe
323 Add VideoAdClosed
322 Remove VideoAdClosed
292 Change Tags of VideoAdClosed from [] to [Deprecated]
212 Change Parameters of VideoAdClosed from () to (adShown: bool)
151 Add VideoAdClosed

Tags: [Deprecated]

adGuiRegisterUI
CreatorHub

Parameters (1)
adGui	Instance

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

627 Add adGuiRegisterUI

onDemandVideoPlayInUI
CreatorHub

Parameters (1)
data	Dictionary
Returns (1)
VideoFrame

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

657 Add onDemandVideoPlayInUI

rewardedVideoAdPlayServerToClient
CreatorHub

Parameters (1)
rewardDetails	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 3

675 Change Parameters of rewardedVideoAdPlayServerToClient from (rewardDetails: string, placementId: int64) to (rewardDetails: string)
675 Change Parameters of rewardedVideoAdPlayServerToClient from (rewardDetails: string) to (rewardDetails: string, placementId: int64)
655 Add rewardedVideoAdPlayServerToClient

Tags: [Hidden]

rewardedVideoAdPlayServerToClientWithPlacement
CreatorHub

Parameters (2)
rewardDetails	string
placementId	int64

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

676 Add rewardedVideoAdPlayServerToClientWithPlacement

Tags: [Hidden]

rewardedVideoAdResultClientToServer
CreatorHub

Parameters (3)
result	ShowAdResult
encryptedAdTrackingData	string
encryptionMetadata	string

It is not meant to be used, and may have unresolved issues.

Security	RobloxSecurity
Thread safety	Unsafe

History 1

655 Add rewardedVideoAdResultClientToServer

Tags: [Hidden]

Removed members 4

AdAvailabilityChanged
CreatorHub

Parameters (2)
adFormat	AdFormat
adAvailabilityResult	Variant

Thread safety	Unsafe

History 2

657 Remove AdAvailabilityChanged
655 Add AdAvailabilityChanged

GetAdAvailability
CreatorHub

Parameters (1)
adFormat	AdFormat
Returns (1)
Variant

Thread safety	Unsafe

History 2

657 Remove GetAdAvailability
655 Add GetAdAvailability

PortalPrompt
CreatorHub

Parameters (3)
destinationId	int64
portal	Instance
requiresNoButton	bool

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

688 Remove PortalPrompt
587 Change Parameters of PortalPrompt from (destinationId: int64, player: Player, portal: Instance) to (destinationId: int64, portal: Instance, requiresNoButton: bool)
583 Add PortalPrompt

ShowStaticEudsaDisclosure
CreatorHub

Parameters (0)
No parameters.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

655 Remove ShowStaticEudsaDisclosure
612 Add ShowStaticEudsaDisclosure

Engine API

Website

Related

History 1

History 1

History 1

History 1

History 1

History 2

History 2

History 1

History 1

History 1

History 1

History 1

History 1

History 1

History 1

History 1

History 1

History 1

History 1

History 2

History 1

History 1

History 4

History 4

History 1

History 1

History 1

History 2

History 1

History 6

History 1

History 1

History 6

History 1

History 1

History 3

History 1

History 1

History 2

History 2

History 3

History 2