AuctionConfig

sealed class AuctionConfig(source)

Sealed class representing the configuration for a sponsored listing auction.

Use one of the subclasses to specify the auction type, then pass it to Auction.fromConfig to build the low-level Auction object.

Inheritors

Types

Link copied to clipboard
data class CategoryDisjunctions(val numSlots: Int, val disjunctions: List<List<String>>, val geo: String? = null, val opaqueUserId: String? = null, val placementId: Int? = null) : AuctionConfig

Auction targeting category disjunctions.

Link copied to clipboard
data class CategoryMultiple(val numSlots: Int, val categories: List<String>, val geo: String? = null, val opaqueUserId: String? = null, val placementId: Int? = null) : AuctionConfig

Auction targeting multiple categories.

Link copied to clipboard
data class CategorySingle(val numSlots: Int, val category: String, val geo: String? = null, val opaqueUserId: String? = null, val placementId: Int? = null) : AuctionConfig

Auction targeting a single category.

Link copied to clipboard
data class Keyword(val numSlots: Int, val keyword: String, val geo: String? = null, val opaqueUserId: String? = null, val placementId: Int? = null) : AuctionConfig

Auction targeting a search keyword.

Link copied to clipboard
data class ProductIds(val numSlots: Int, val ids: List<String>, val geo: String? = null, val opaqueUserId: String? = null, val placementId: Int? = null, val qualityScores: List<Double>? = null) : AuctionConfig

Auction targeting specific product IDs.

Properties

Link copied to clipboard

optional location string for geo-targeted auctions

Link copied to clipboard
abstract val opaqueUserId: String?

Optional opaque user ID for targeting context.

Link copied to clipboard
abstract val placementId: Int?

Optional experiment bucket (1-8) for A/B testing. Values outside the valid range are silently ignored during serialization.

Link copied to clipboard
val slots: Int

number of ad slots to fill (must be positive)