AdService¶
Supported Class NotCreatable Service
The service responsible for in-experience advertising.
2 Nova members · 29 modern Roblox members not implemented yet
Description¶
AdService is responsible for in-experience advertising. This includes rewarded video and ad integrations.
Inheritance¶
Nova inheritance: Instance → AdService
Methods¶
ShowVideoAd Supported Function Deprecated Show mobile video advertisements.
Show mobile video advertisements.
Events¶
VideoAdClosed Supported Event Deprecated Fires when an AdService video closes.
Fires when an AdService video closes.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
29 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's AdService class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
CreateAdRewardFromDevProductId |
AdService:CreateAdRewardFromDevProductId(devProductId: int64): AdReward |
Not yet | Creates an AdReward to give users who watch a video ad. | — |
GetAdAvailabilityNowAsync |
AdService:GetAdAvailabilityNowAsync(adFormat: AdFormat): Dictionary |
Not yet | Checks if an ad with the specified format is available to be shown to the LocalPlayer. | Yields |
GetAdAvailabilityNowForUniverseAsync |
AdService:GetAdAvailabilityNowForUniverseAsync(adFormat: AdFormat, universeId: int64, isUniversalAppDM: bool): Dictionary |
Not yet | — | Yields, RobloxScriptSecurity |
GetAdTeleportInfo |
AdService:GetAdTeleportInfo(): Tuple |
Not yet | — | RobloxScriptSecurity |
GetCampaignEligibilityAsync |
AdService:GetCampaignEligibilityAsync(campaignId: string, player: Player = nil): Dictionary |
Not yet | Checks a Player's eligibility to be shown an ad integration campaign. | Yields |
GetReportAdInfo |
AdService:GetReportAdInfo(): Array |
Not yet | — | RobloxScriptSecurity |
GetUniversalAppAdsEligibility |
AdService:GetUniversalAppAdsEligibility(): Dictionary |
Not yet | — | RobloxScriptSecurity |
HandleWhyThisAdClicked |
AdService:HandleWhyThisAdClicked(advertiserName: string, payerName: string): null |
Not yet | — | RobloxScriptSecurity |
HideEudsaDisclosure |
AdService:HideEudsaDisclosure(): null |
Not yet | — | RobloxScriptSecurity |
IsAdLoaded |
AdService:IsAdLoaded(adFormat: AdFormat): bool |
Not yet | — | RobloxScriptSecurity |
OnDemandVideoCompleteFromUI |
AdService:OnDemandVideoCompleteFromUI(result: ShowAdResult, encryptedAdTrackingData: string, encryptionMetadata: string, rewardDetails: string): null |
Not yet | — | RobloxScriptSecurity |
RegisterAdOpportunityAsync |
AdService:RegisterAdOpportunityAsync(instance: Instance, placementId: int64?): null |
Not yet | Tracks how many times a user had the chance to watch a video ad and the rate at which they actually watched the ad. | Yields |
RegisterDisclosureButton |
AdService:RegisterDisclosureButton(disclosureButton: GuiButton, adIntegrationPlacementId: string): null |
Not yet | Registers an ad disclosure button for an ad integration. | — |
RegisterImpressionSource |
AdService:RegisterImpressionSource(instance: Instance, adIntegrationPlacementId: string): null |
Not yet | — | — |
ReturnToPublisherExperience |
AdService:ReturnToPublisherExperience(adTeleportMethod: AdTeleportMethod): null |
Not yet | — | RobloxScriptSecurity |
SetAdGuiInteractivityHandlerInitialized |
AdService:SetAdGuiInteractivityHandlerInitialized(): null |
Not yet | — | RobloxScriptSecurity |
ShowRewardedVideoAdAsync |
AdService:ShowRewardedVideoAdAsync(player: Player, reward: AdReward, placementId: int64?): ShowAdResult |
Not yet | Plays the video ad to the current user inside the experience. | Yields |
ShowRewardedVideoAdAtClientAsync |
AdService:ShowRewardedVideoAdAtClientAsync(universeId: int64): ShowAdResult |
Not yet | — | Yields, RobloxScriptSecurity |
SubmitAdNotification |
AdService:SubmitAdNotification(universeId: int64, isShowAdSuccessful: bool, earnedReward: bool, rewardProductName: string, rewardProductImageAssetId: int64): null |
Not yet | — | RobloxScriptSecurity |
UnregisterAdOpportunity |
AdService:UnregisterAdOpportunity(instance: Instance): null |
Not yet | Stops tracking an instance that was previously registered with RegisterAdOpportunityAsync. | — |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
adGuiRegisterUI |
adGuiRegisterUI(adGui: Instance) |
Not yet | — | RobloxScriptSecurity |
AdTeleportEnded |
AdTeleportEnded() |
Not yet | — | RobloxScriptSecurity |
AdTeleportInitiated |
AdTeleportInitiated() |
Not yet | — | RobloxScriptSecurity |
RewardedVideoAdEnded |
RewardedVideoAdEnded() |
Not yet | — | RobloxScriptSecurity |
RewardedVideoAdStarted |
RewardedVideoAdStarted() |
Not yet | — | RobloxScriptSecurity |
ShowDynamicEudsaDisclosure |
ShowDynamicEudsaDisclosure(advertiserName: string, payerName: string) |
Not yet | — | RobloxScriptSecurity |
ShowReportAdPopup |
ShowReportAdPopup(adInfo: Dictionary) |
Not yet | — | RobloxScriptSecurity |
Callbacks¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
onDemandVideoPlayInUI |
onDemandVideoPlayInUI(data: Dictionary) -> VideoFrame |
Not yet | — | RobloxScriptSecurity |
OnImmersiveBrandedAdDisclosureButtonActivated |
OnImmersiveBrandedAdDisclosureButtonActivated(data: Dictionary) -> null |
Not yet | — | NoYield, RobloxScriptSecurity |
Roblox reference: AdService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.