---
name: AdService
last_updated: 2026-06-11T17:05:15Z
inherits:
  - Instance
  - Object
type: class
memory_category: Instances
tags:
  - NotCreatable
  - Service
summary: "A class that allows the display of mobile video ads."
---

# Class: AdService

> A class that allows the display of mobile video ads.

## Description

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

## Methods

### Method: AdService:CreateAdRewardFromDevProductId

**Signature:** `AdService:CreateAdRewardFromDevProductId(devProductId: int64): AdReward`

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

*Security: None · Thread Safety: Unsafe · Capabilities: Monetization*

**Parameters:**

| Name | Type | Default | Description |
|------|------|---------|-------------|
| `devProductId` | `int64` |  | The ID of the developer product you want to grant as a reward. |

**Returns:** `AdReward`

### Method: AdService:GetAdAvailabilityNowAsync

**Signature:** `AdService:GetAdAvailabilityNowAsync(adFormat: AdFormat): GetAdAvailabilityNowResult`

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

*Yields · Security: None · Thread Safety: Unsafe · Capabilities: Monetization*

**Parameters:**

| Name | Type | Default | Description |
|------|------|---------|-------------|
| `adFormat` | `AdFormat` |  | The format of the requested ad. For example, `RewardedVideo`. |

**Returns:** `GetAdAvailabilityNowResult` — A dictionary with the [AdAvailabilityResult](/docs/reference/engine/enums/AdAvailabilityResult.md) for the requested ad
format.

```lua
local adAvailabilityResult = AdService:GetAdAvailabilityNow(Enum.AdFormat.RewardedVideo)
```

### Method: AdService:GetCampaignEligibilityAsync

**Signature:** `AdService:GetCampaignEligibilityAsync(campaignId: string, player?: Player?): GetCampaignEligibilityResult`

*Yields · Security: None · Thread Safety: Unsafe · Capabilities: Monetization*

**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 `Players.LocalPlayer`. |

**Returns:** `GetCampaignEligibilityResult` — A dictionary that looks like `{ IsEligible: boolean }`.

### Method: AdService:RegisterAdOpportunityAsync

**Signature:** `AdService:RegisterAdOpportunityAsync(instance: Instance, placementId: int64?): ()`

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 · Security: None · Thread Safety: Unsafe · Capabilities: Monetization*

**Parameters:**

| Name | Type | Default | Description |
|------|------|---------|-------------|
| `instance` | `Instance` |  |  |
| `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:** `()`

**Track ad opportunities**

Tracks ad opportunities for rewarded video ads.

```lua
local AdService = game:GetService("AdService")
local playerGui = game:GetService("Players").LocalPlayer:WaitForChild("PlayerGui")

-- Create the ScreenGui and the Button
local screenGui = Instance.new("ScreenGui", playerGui)
local adButton = Instance.new("TextButton", screenGui)

-- Register the button with AdService
local success, err = pcall(function()
	-- The second parameter is an optional Placement ID (Number) parameter generated in the Creator Hub.
	-- If you choose not to provide a Placement ID, the ad opportunity is tracked under the default placement.
	AdService:RegisterAdOpportunityAsync(adButton, 1234567891234567)
end)

if not success then
	warn("Failed to register ad opportunity:", err)
end
```

### Method: AdService:RegisterDisclosureButton

**Signature:** `AdService:RegisterDisclosureButton(disclosureButton: GuiButton, adIntegrationPlacementId: string): ()`

*Security: None · Thread Safety: Unsafe · Capabilities: Monetization*

**Parameters:**

| Name | Type | Default | Description |
|------|------|---------|-------------|
| `disclosureButton` | `GuiButton` |  | The `GuiButton` you want to mark as an ad disclosure. |
| `adIntegrationPlacementId` | `string` |  | The id of the placement that this disclosure is attached to. |

**Returns:** `()`

### Method: AdService:ShowRewardedVideoAdAsync

**Signature:** `AdService:ShowRewardedVideoAdAsync(player: Player, reward: AdReward, placementId: int64?): ShowAdResult`

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

*Yields · Security: None · Thread Safety: Unsafe · Capabilities: UI, Monetization*

**Parameters:**

| Name | Type | Default | Description |
|------|------|---------|-------------|
| `player` | `Player` |  | The `Player` object for whom you are fetching the ad for. |
| `reward` | `AdReward` |  | The reward object for the reward you want to grant the user who watches an ad to completion. |
| `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:** `ShowAdResult`

