TagRequest

data class TagRequest(val tags: List<TagRequest.Tag>, val timeout: UInt? = null)

Describes a request to "tag" a user.

You can build retargeting segments by exposing a user in your application to tagging requests. Segments can be used in Adition campaign targeting.

A Tag in Adition consists of a key and a value. The key is made up of 2 parts. The attribute and the sub-attribute. An example of a tag could be:

MyShop.ProductNumber = '123'

The Tags can be setup on the Adition server to keep all the tags or always overwrite with the last sent tag. Therefore it is possible to have a history or the most current tag value.

The client/app can fire the tag request as soon as an event or action occurs within the app. The AdRequest made after a tag was sent will be able to use the tags within the targeting.

This class uses as a parameter of the AdService.tagUser method.

val tags = listOf(TagRequest.Tag("segments", "category", "home"))
adService.tagUser(TagRequest(tags))

See also

Constructors

Link copied to clipboard
constructor(tags: List<TagRequest.Tag>, timeout: UInt? = null)

Creates an TagRequest instance.

Types

Link copied to clipboard
data class Tag(val key: String, val subKey: String, val value: String? = null)

Contains basic information for user tagging.

Properties

Link copied to clipboard

List of Tag instances.

Link copied to clipboard
val timeout: UInt? = null

Timeout in seconds for specific tag request. Fail with AdError.TimedOut if no response is received from the server within the given time.