RustAdsClient.sys.mjs

class RustAdsClient.sys.MozAdsCacheConfig()

The on-disk HTTP cache. default_cache_ttl_seconds defaults to 300 and max_size_mib to 10.

RustAdsClient.sys.MozAdsCacheConfig.dbPath

type: string

RustAdsClient.sys.MozAdsCacheConfig.defaultCacheTtlSeconds

type: number

RustAdsClient.sys.MozAdsCacheConfig.maxSizeMib

type: number

class RustAdsClient.sys.MozAdsCacheMode()

Whether a request reads the cache before the network.

RustAdsClient.sys.MozAdsCacheMode.CACHE_FIRST

CACHE_FIRST

RustAdsClient.sys.MozAdsCacheMode.NETWORK_FIRST

NETWORK_FIRST

class RustAdsClient.sys.MozAdsCachePolicy()

How one request uses the cache. ttl_seconds overrides the client’s default TTL; 0 does not cache the response.

RustAdsClient.sys.MozAdsCachePolicy.mode

type: MozAdsCacheMode[keyof MozAdsCacheMode]

RustAdsClient.sys.MozAdsCachePolicy.ttlSeconds

type: number

class RustAdsClient.sys.MozAdsCallbackOptions()

Options for a callback request (click, impression or report).

RustAdsClient.sys.MozAdsCallbackOptions.ohttp

type: boolean

class RustAdsClient.sys.MozAdsCallbacks()

The callback URLs of an ad: pass them to record_click, record_impression and report_ad.

RustAdsClient.sys.MozAdsCallbacks.click

type: AdsClientUrl

RustAdsClient.sys.MozAdsCallbacks.impression

type: AdsClientUrl

RustAdsClient.sys.MozAdsCallbacks.report

type: AdsClientUrl

class RustAdsClient.sys.MozAdsClient()

Requests ads from MARS and records their clicks, impressions and reports. Build it with [MozAdsClientBuilder], ideally once per app.

RustAdsClient.sys.MozAdsClient.clearCache()

Deletes everything in the HTTP cache.

RustAdsClient.sys.MozAdsClient.recordClick(clickUrl, options=null)

Records a click on an ad, from its callbacks.click URL.

Arguments:
  • clickUrl (string)

  • options (MozAdsCallbackOptions)

RustAdsClient.sys.MozAdsClient.recordImpression(impressionUrl, options=null)

Records an impression of an ad, from its callbacks.impression URL.

Arguments:
  • impressionUrl (string)

  • options (MozAdsCallbackOptions)

RustAdsClient.sys.MozAdsClient.reportAd(reportUrl, reason, options=null)

Reports an ad, from its callbacks.report URL.

Arguments:
  • reportUrl (string)

  • reason (MozAdsReportReason[keyof MozAdsReportReason])

  • options (MozAdsCallbackOptions)

RustAdsClient.sys.MozAdsClient.requestImageAds(mozAdRequests, options=null)

Requests one image ad per placement. The result is keyed by placement_id and leaves out placements with no ad.

Arguments:
  • mozAdRequests (Array.<MozAdsPlacementRequest>)

  • options (MozAdsRequestOptions)

Returns:

Promise.<Map> – }

RustAdsClient.sys.MozAdsClient.requestSpocAds(mozAdRequests, options=null)

Requests count spocs per placement. The result is keyed by placement_id and leaves out placements with no ad.

Arguments:
  • mozAdRequests (Array.<MozAdsPlacementRequestWithCount>)

  • options (MozAdsRequestOptions)

Returns:

Promise.<Map> – }

RustAdsClient.sys.MozAdsClient.requestSpocOrImageAds(mozAdRequests, options=null)

Requests count ads per placement, for placements that can return either spocs or image ads. The result is keyed by placement_id and leaves out placements with no ad.

Arguments:
  • mozAdRequests (Array.<MozAdsPlacementRequestWithCount>)

  • options (MozAdsRequestOptions)

Returns:

Promise.<Map> – }

RustAdsClient.sys.MozAdsClient.requestTileAds(mozAdRequests, options=null)

Requests one tile ad per placement. The result is keyed by placement_id and leaves out placements with no ad.

Arguments:
  • mozAdRequests (Array.<MozAdsPlacementRequest>)

  • options (MozAdsRequestOptions)

Returns:

Promise.<Map> – }

RustAdsClient.sys.MozAdsClient.shutdown()

