The service responsible for in-experience advertising.
Instances of this class cannot be created with Instance.new.
It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]
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 719 GetUniversalAppAdsEligibility ( ) : Dictionary 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 716 RegisterDisclosureButton ( disclosureButton: GuiButton , adIntegrationPlacementId: 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 ( ) 674 RewardedVideoAdEnded ( ) 674 RewardedVideoAdStarted ( ) 617 ShowDynamicEudsaDisclosure ( advertiserName: string , payerName: string ) 655 ShowReportAdPopup ( adInfo: Dictionary ) 462 VideoAdClosed ( adShown: bool ) 627 adGuiRegisterUI ( adGui: Instance ) 712 OnImmersiveBrandedAdDisclosureButtonActivated ( data: Dictionary ) : null 657 onDemandVideoPlayInUI ( data: Dictionary ) : VideoFrame 60 members inherited from Instance726 Archivable : bool 726 Capabilities : SecurityCapabilities 726 DataCost : int 726 IsInSandbox : bool 726 Name : string 726 Parent : Instance 726 PredictionMode : PredictionMode 726 RobloxLocked : bool 726 Sandboxed : bool 726 SourceAssetId : int64 726 UniqueId : UniqueId 726 archivable : bool 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 726 children ( ) : Instances 726 clone ( ) : Instance 726 destroy ( ) : null 726 findFirstChild ( name: string , recursive: bool = false ) : Instance 726 getChildren ( ) : Instances 726 isDescendantOf ( ancestor: Instance ) : bool 726 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 ( ) 726 childAdded ( child: Instance ) 6 members inherited from Object726 ClassName : string 726 className : string 647 GetPropertyChangedSignal ( property: string ) : RBXScriptSignal 647 IsA ( className: string ) : bool 726 isA ( className: string ) : bool 647 Changed ( property: string )
History Member 657 GetAdAvailability ( adFormat: AdFormat ) : Variant 657 AdAvailabilityChanged ( adFormat: AdFormat , adAvailabilityResult: Variant ) 726 CampaignEligibilityResponseFailureSignalFromClient ( campaignId: string , error: string ) 726 CampaignEligibilityResponseSuccessSignalFromClient ( campaignId: string , response: Dictionary ) 726 GetCampaignEligibilitySignalFromServer ( campaignId: string ) 688 PortalPrompt ( destinationId: int64 , portal: Instance , requiresNoButton: bool ) 726 ReportImpressionSignal ( ad_instance_name: string , encrypted_ad_tracking_data: string , encryption_metadata: string ) 726 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 ) 726 ServeAdResponseSignal ( uuid: string , response: string , isError: bool ) 726 ServeAdSignal ( uuid: string , request: string ) 655 ShowStaticEudsaDisclosure ( ) 726 rewardedVideoAdPlayServerToClient ( rewardDetails: string ) 726 rewardedVideoAdPlayServerToClientWithPlacement ( rewardDetails: string , placementId: int64 ) 726 rewardedVideoAdResultClientToServer ( result: ShowAdResult , encryptedAdTrackingData: string , encryptionMetadata: string )
726
Remove rewardedVideoAdResultClientToServer726
Remove rewardedVideoAdPlayServerToClientWithPlacement726
Remove rewardedVideoAdPlayServerToClient726
Remove ServeAdSignal726
Remove ServeAdResponseSignal726
Remove ReportTeleportSignal726
Remove ReportImpressionSignal726
Remove GetCampaignEligibilitySignalFromServer726
Remove CampaignEligibilityResponseSuccessSignalFromClient726
Remove CampaignEligibilityResponseFailureSignalFromClient719
Add GetUniversalAppAdsEligibility716
Change Parameters of RegisterDisclosureButton
from
( disclosureButton: GuiButton , immersiveBrandedAdId: string )
to
( disclosureButton: GuiButton , adIntegrationPlacementId: string ) 712
Add OnImmersiveBrandedAdDisclosureButtonActivated712
Add GetCampaignEligibilitySignalFromServer712
Add CampaignEligibilityResponseSuccessSignalFromClient712
Add CampaignEligibilityResponseFailureSignalFromClient712
Add RegisterDisclosureButton712
Add GetCampaignEligibilityAsync712
Change ReturnType of GetAdAvailabilityNowForUniverseAsync
from
Variant
to
Dictionary 712
Change ReturnType of GetAdAvailabilityNowAsync
from
Variant
to
Dictionary 692
Add SubmitAdNotification692
Add ShowRewardedVideoAdAtClientAsync691
Add GetAdAvailabilityNowForUniverseAsync688
Remove PortalPrompt681
Add UnregisterAdOpportunity681
Add RegisterAdOpportunityAsync676
Add rewardedVideoAdPlayServerToClientWithPlacement675
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 RewardedVideoAdStarted674
Add RewardedVideoAdEnded657
Add onDemandVideoPlayInUI657
Remove AdAvailabilityChanged657
Add OnDemandVideoCompleteFromUI657
Add HandleWhyThisAdClicked657
Add GetAdAvailabilityNowAsync657
Remove GetAdAvailability655
Add rewardedVideoAdResultClientToServer655
Add rewardedVideoAdPlayServerToClient655
Remove ShowStaticEudsaDisclosure655
Add ShowReportAdPopup655
Add AdAvailabilityChanged655
Add ShowRewardedVideoAdAsync655
Add GetAdAvailability655
Add CreateAdRewardFromDevProductId627
Add adGuiRegisterUI627
Add SetAdGuiInteractivityHandlerInitialized617
Add ShowDynamicEudsaDisclosure612
Add ShowStaticEudsaDisclosure612
Add HideEudsaDisclosure587
Change Parameters of PortalPrompt
from
( destinationId: int64 , player: Player , portal: Instance )
to
( destinationId: int64 , portal: Instance , requiresNoButton: bool ) 583
Add PortalPrompt580
Add GetReportAdInfo573
Change ReturnType of ShowVideoAd
from
void
to
null 573
Change ReturnType of ReturnToPublisherExperience
from
void
to
null 565
Add ReturnToPublisherExperience565
Add GetAdTeleportInfo557
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 ServeAdSignal553
Add ServeAdResponseSignal553
Add ReportTeleportSignal553
Add ReportImpressionSignal547
Add AdTeleportInitiated547
Add AdTeleportEnded462
Change ThreadSafety of VideoAdClosed
from
to
Unsafe 462
Change ThreadSafety of ShowVideoAd
from
to
Unsafe 323
Add VideoAdClosed323
Add ShowVideoAd322
Remove VideoAdClosed322
Remove ShowVideoAd292
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 VideoAdClosed151
Add ShowVideoAd151
Add AdServiceParameters (0 ) No parameters.
History 1 Parameters (0 ) No parameters.
History 1 CreateAdRewardFromDevProductIdCreates a reward to give users who watch an entire video ad.
History 1 GetAdAvailabilityNowAsync It will block the calling thread until completion.
History 2 Tags: [Yields]
GetAdAvailabilityNowForUniverseAsync
It will block the calling thread until completion.
History 2 Tags: [Yields]
Parameters (0 ) No parameters. Returns (1 ) Tuple
History 1 GetCampaignEligibilityAsync
It will block the calling thread until completion.
History 1 Tags: [Yields]
Parameters (0 ) No parameters. Returns (1 ) Array
History 1 GetUniversalAppAdsEligibility
History 1 Parameters (0 ) No parameters. Returns (1 ) null
History 1 OnDemandVideoCompleteFromUI
History 1 RegisterAdOpportunityAsync It will block the calling thread until completion.
History 1 Tags: [Yields]
ReturnToPublisherExperience
History 2 Parameters (0 ) No parameters.
History 1 Parameters (0 ) No parameters.
History 1 SetAdGuiInteractivityHandlerInitializedParameters (0 ) No parameters. Returns (1 ) null
History 1 ShowDynamicEudsaDisclosure
History 1 It will block the calling thread until completion.
History 2 Tags: [Yields]
ShowRewardedVideoAdAtClientAsync
It will block the calling thread until completion.
History 1 Tags: [Yields]
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.
History 6 Tags: [Deprecated]
Parameters (1 ) adShown bool
It exists only for backward compatibility, and should not be used for new work.
History 6 Tags: [Deprecated]
CampaignEligibilityResponseFailureSignalFromClient
It is not meant to be used, and may have unresolved issues.
History 2 Tags: [Hidden]
CampaignEligibilityResponseSuccessSignalFromClient
It is not meant to be used, and may have unresolved issues.
History 2 Tags: [Hidden]
GetCampaignEligibilitySignalFromServerParameters (1 ) campaignId string
It is not meant to be used, and may have unresolved issues.
History 2 Tags: [Hidden]
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.
History 2 Tags: [Hidden]
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.
History 2 Tags: [Hidden]
It is not meant to be used, and may have unresolved issues.
History 5 Tags: [Hidden]
It is not meant to be used, and may have unresolved issues.
History 5 Tags: [Hidden]
ShowStaticEudsaDisclosureParameters (0 ) No parameters.
History 2 rewardedVideoAdPlayServerToClientParameters (1 ) rewardDetails string
It is not meant to be used, and may have unresolved issues.
History 4 Tags: [Hidden]
rewardedVideoAdPlayServerToClientWithPlacement
It is not meant to be used, and may have unresolved issues.
History 2 Tags: [Hidden]
rewardedVideoAdResultClientToServer
It is not meant to be used, and may have unresolved issues.
History 2 Tags: [Hidden]