Topsort Analytics/com.topsort.analytics.model/Placement

Placement

data class Placement(val path: String, val position: Int? = null, val page: Int? = null, val pageSize: Int? = null, val productId: String? = null, val categoryIds: List<String>? = null, val searchQuery: String? = null, val location: String? = null)(source)

Constructors

Placement

constructor(path: String, position: Int? = null, page: Int? = null, pageSize: Int? = null, productId: String? = null, categoryIds: List<String>? = null, searchQuery: String? = null, location: String? = null)

Types

Companion

object Companion

Properties

categoryIds

val categoryIds: List<String>?

An array of IDs of the categories associated to the page in which this event occurred, if applicable. These IDs must match the IDs provided through the catalog service.

location

val location: String?

A marketplace defined name for a page part

page

val page: Int?

For paginated pages, this should indicate which page number triggered the event.

pageSize

val pageSize: Int?

For paginated pages this should indicate how many items are in each result page.

path

val path: String

URL path of the page triggering the event.

position

val position: Int?

For components with multiple items (i.e. search results, similar products, etc), this should indicate the index of a given item within that list.

productId

val productId: String?

The ID of the product associated to the page in which this event occurred, if applicable. This ID must match the ID provided through the catalog service.

searchQuery

val searchQuery: String?

The search string provided by the user in the page where this event occurred, if applicable. This search string must match the searchQuery field that was provided in the auction request (if provided).

Functions

toJsonObject

fun toJsonObject(): JSONObject