Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
AdService
Inherits from: Instance → Object
AdService is responsible for in-experience advertising. This includes rewarded video and ad integrations.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, Service
Methods
| Name | Type / Returns | Description |
|---|---|---|
| AdService:CreateAdRewardFromDevProductId | AdReward | Creates an AdReward to give users who watch a video ad. |
| AdService:GetAdAvailabilityNowAsync | GetAdAvailabilityNowResult | Checks if an ad with the specified format is available to be shown to the LocalPlayer. |
| AdService:GetCampaignEligibilityAsync | GetCampaignEligibilityResult | Checks a Player's eligibility to be shown an ad integration campaign. |
| AdService:RegisterAdOpportunityAsync | () | Tracks how many times a user had the chance to watch a video ad and the rate at which they actually watched the ad. |
| AdService:RegisterDisclosureButton | () | Registers an ad disclosure button for an ad integration. |
| AdService:ShowRewardedVideoAdAsync | ShowAdResult | Plays the video ad to the current user inside the experience. |
| AdService:ShowVideoAd | () | Show mobile video advertisements. |
| AdService:UnregisterAdOpportunity | () | Stops tracking an instance that was previously registered with RegisterAdOpportunityAsync. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
AdService:CreateAdRewardFromDevProductId
Constructs an AdReward that wraps the given developer product so it can be passed to ShowRewardedVideoAdAsync. When the user watches the entire rewarded video ad, the developer product identified by devProductId is granted through the ProcessReceipt callback with a ProductPurchaseChannel of ProductPurchaseChannel.AdReward.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| devProductId | int64 | The ID of the developer product you want to grant as a reward. |
Returns
| Type | Description |
|---|---|
| AdReward | An AdReward configured as a developer product reward for the specified product. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Monetization"] |
AdService:GetAdAvailabilityNowAsync
This method may only be called from a Script with RunContext.Client.
Note that you should call this method as close as possible to the moment you plan to show the ad. For example, if you have a "Watch video ad to get a reward" button in a shop menu, only call this method when the user opens the shop menu. This approach improves performance by preventing ads from unnecessarily being held in memory, and it benefits CPM (cost-per-thousand impressions) and earnings by optimizing the ad fill rate.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| adFormat | AdFormat | The format of the requested ad. For example, AdFormat.RewardedVideo. |
Returns
| Type | Description |
|---|---|
| GetAdAvailabilityNowResult | A dictionary that looks like { AdAvailabilityResult: Enum.AdAvailabilityResult }. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Monetization"] |
AdService:GetCampaignEligibilityAsync
GetCampaignEligibilityAsync checks whether a Player is eligible to be shown a specific ad integration campaign, returning a dictionary that looks like { IsEligible: boolean }.
Call this method and confirm that result.IsEligible is true before you display any of the campaign's ad integration assets or register their disclosure buttons with RegisterDisclosureButton. All ad integration assets should remain hidden until the Player is confirmed eligible.
When called from the client, the player argument defaults to the LocalPlayer. When called from the server, player is required. The call raises an error if the supplied campaignId exceeds the maximum allowed length.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| campaignId | string | The ID of the campaign that you want to check a Player's eligibility for. | |
| player | Player? | nil | The Player you want to check eligibility for. If omitted, it will default to the LocalPlayer. On the server, player argument is required. |
Returns
| Type | Description |
|---|---|
| GetCampaignEligibilityResult | A dictionary that looks like { IsEligible: boolean }. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Monetization"] |
Code samples: View on Creator Hub (AdService-AdIntegrations).
AdService:RegisterAdOpportunityAsync
This method may only be called from a Script with RunContext.Client.
Registers a GuiButton for ad opportunity tracking. Once registered, the system periodically checks whether the button is visible and unobstructed (the topmost input-sinking element at its center point). These visibility transitions are reported as ad opportunity impressions and used to measure the rate at which users are presented with, and choose to watch, rewarded video ads.
The instance must be a GuiButton that is a descendant of a ScreenGui under PlayerGui. If the instance is moved out of a valid hierarchy at runtime, tracking pauses automatically and resumes when it returns to a valid ancestor. Call UnregisterAdOpportunity to stop tracking the instance.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| instance | Instance | The GuiButton to track as a rewarded video ad opportunity. Must be a descendant of a ScreenGui. | |
| placementId | int64? | The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Monetization"] |
Code samples: View on Creator Hub (AdService-RegisterAdOpportunityAsync).
AdService:RegisterDisclosureButton
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| disclosureButton | GuiButton | The GuiButton you want to mark as an ad integration disclosure. The GuiButton must follow labeling guidelines outlined here. | |
| adIntegrationPlacementId | string | The ID of the placement that this disclosure is attached to. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Monetization"] |
AdService:ShowRewardedVideoAdAsync
Warning: Rewarded Video ads must be user opt-in and clearly disclosed. For details, review our eligibility requirements and advertising standards.
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| player | Player | The Player to trigger a rewarded video ad play for. | |
| reward | AdReward | The AdReward to grant the user after they view the ad. | |
| placementId | int64? | The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements. |
Returns
| Type | Description |
|---|---|
| ShowAdResult | The ShowAdResult of the client's ad presentation. You should not use this result to grant the reward. Instead, you should grant the reward from your ProcessReceipt implementation. For developer products earned through rewarded video ads, the receipt.ProductPurchaseChannel will be ProductPurchaseChannel.AdReward. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI","Monetization"] |
Code samples: View on Creator Hub (AdService-RewardedVideo).
AdService:ShowVideoAd
Deprecated. ShowVideoAd has been decommissioned and is no longer operational.
Show mobile video advertisements.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Monetization"] |
AdService:UnregisterAdOpportunity
Removes instance from the ad opportunity tracker so that it no longer counts toward the rewarded video ad opportunity reporting started by RegisterAdOpportunityAsync(). Call it once an instance should no longer be treated as an ad opportunity, such as when its associated UI is closed or removed.
If the supplied instance is not currently being tracked, this method has no effect.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| instance | Instance | The instance to stop tracking. This should be an instance that you previously passed to RegisterAdOpportunityAsync(). |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Monetization"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| AdService.VideoAdClosed | Fires when an AdService video closes. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
AdService.VideoAdClosed
Deprecated. VideoAdClosed has been decommissioned and is no longer operational.
Fires when an AdService video closes.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| adShown | boolean |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| capabilities | ["Monetization"] |
Properties
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |