sdk_core/com.adition.sdk_core.api.entities.request/TrackingGlobalParameters

TrackingGlobalParameters

class TrackingGlobalParameters : BaseGlobalParameters

An object for storing global parameters that will be applied when creating an TagRequest and TrackingRequest.

Some parameters of an TagRequest and TrackingRequest are designed to be passed in all requests, not just individual ones. To avoid duplicating code when creating TagRequest and TrackingRequest, SDK provide AdService.setTrackingGlobalParameter method, which will modify these parameters:

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

// Clear parameter:
AdService.removeTrackingGlobalParameter(TrackingGlobalParameters::externalUID)
Content copied to clipboard

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

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
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 ad server.

Link copied to clipboard
var gdpr: GDPR?

App can ask users about their consent for sharing information with third parties.

Link copied to clipboard
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 ad server.

Link copied to clipboard
var userIds: List<UserIdType>?

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