```lua
local reward = AdService:CreateAdRewardFromDevProductId(100)
local result = AdService:ShowRewardedVideoAdAsync(player, reward)
```

### Method: AdService:UnregisterAdOpportunity

**Signature:** `AdService:UnregisterAdOpportunity(instance: Instance): ()`

*Security: None · Thread Safety: Unsafe · Capabilities: Monetization*

**Parameters:**

| Name | Type | Default | Description |
|------|------|---------|-------------|
| `instance` | `Instance` |  |  |

**Returns:** `()`

### Method: AdService:ShowVideoAd

**Signature:** `AdService:ShowVideoAd(): ()`

> **Deprecated:** [ShowVideoAd](/docs/reference/engine/classes/AdService.md) has been decommissioned and is no longer operational.

Show mobile video advertisements.

*Security: None · Thread Safety: Unsafe · Capabilities: Monetization*

**Returns:** `()`

## Events

### Event: AdService.VideoAdClosed

**Signature:** `AdService.VideoAdClosed(adShown: boolean)`

> **Deprecated:** [VideoAdClosed](/docs/reference/engine/classes/AdService.md) has been decommissioned and is no longer operational.

Fires when an [AdService](/docs/reference/engine/classes/AdService.md) video closes.

*Security: None · Capabilities: Monetization*

**Parameters:**

| Name | Type | Description |
|------|------|-------------|
| `adShown` | `boolean` |  |

## Inherited Members

### From [Instance](/docs/reference/engine/classes/Instance.md)

