---
title: "Advertising"
slug: "081-core-advertising"
updated: 2025-05-23T22:32:17Z
published: 2025-05-23T22:32:17Z
canonical: "docs.developer.comcast.com/081-core-advertising"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.developer.comcast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Advertising

**Advertising Module 0.8.1 | Core SDK**

## Overview

A module for platform provided advertising settings and functionality.

## OpenRPC

Firebolt APIs are maintained in the [rdkcentral/firebolt-core-sdk](https://github.com/rdkcentral/firebolt-core-sdk) GitHub repository.

You can see this API in the [advertising.json](https://github.com/rdkcentral/firebolt-core-sdk/blob/main/src/modules/advertising.json) OpenRPC JSON-Schema document.

## Usage

To use the Advertising module, you can import it into your project from the Firebolt SDK:

```
import { Advertising } from '@firebolt-js/sdk'
```

## Methods

### advertisingId

Get the advertising ID

```
function advertisingId(): Promise<object>
```

Promise resolution:

the advertising ID

| Field | Type | Description |
| --- | --- | --- |
| `ifa` | `string` |  |
| `ifa_type` | `string` |  |
| `lmt` | `string` |  |

**Examples**

Getting the advertising ID

JavaScript:

```
import { Advertising } from '@firebolt-js/sdk'

Advertising.advertisingId()
    .then(advertisingId => {
        console.log(advertisingId)
    })
```

Value of `advertisingId`:

```
{
  "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
  "ifa_type": "idfa",
  "lmt": "0"
}
```

**JSON-RPC:**

Request:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "advertising.advertisingId",
  "params": {}
}
```

Response:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
    "ifa_type": "idfa",
    "lmt": "0"
  }
}
```

---

### appBundleId

Get the App's Bundle ID

```
function appBundleId(): Promise<string>
```

Promise resolution:

| Type | Description |
| --- | --- |
| `string` | the app bundle ID |

**Examples**

Default Example

JavaScript:

```
import { Advertising } from '@firebolt-js/sdk'

Advertising.appBundleId()
    .then(appBundleId => {
        console.log(appBundleId)
    })
```

Value of `appBundleId`:

```
"operator.app"
```

**JSON-RPC:**

Request:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "advertising.appBundleId",
  "params": {}
}
```

Response:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "operator.app"
}
```

---

### config

Build configuration object for Ad Framework initialization

```
function config(options: AdConfigurationOptions): Promise<object>
```

Parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `options` | [`AdConfigurationOptions`](/docs/081-core-advertising#adconfigurationoptions) | true | Configuration options |

Promise resolution:

| Type | Description |
| --- | --- |
| `object` | An opaque object represneting the AdConfiguration |

**Examples**

Initializing the Ad Framework

JavaScript:

```
import { Advertising } from '@firebolt-js/sdk'

Advertising.config({"environment":"prod","authenticationEntity":"MVPD"})
    .then(adFrameworkConfig => {
        console.log(adFrameworkConfig)
    })
```

Value of `adFrameworkConfig`:

```
{
  "adServerUrl": "http://demo.v.fwmrm.net/ad/p/1",
  "adServerUrlTemplate": "http://demo.v.fwmrm.net/ad/p/1?flag=+sltp+exvt+slcb+emcr+amcb+aeti&prof=12345:caf_allinone_profile &nw=12345&mode=live&vdur=123&caid=a110523018&asnw=372464&csid=gmott_ios_tablet_watch_live_ESPNU&ssnw=372464&vip=198.205.92.1&resp=vmap1&metr=1031&pvrn=12345&vprn=12345&vcid=1X0Ce7L3xRWlTeNhc7br8Q%3D%3D",
  "adNetworkId": "519178",
  "adProfileId": "12345:caf_allinone_profile",
  "adSiteSectionId": "caf_allinone_profile_section",
  "adOptOut": true,
  "privacyData": "ew0KICAicGR0IjogImdkcDp2MSIsDQogICJ1c19wcml2YWN5IjogIjEtTi0iLA0KICAibG10IjogIjEiIA0KfQ0K",
  "ifaValue": "01234567-89AB-CDEF-GH01-23456789ABCD",
  "ifa": "ewogICJ2YWx1ZSI6ICIwMTIzNDU2Ny04OUFCLUNERUYtR0gwMS0yMzQ1Njc4OUFCQ0QiLAogICJpZmFfdHlwZSI6ICJzc3BpZCIsCiAgImxtdCI6ICIwIgp9Cg==",
  "appName": "FutureToday",
  "appBundleId": "FutureToday.comcast",
  "distributorAppId": "1001",
  "deviceAdAttributes": "ewogICJib0F0dHJpYnV0ZXNGb3JSZXZTaGFyZUlkIjogIjEyMzQiCn0=",
  "coppa": 0,
  "authenticationEntity": "60f72475281cfba3852413bd53e957f6"
}
```

**JSON-RPC:**

Request:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "advertising.config",
  "params": {
    "options": {
      "environment": "prod",
      "authenticationEntity": "MVPD"
    }
  }
}
```

Response:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "adServerUrl": "http://demo.v.fwmrm.net/ad/p/1",
    "adServerUrlTemplate": "http://demo.v.fwmrm.net/ad/p/1?flag=+sltp+exvt+slcb+emcr+amcb+aeti&prof=12345:caf_allinone_profile &nw=12345&mode=live&vdur=123&caid=a110523018&asnw=372464&csid=gmott_ios_tablet_watch_live_ESPNU&ssnw=372464&vip=198.205.92.1&resp=vmap1&metr=1031&pvrn=12345&vprn=12345&vcid=1X0Ce7L3xRWlTeNhc7br8Q%3D%3D",
    "adNetworkId": "519178",
    "adProfileId": "12345:caf_allinone_profile",
    "adSiteSectionId": "caf_allinone_profile_section",
    "adOptOut": true,
    "privacyData": "ew0KICAicGR0IjogImdkcDp2MSIsDQogICJ1c19wcml2YWN5IjogIjEtTi0iLA0KICAibG10IjogIjEiIA0KfQ0K",
    "ifaValue": "01234567-89AB-CDEF-GH01-23456789ABCD",
    "ifa": "ewogICJ2YWx1ZSI6ICIwMTIzNDU2Ny04OUFCLUNERUYtR0gwMS0yMzQ1Njc4OUFCQ0QiLAogICJpZmFfdHlwZSI6ICJzc3BpZCIsCiAgImxtdCI6ICIwIgp9Cg==",
    "appName": "FutureToday",
    "appBundleId": "FutureToday.comcast",
    "distributorAppId": "1001",
    "deviceAdAttributes": "ewogICJib0F0dHJpYnV0ZXNGb3JSZXZTaGFyZUlkIjogIjEyMzQiCn0=",
    "coppa": 0,
    "authenticationEntity": "60f72475281cfba3852413bd53e957f6"
  }
}
```

---

### deviceAttributes

Get the device advertising device attributes

```
function deviceAttributes(): Promise<object>
```

Promise resolution:

| Type | Description |
| --- | --- |
| `object` | the device attributes |

**Examples**

Getting the device attributes

JavaScript:

```
import { Advertising } from '@firebolt-js/sdk'

Advertising.deviceAttributes()
    .then(deviceAttributes => {
        console.log(deviceAttributes)
    })
```

Value of `deviceAttributes`:

```
{}
```

**JSON-RPC:**

Request:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "advertising.deviceAttributes",
  "params": {}
}
```

Response:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {}
}
```

---

### listen

Listen for events from this module.

To listen to a specific event pass the event name as the first parameter:

```
Advertising.listen(event: string, (data: any) => void): Promise<number>
```

Parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `event` | `string` | Yes | The event to listen for, see [Events](/docs/081-core-advertising#events). |
| *callback* | `function` | Yes | A function that will be invoked when the event occurs. |

Promise resolution:

| Type | Description |
| --- | --- |
| `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Advertising.clear(id)` |

Callback parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/081-core-advertising#events). |

To listen to all events from this module pass only a callback, without specifying an event name:

```
Advertising.listen((event: string, data: any) => void): Promise<number>
```

Parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| *callback* | `function` | Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see [Events](/docs/081-core-advertising#events). |

Callback parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `event` | `string` | Yes | The event that has occured listen for, see [Events](/docs/081-core-advertising#events). |
| `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/081-core-advertising#events). |

Promise resolution:

| Type | Description |
| --- | --- |
| `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Advertising.clear(id)` |

See [Listening for events](/docs/listening-for-events/) for more information and examples.

---

### once

Listen for only one occurance of an event from this module. The callback will be cleared after one event.

To listen to a specific event pass the event name as the first parameter:

```
Advertising.once(event: string, (data: any) => void): Promise<number>
```

Parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `event` | `string` | Yes | The event to listen for, see [Events](/docs/081-core-advertising#events). |
| *callback* | `function` | Yes | A function that will be invoked when the event occurs. |

Promise resolution:

| Type | Description |
| --- | --- |
| `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Advertising.clear(id)` |

Callback parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/081-core-advertising#events). |

To listen to all events from this module pass only a callback, without specifying an event name:

```
Advertising.once((event: string, data: any) => void): Promise<number>
```

Parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| *callback* | `function` | Yes | A function that will be invoked when the event occurs. The event data depends on which event is firing, see [Events](/docs/081-core-advertising#events). |

Callback parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `event` | `string` | Yes | The event that has occured listen for, see [Events](/docs/081-core-advertising#events). |
| `data` | `any` | Yes | The event data, which depends on which event is firing, see [Events](/docs/081-core-advertising#events). |

Promise resolution:

| Type | Description |
| --- | --- |
| `number` | Listener ID to clear the callback method and stop receiving the event, e.g. `Advertising.clear(id)` |

See [Listening for events](/docs/listening-for-events/) for more information and examples.

---

### policy

Get the advertising privacy and playback policy

To get the value, call the method with no parameters:

```
function policy(): Promise<AdPolicy>
```

Promise resolution:

| Type | Description |
| --- | --- |
| [`AdPolicy`](/docs/081-core-advertising#adpolicy) | Describes various ad playback enforcement rules that the app should follow. |

**Examples**

Getting the advertising policy settings

JavaScript:

```
import { Advertising } from '@firebolt-js/sdk'

Advertising.policy()
    .then(adPolicy => {
        console.log(adPolicy)
    })
```

Value of `adPolicy`:

```
{
  "skipRestriction": "adsUnwatched",
  "limitAdTracking": false
}
```

**JSON-RPC:**

Request:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "advertising.policy",
  "params": {}
}
```

Response:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "skipRestriction": "adsUnwatched",
    "limitAdTracking": false
  }
}
```

To subscribe to notifications when the value changes, pass a function as the only parameter:

```
function policy(subscriber: (adPolicy: AdPolicy) => void): Promise<boolean>
```

Parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `subscriber` | `Function` | Yes | A callback that gets invoked when the value for policy changes |

Promise resolution:

| Type | Summary |
| --- | --- |
| `listenerId` | The id of the listener that can be used with Advertising.clear(listenerId) to unsubscribe |

Callback parameters:

| Param | Type | Required | Summary |
| --- | --- | --- | --- |
| `adPolicy` | [`AdPolicy`](/docs/081-core-advertising#adpolicy) | Yes | the ad policy |

**Examples**

Getting the advertising policy settings

JavaScript:

```
import { Advertising } from '@firebolt-js/sdk'

Advertising.policy(adPolicy => {
  // property value was changed
  console.log(adPolicy)
}).then(listenerId => {
  // you can clear this listener w/ Advertising.clear(listenerId)
})
```

value of `adPolicy`:

```
{
  "skipRestriction": "adsUnwatched",
  "limitAdTracking": false
}
```

**JSON-RPC:**

Request:

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "advertising.onPolicyChanged",
  "params": {
    "listen": true
  }
}
```

Response:

```
{
  "jsonrpc": "2.0",
  "id": "1",
  "result": {
    "listening": "true"
  }
}
```

```
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "skipRestriction": "adsUnwatched",
    "limitAdTracking": false
  }
}
```

---

## Events

### Additional events

The following events are documented as part of a related set of method APIs.

For more information, follow the links under the "Documentation" column.

| JavaScript | RPC | Payload | Documentation |
| --- | --- | --- | --- |
| policyChanged | onPolicyChanged | [AdPolicy](/docs/081-core-advertising#adpolicy) | [policy](/docs/081-core-advertising#policy) |

## Schemas

### AdPolicy

Describes various ad playback enforcement rules that the app should follow.

```
type AdPolicy = {
  skipRestriction?: SkipRestriction  // The advertisement skip restriction.
  limitAdTracking?: boolean
}
```

See also:

- [SkipRestriction](/docs/081-core-Advertising-schemas#skiprestriction)

---

### AdConfigurationOptions

```
type AdConfigurationOptions = {
  coppa?: boolean                // Whether or not the app requires US COPPA compliance.
  environment?: 'prod' | 'test'  // Whether the app is running in a production or test mode.
  authenticationEntity?: string  // The authentication provider, when it is separate entity than the app provider, e.g. an MVPD.
}
```

---