AdService
The service responsible for in-experience advertising.
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.
| Memory category | Instances |
|---|
Member index 39
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
AdService is responsible for in-experience advertising. This includes rewarded video and ad integrations.
History 72
- 719 Add GetUniversalAppAdsEligibility
- 716 Change Parameters of RegisterDisclosureButton from (disclosureButton: GuiButton, immersiveBrandedAdId: string) to (disclosureButton: GuiButton, adIntegrationPlacementId: string)
- 712 Add OnImmersiveBrandedAdDisclosureButtonActivated
- 712 Add
- 712 Add
- 712 Add
- 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
- 675 Change Parameters of from (rewardDetails: string, placementId: int64) to (rewardDetails: string)
- 675 Change Parameters of 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
- 655 Add
- 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 from (request: string) to (uuid: string, request: string)
- 557 Change Parameters of from (response: string, isError: bool) to (uuid: string, response: string, isError: bool)
- 554 Change Parameters of from (uuid: string, request: string) to (request: string)
- 554 Change Parameters of from (uuid: string, response: string, isError: bool) to (response: string, isError: bool)
- 555 Change Parameters of from (request: string) to (uuid: string, request: string)
- 555 Change Parameters of from (response: string, isError: bool) to (uuid: string, response: string, isError: bool)
- 553 Add
- 553 Add
- 553 Add
- 553 Add
- 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 39
AdTeleportEnded
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 547 Add AdTeleportEnded
AdTeleportInitiated
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
CreateAdRewardFromDevProductId
| Parameters (1) | ||
|---|---|---|
| devProductId | int64 | |
| Returns (1) | ||
| AdReward | ||
Creates a reward to give users who watch an entire video ad.
| Thread safety | Unsafe |
|---|
History 1
GetAdAvailabilityNowAsync
| Parameters (1) | ||
|---|---|---|
| adFormat | AdFormat | |
| Returns (1) | ||
| Dictionary | ||
This method may only be called from a Script with RunContext.Client.
This function yields. 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
GetAdAvailabilityNowForUniverseAsync
| Parameters (3) | ||
|---|---|---|
| adFormat | AdFormat | |
| universeId | int64 | |
| isUniversalAppDM | bool | |
| Returns (1) | ||
| Dictionary | ||
This function yields. 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
GetAdTeleportInfo
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 565 Add GetAdTeleportInfo
GetCampaignEligibilityAsync
| Parameters (2) | Default | |
|---|---|---|
| campaignId | string | |
| player | Player | Player |
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
GetReportAdInfo
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 580 Add GetReportAdInfo
GetUniversalAppAdsEligibility
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Dictionary | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
HandleWhyThisAdClicked
| Parameters (2) | ||
|---|---|---|
| advertiserName | string | |
| payerName | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
HideEudsaDisclosure
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
OnDemandVideoCompleteFromUI
| Parameters (4) | ||
|---|---|---|
| result | ShowAdResult | |
| encryptedAdTrackingData | string | |
| encryptionMetadata | string | |
| rewardDetails | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
OnImmersiveBrandedAdDisclosureButtonActivated
| Parameters (1) | ||
|---|---|---|
| data | Dictionary | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
RegisterAdOpportunityAsync
| Parameters (2) | ||
|---|---|---|
| instance | Instance | |
| placementId | int64? | |
| Returns (1) | ||
| null | ||
This method may only be called from a Script with RunContext.Client.
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
RegisterDisclosureButton
| Parameters (2) | ||
|---|---|---|
| disclosureButton | GuiButton | |
| adIntegrationPlacementId | string | |
| Returns (1) | ||
| null | ||
This method may only be called from a Script with RunContext.Client.
RegisterDisclosureButton marks a button in your experience as an ad disclosure for an ad integration. When a user clicks it, they can see who is paying for the ad. See ad integrations for guidance on what the disclosures should look like and when they should be visible.
Note: you must verify that the LocalPlayer is
eligible to see the associated ad integration campaign by calling
GetCampaignEligibilityAsync
and verifying that result.IsEligible is true before attempting to
register a disclosure button for it. If you do not wait, or the
LocalPlayer is not eligible to see the
associated campaign, then
RegisterDisclosureButton will
raise an error.
| Thread safety | Unsafe |
|---|
History 2
- 716 Change Parameters of RegisterDisclosureButton from (disclosureButton: GuiButton, immersiveBrandedAdId: string) to (disclosureButton: GuiButton, adIntegrationPlacementId: string)
- 712 Add RegisterDisclosureButton
ReturnToPublisherExperience
| 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
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
RewardedVideoAdStarted
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
SetAdGuiInteractivityHandlerInitialized
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
ShowDynamicEudsaDisclosure
| Parameters (2) | |
|---|---|
| advertiserName | string |
| payerName | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
ShowReportAdPopup
| Parameters (1) | |
|---|---|
| adInfo | Dictionary |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 655 Add ShowReportAdPopup
ShowRewardedVideoAdAsync
| Parameters (3) | ||
|---|---|---|
| player | Player | |
| reward | AdReward | |
| placementId | int64? | |
| Returns (1) | ||
| ShowAdResult | ||
This method may only be called from a Script with RunContext.Server.
Note: before calling this method, you must first verify that the specified user has a rewarded video ad available to show by calling GetAdAvailabilityNowAsync. If the client does not have an available ad, then ShowRewardedVideoAdAsync will return ShowAdResult.AdNotReady.
This function yields. 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
ShowRewardedVideoAdAtClientAsync
| Parameters (1) | ||
|---|---|---|
| universeId | int64 | |
| Returns (1) | ||
| ShowAdResult | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
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.
| 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
SubmitAdNotification
| Parameters (5) | ||
|---|---|---|
| universeId | int64 | |
| isShowAdSuccessful | bool | |
| earnedReward | bool | |
| rewardProductName | string | |
| rewardProductImageAssetId | int64 | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
UnregisterAdOpportunity
| Parameters (1) | ||
|---|---|---|
| instance | Instance | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 1
VideoAdClosed
| Parameters (1) | |
|---|---|
| adShown | bool |
Fires when an AdService video closes.
This event is deprecated. 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
adGuiRegisterUI
| Parameters (1) | |
|---|---|
| adGui | Instance |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 627 Add adGuiRegisterUI
onDemandVideoPlayInUI
| Parameters (1) | ||
|---|---|---|
| data | Dictionary | |
| Returns (1) | ||
| VideoFrame | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
Removed members 4
AdAvailabilityChanged
| Parameters (2) | |
|---|---|
| adFormat | AdFormat |
| adAvailabilityResult | Variant |
| Thread safety | Unsafe |
|---|
History 2
- 657 Remove AdAvailabilityChanged
- 655 Add AdAvailabilityChanged
GetAdAvailability
| Parameters (1) | ||
|---|---|---|
| adFormat | AdFormat | |
| Returns (1) | ||
| Variant | ||
| Thread safety | Unsafe |
|---|
History 2
- 657 Remove GetAdAvailability
- 655 Add GetAdAvailability
PortalPrompt
| 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
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |