ad_sdk/com.adition.ad_sdk.api.core/AdService

AdService

interface AdService

A key interface for configuring your advertisements.

It is responsible for creating Advertisement objects, managing caching, and performing tag and tracking requests.

You can obtain an object of this interface using AdServiceProvider.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val networkId: String

The unique identifier of the ad network.

Functions

Link copied to clipboard
abstract suspend fun flushCache(): AdResult<Unit>

Removes all objects from the cache.

Link copied to clipboard
abstract suspend fun makeAdvertisement(adRequest: AdRequest, placementType: AdPlacementType = AdPlacementType.INLINE, adEventListener: AdEventListener? = null, targetURLHandler: TargetURLHandler? = null): AdResult<Advertisement>

Creating an Advertisement object and performing ad request.

Link copied to clipboard
abstract suspend fun registerRenderer(name: String, factory: (AdRenderer.ServiceLocator) -> AdRenderer)

Registers a custom ad renderer.

Link copied to clipboard
abstract fun <T> removeAdRequestGlobalParameter(keyPath: KMutableProperty1<AdRequestGlobalParameters, T?>)

A method for removing global parameter from AdRequest.

Link copied to clipboard
abstract fun <T> removeGlobalParameter(keyPath: KMutableProperty1<GlobalParameters, T?>)

A method for removing global parameter from AdRequest, TagRequest, and TrackingRequest.

Link copied to clipboard
abstract fun setAdRequestGlobalParameters(vararg parameters: AdRequestGlobalParameter<*>)

A method for setting global parameters specific only for the AdRequest.

Link copied to clipboard
abstract suspend fun setCacheSize(sizeInMb: UShort): AdResult<Unit>

Changes the maximum cache size on disk.

Link copied to clipboard
abstract fun setGlobalParameters(vararg parameters: GlobalParameter<*>)

A method for setting common global parameters for AdRequest, TagRequest, and TrackingRequest.

Link copied to clipboard
abstract fun setLogEnabled(enabled: Boolean)

Enables or disables SDK's logs.

Link copied to clipboard
abstract suspend fun tagUser(tagRequest: TagRequest): AdResult<Unit>

Trigger a request to "tag" a user.

Link copied to clipboard
abstract suspend fun trackingRequest(trackingRequest: TrackingRequest): AdResult<Unit>

Trigger a request for conversion tracking.

Link copied to clipboard
abstract suspend fun unregisterRenderer(name: String)

Unregisters the custom ad renderer.