Allows the ads-client to unload some references and prepare for a safe shutdown. Other methods should not be called after this one. Currently, we shutdown (with no expected errors). However, future shutdowns may require an error to be logged, so we keep the Result.

class RustAdsClient.sys.MozAdsClientApiError()

The error every ads client method can throw.

class RustAdsClient.sys.MozAdsClientBuilder()

Configures and builds a [MozAdsClient].

RustAdsClient.sys.MozAdsClientBuilder.build()

Builds the client. A telemetry instance set on the builder becomes the destination of every client’s metrics in the process.

Returns:

MozAdsClient

RustAdsClient.sys.MozAdsClientBuilder.cacheConfig(cacheConfig)

Enables the HTTP cache with this configuration. Without it, nothing is cached.

Arguments:
  • cacheConfig (MozAdsCacheConfig)

Returns:

MozAdsClientBuilder

RustAdsClient.sys.MozAdsClientBuilder.environment(environment)

The MARS environment to send requests to. Defaults to production.

Arguments:
  • environment (MozAdsEnvironment[keyof MozAdsEnvironment])

Returns:

MozAdsClientBuilder

RustAdsClient.sys.MozAdsClientBuilder.telemetry(telemetry)

Where the client records its metrics. Telemetry is process-wide: see [MozAdsTelemetry].

Arguments:
  • telemetry (MozAdsTelemetry)

Returns:

MozAdsClientBuilder

RustAdsClient.sys.MozAdsClientBuilder.userAgent(userAgent)

The browser’s user agent, sent to MARS on OHTTP requests when the preflight returns none. Defaults to viaduct’s global default user agent.

Arguments:
  • userAgent (string)

Returns:

MozAdsClientBuilder

static RustAdsClient.sys.MozAdsClientBuilder.init()

A builder with the defaults: the production environment, no cache and no telemetry.

Returns:

MozAdsClientBuilder

class RustAdsClient.sys.MozAdsContentCategory()

IAB content categories, in one taxonomy version.

RustAdsClient.sys.MozAdsContentCategory.categories

type: Array.<string>

RustAdsClient.sys.MozAdsContentCategory.taxonomy

type: MozAdsIabContentTaxonomy[keyof MozAdsIabContentTaxonomy]

class RustAdsClient.sys.MozAdsEnvironment()

The MARS environment the client sends requests to. Defaults to Prod.

Variants are deliberately unsorted: UniFFI encodes them by index, and this mirrors Environment.

RustAdsClient.sys.MozAdsEnvironment.Custom
RustAdsClient.sys.MozAdsEnvironment.Prod
RustAdsClient.sys.MozAdsEnvironment.Staging
class RustAdsClient.sys.MozAdsIabContent()

The IAB content classification of a placement, for targeting.

RustAdsClient.sys.MozAdsIabContent.categoryIds

type: Array.<string>

RustAdsClient.sys.MozAdsIabContent.taxonomy

type: MozAdsIabContentTaxonomy[keyof MozAdsIabContentTaxonomy]

class RustAdsClient.sys.MozAdsIabContentTaxonomy()

The version of the IAB Content Taxonomy that category ids refer to.

RustAdsClient.sys.MozAdsIabContentTaxonomy.IAB1_0

IAB1_0

RustAdsClient.sys.MozAdsIabContentTaxonomy.IAB2_0

IAB2_0

RustAdsClient.sys.MozAdsIabContentTaxonomy.IAB2_1

IAB2_1

RustAdsClient.sys.MozAdsIabContentTaxonomy.IAB2_2

IAB2_2

RustAdsClient.sys.MozAdsIabContentTaxonomy.IAB3_0

IAB3_0

class RustAdsClient.sys.MozAdsImage()

An image ad returned by MARS.

RustAdsClient.sys.MozAdsImage.altText

type: string

RustAdsClient.sys.MozAdsImage.blockKey

type: string

RustAdsClient.sys.MozAdsImage.callbacks

type: MozAdsCallbacks

RustAdsClient.sys.MozAdsImage.format

type: string

RustAdsClient.sys.MozAdsImage.imageUrl

type: AdsClientUrl

RustAdsClient.sys.MozAdsImage.url

type: AdsClientUrl

class RustAdsClient.sys.MozAdsImageOrSpoc()

An ad from a placement that can return either an image or a spoc.

RustAdsClient.sys.MozAdsImageOrSpoc.Image
RustAdsClient.sys.MozAdsImageOrSpoc.Spoc
class RustAdsClient.sys.MozAdsPlacementRequest()

One placement to request a single ad for. placement_id must be unique within one request.

RustAdsClient.sys.MozAdsPlacementRequest.iabContent

type: MozAdsIabContent

RustAdsClient.sys.MozAdsPlacementRequest.placementId

type: string

class RustAdsClient.sys.MozAdsPlacementRequestWithCount()

One placement to request count ads for. placement_id must be unique within one request.

RustAdsClient.sys.MozAdsPlacementRequestWithCount.count

type: number

RustAdsClient.sys.MozAdsPlacementRequestWithCount.iabContent

type: MozAdsIabContent

RustAdsClient.sys.MozAdsPlacementRequestWithCount.placementId

type: string

class RustAdsClient.sys.MozAdsReportReason()

Why the user reported an ad.

RustAdsClient.sys.MozAdsReportReason.INAPPROPRIATE

INAPPROPRIATE

RustAdsClient.sys.MozAdsReportReason.MISLEADING

MISLEADING

RustAdsClient.sys.MozAdsReportReason.NOT_INTERESTED

NOT_INTERESTED

RustAdsClient.sys.MozAdsReportReason.OFFENSIVE

OFFENSIVE

RustAdsClient.sys.MozAdsReportReason.SCAM

SCAM

RustAdsClient.sys.MozAdsReportReason.SEEN_TOO_MANY_TIMES

SEEN_TOO_MANY_TIMES

class RustAdsClient.sys.MozAdsRequestOptions()

Options for one ad request. Every field has a default.

RustAdsClient.sys.MozAdsRequestOptions.blocks

type: Array.<string>

RustAdsClient.sys.MozAdsRequestOptions.cachePolicy

type: MozAdsCachePolicy

RustAdsClient.sys.MozAdsRequestOptions.flags

type: Map

RustAdsClient.sys.MozAdsRequestOptions.ohttp

type: boolean

RustAdsClient.sys.MozAdsRequestOptions.relevance

type: Map

class RustAdsClient.sys.MozAdsSpoc()

A sponsored content (spoc) ad returned by MARS.

RustAdsClient.sys.MozAdsSpoc.blockKey

type: string

RustAdsClient.sys.MozAdsSpoc.callbacks

type: MozAdsCallbacks

RustAdsClient.sys.MozAdsSpoc.caps

type: MozAdsSpocFrequencyCaps

RustAdsClient.sys.MozAdsSpoc.domain

type: string

RustAdsClient.sys.MozAdsSpoc.excerpt

type: string

RustAdsClient.sys.MozAdsSpoc.format

type: string

RustAdsClient.sys.MozAdsSpoc.imageUrl

type: AdsClientUrl

RustAdsClient.sys.MozAdsSpoc.ranking

type: MozAdsSpocRanking

RustAdsClient.sys.MozAdsSpoc.sponsor

type: string

RustAdsClient.sys.MozAdsSpoc.sponsoredByOverride

type: string

RustAdsClient.sys.MozAdsSpoc.title

type: string

RustAdsClient.sys.MozAdsSpoc.url

type: AdsClientUrl

class RustAdsClient.sys.MozAdsSpocFrequencyCaps()

Frequency capping information for a spoc.

RustAdsClient.sys.MozAdsSpocFrequencyCaps.capKey

type: string

RustAdsClient.sys.MozAdsSpocFrequencyCaps.day

type: number

class RustAdsClient.sys.MozAdsSpocRanking()

Ranking and personalization information for a spoc.

RustAdsClient.sys.MozAdsSpocRanking.itemScore

type: number

RustAdsClient.sys.MozAdsSpocRanking.personalizationModels

type: Map

RustAdsClient.sys.MozAdsSpocRanking.priority

type: number

class RustAdsClient.sys.MozAdsStoreConfig()

The SQLite database the stateful client keeps its ads in.

RustAdsClient.sys.MozAdsStoreConfig.dbPath

type: string

class RustAdsClient.sys.MozAdsTile()

A tile ad returned by MARS.

RustAdsClient.sys.MozAdsTile.blockKey

type: string

RustAdsClient.sys.MozAdsTile.callbacks

type: MozAdsCallbacks

RustAdsClient.sys.MozAdsTile.format

type: string

RustAdsClient.sys.MozAdsTile.imageUrl

type: AdsClientUrl

RustAdsClient.sys.MozAdsTile.name

type: string

RustAdsClient.sys.MozAdsTile.url

type: AdsClientUrl

class RustAdsClient.sys.Other()

Other