sdk_core/com.adition.sdk_core.internal.entities/AdRequestGlobalParameters

AdRequestGlobalParameters

class AdRequestGlobalParameters : BaseGlobalParameters

An object for storing global parameters that will be applied when creating an Ad request. Some parameters of `AdRequest` are designed to be passed in all requests, not just individual ones. To avoid duplicating code when creating AdRequest.

AdService.setAdRequestGlobalParameter use to set AdRequestGlobalParameters

// Set parameter
AdService.setAdRequestGlobalParameter(
     AdRequestGlobalParameters::externalUID,
     ExternalUID(uid = "example", isStable = true)
)

// Clear parameter:
AdService.removeAdRequestGlobalParameter(AdRequestGlobalParameters::externalUID)

This object serves to store these parameters within the SDK. This class inherit from BaseGlobalParameters.

Constructors

AdRequestGlobalParameters

constructor()

Properties

dsa

var dsa: DSA?

Digital Service Act (“DSA”) is a EU regulation which aims among other things to increase transparency on online platforms for users in relation to recommended content – including advertising.

externalUID

var externalUID: ExternalUID?

If your app has means to identify a user, for example through association with an user account or an advertising ID, you can share this with the AdServer.

gdpr

var gdpr: GDPR?

An app can ask users about their consent for sharing information with third parties. The SDK can forward users preferences if they follow the TCF format.

isOptOutEnabled

var isOptOutEnabled: Boolean?

An app can ask users if they want to opt out from process data. Use isOptOutEnabled to make the users choice visible for the Adserver.

isSHBEnabled

var isSHBEnabled: Boolean?

Defines, if the request should also consider the server side header bidding. Enabled if the value is 'true', disabled if the value is 'false'.

userIds

var userIds: List<UserId>?

List of identifiers for additional Extended IDs on the Identity Service. The data type of userIds is a list of UserId.