- **Property `Archivable`** (`boolean`): Determines if an Instance and its descendants can be cloned using
- **Property `archivable`** (`boolean`):  *(deprecated, hidden)*
- **Property `Capabilities`** (`SecurityCapabilities`): The set of capabilities allowed to be used for scripts inside this
- **Property `Name`** (`string`): A non-unique identifier of the Instance.
- **Property `Parent`** (`Instance`): Determines the hierarchical parent of the Instance.
- **Property `PredictionMode`** (`PredictionMode`): 
- **Property `RobloxLocked`** (`boolean`): A deprecated property that used to protect CoreGui objects. *(hidden)*
- **Property `Sandboxed`** (`boolean`): When enabled, the instance can only access abilities in its `Capabilities`
- **Property `UniqueId`** (`UniqueId`): A unique identifier for the instance.
- **Method `AddTag(tag: string): ()`**: Applies a tag to the instance.
- **Method `children(): Instances`**: Returns an array of the object's children. *(deprecated)*
- **Method `ClearAllChildren(): ()`**: This method destroys all of an instance's children.
- **Method `Clone(): Instance`**: Create a copy of an instance and all its descendants, ignoring instances
- **Method `clone(): Instance`**:  *(deprecated)*
- **Method `Destroy(): ()`**: Sets the Instance.Parent property to `nil`, locks the
- **Method `destroy(): ()`**:  *(deprecated)*
- **Method `FindFirstAncestor(name: string): Instance?`**: Returns the first ancestor of the Instance whose
- **Method `FindFirstAncestorOfClass(className: string): Instance?`**: Returns the first ancestor of the Instance whose
- **Method `FindFirstAncestorWhichIsA(className: string): Instance?`**: Returns the first ancestor of the Instance for whom
- **Method `FindFirstChild(name: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance found with the given name.
- **Method `findFirstChild(name: string, recursive?: boolean): Instance`**:  *(deprecated)*
- **Method `FindFirstChildOfClass(className: string): Instance?`**: Returns the first child of the Instance whose
- **Method `FindFirstChildWhichIsA(className: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance for whom
- **Method `FindFirstDescendant(name: string): Instance?`**: Returns the first descendant found with the given Instance.Name.
- **Method `GetActor(): Actor?`**: Returns the Actor associated with the Instance, if any.
- **Method `GetAttribute(attribute: string): Variant`**: Returns the value which has been assigned to the given attribute name.
- **Method `GetAttributeChangedSignal(attribute: string): RBXScriptSignal`**: Returns an event that fires when the given attribute changes.
- **Method `GetAttributes(): Dictionary`**: Returns a dictionary of the instance's attributes.
- **Method `GetChildren(): Instances`**: Returns an array containing all of the instance's children.
- **Method `getChildren(): Instances`**:  *(deprecated)*
- **Method `GetDebugId(scopeLength?: int): string`**: Returns a coded string of the debug ID used internally by Roblox.
- **Method `GetDescendants(): Instances`**: Returns an array containing all of the descendants of the instance.
- **Method `GetFullName(): string`**: Returns a string describing the instance's ancestry.
- **Method `GetStyled(name: string, selector: string?): Variant`**: Returns the styled or explicitly modified value of the specified property,
- **Method `GetStyledPropertyChangedSignal(property: string): RBXScriptSignal`**: 
- **Method `GetTags(): Array`**: Gets an array of all tags applied to the instance.
- **Method `HasTag(tag: string): boolean`**: Check whether the instance has a given tag.
- **Method `IsAncestorOf(descendant: Instance): boolean`**: Returns true if an Instance is an ancestor of the given
- **Method `IsDescendantOf(ancestor: Instance): boolean`**: Returns `true` if an Instance is a descendant of the given
- **Method `isDescendantOf(ancestor: Instance): boolean`**:  *(deprecated)*
- **Method `IsPropertyModified(property: string): boolean`**: Returns `true` if the value stored in the specified property is not equal
- **Method `QueryDescendants(selector: string): Instances`**: 
- **Method `Remove(): ()`**: Sets the object's `Parent` to `nil`, and does the same for all its *(deprecated)*
- **Method `remove(): ()`**:  *(deprecated)*
- **Method `RemoveTag(tag: string): ()`**: Removes a tag from the instance.
- **Method `ResetPropertyToDefault(property: string): ()`**: Resets a property to its default value.
- **Method `SetAttribute(attribute: string, value: Variant): ()`**: Sets the attribute with the given name to the given value.
- **Method `WaitForChild(childName: string, timeOut: double): Instance`**: Returns the child of the Instance with the given name. If the
- **Event `AncestryChanged`**: Fires when the Instance.Parent property of this object or one of
- **Event `AttributeChanged`**: Fires whenever an attribute is changed on the Instance.
- **Event `ChildAdded`**: Fires after an object is parented to this Instance.
- **Event `childAdded`**:  *(deprecated)*
- **Event `ChildRemoved`**: Fires after a child is removed from this Instance.
- **Event `DescendantAdded`**: Fires after a descendant is added to the Instance.
- **Event `DescendantRemoving`**: Fires immediately before a descendant of the Instance is removed.
- **Event `Destroying`**: Fires immediately before (or is deferred until after) the instance is
- **Event `StyledPropertiesChanged`**: Fires whenever any style property is changed on the instance, including

### From [Object](/docs/reference/engine/classes/Object.md)

- **Property `ClassName`** (`string`): A read-only string representing the class this Object belongs to.
- **Property `className`** (`string`):  *(deprecated)*
- **Method `GetPropertyChangedSignal(property: string): RBXScriptSignal`**: Get an event that fires when a given property of the object changes.
- **Method `IsA(className: string): boolean`**: Returns true if an object's class matches or inherits from a given class.
- **Method `isA(className: string): boolean`**:  *(deprecated)*
- **Event `Changed`**: Fires immediately after a property of the object changes, with some