Package io.constructor.data.builder

Types

class AutocompleteRequest( val term: String, val filters: Map<String, List<String>>? = null, val numResultsPerSection: Map<String, Int>? = null, val hiddenFields: List<String>? = null, val variationsMap: VariationsMap? = null, val sectionFilters: Map<String, Map<String, List<String>>>? = null)

Create an Autocomplete request object utilizing a builder

BrowseFacetOptionsRequest

class BrowseFacetOptionsRequest(val facetName: String, val showHiddenFacets: Boolean? = null)

Create a Browse facet options request object utilizing a builder

BrowseFacetsRequest

class BrowseFacetsRequest( val page: Int? = null, val offset: Int? = null, val numResultsPerPage: Int? = null, val showHiddenFacets: Boolean? = null)

Create a Browse facets request object utilizing a builder

BrowseGroupsRequest

class BrowseGroupsRequest(val groupId: String? = null, val groupsMaxDepth: Int? = null)

Create a Browse groups request object utilizing a builder

BrowseItemsRequest

class BrowseItemsRequest( val ids: List<String>, val filters: Map<String, List<String>>? = null, val page: Int? = null, val perPage: Int? = null, val sortBy: String? = null, val sortOrder: String? = null, val section: String? = null, val hiddenFields: List<String>? = null, val hiddenFacets: List<String>? = null, val groupsSortBy: String? = null, val groupsSortOrder: String? = null, val variationsMap: VariationsMap? = null, val preFilterExpression: String? = null, val fmtOptions: Map<String, Any>? = null)

Create a Browse Items request object utilizing a builder

BrowseRequest

class BrowseRequest( val filterName: String, val filterValue: String, val filters: Map<String, List<String>>? = null, val page: Int? = null, val perPage: Int? = null, val sortBy: String? = null, val sortOrder: String? = null, val section: String? = null, val hiddenFields: List<String>? = null, val hiddenFacets: List<String>? = null, val groupsSortBy: String? = null, val groupsSortOrder: String? = null, val variationsMap: VariationsMap? = null, val preFilterExpression: String? = null, val fmtOptions: Map<String, Any>? = null)

Create a Browse request object utilizing a builder

BrowseResultsLoadedData

class BrowseResultsLoadedData( val filterName: String, val filterValue: String, val resultCount: Int, val items: List<TrackingItem>? = null, val sectionName: String? = null, val url: String = "Not Available", val analyticsTags: Map<String, String>? = null, val resultId: String? = null, val resultPage: Int? = null, val resultOffset: Int? = null, val sortOrder: String? = null, val sortBy: String? = null, val selectedFilters: Map<String, List<String>>? = null)

Create a Browse Results Loaded tracking request object utilizing a builder

ProductInsightsAgentAnswerFeedbackTrackingData

class ProductInsightsAgentAnswerFeedbackTrackingData( val itemId: String, val feedbackLabel: ProductInsightsAgentFeedbackLabel, val qnaResultId: String? = null, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent answer feedback tracking request object utilizing a builder. Sent when the user gives feedback on an answer.

ProductInsightsAgentAnswerViewTrackingData

class ProductInsightsAgentAnswerViewTrackingData( val itemId: String, val question: String, val answerText: String, val questionTopic: String? = null, val qnaResultId: String? = null, val items: List<TrackingItem>? = null, val followUpQuestions: List<String>? = null, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent answer view tracking request object utilizing a builder. Sent when an answer is shown to the user.

ProductInsightsAgentFocusTrackingData

class ProductInsightsAgentFocusTrackingData( val itemId: String, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent focus tracking request object utilizing a builder. Sent when the user focuses on (i.e. taps into) the Product Insights Agent.

ProductInsightsAgentOutOfViewTrackingData

class ProductInsightsAgentOutOfViewTrackingData( val itemId: String, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent out of view tracking request object utilizing a builder. Sent when the Product Insights Agent scrolls out of view.

ProductInsightsAgentQuestionClickTrackingData

class ProductInsightsAgentQuestionClickTrackingData( val itemId: String, val question: String, val questionTopic: String? = null, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent question click tracking request object utilizing a builder. Sent when the user clicks a suggested question.

ProductInsightsAgentQuestionSubmitTrackingData

class ProductInsightsAgentQuestionSubmitTrackingData( val itemId: String, val question: String, val questionTopic: String? = null, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent question submit tracking request object utilizing a builder. Sent when the user submits a question.

ProductInsightsAgentResultClickTrackingData

class ProductInsightsAgentResultClickTrackingData( val itemId: String, val question: String, val seedItemId: String, val position: Int? = null, val seedItemName: String? = null, val seedVariationId: String? = null, val qnaResultId: String? = null, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent result click tracking request object utilizing a builder. Sent when the user clicks an item (product) recommended in an answer.

ProductInsightsAgentTrackingData

interface ProductInsightsAgentTrackingData

The parameters shared by every Product Insights Agent tracking request object

ProductInsightsAgentViewsTrackingData

class ProductInsightsAgentViewsTrackingData( val itemId: String, val questions: List<ProductInsightsAgentQuestion>, val viewTimespans: List<ProductInsightsAgentViewTimespan>, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent views tracking request object utilizing a builder. Sent when the Product Insights Agent has been viewed, reporting each span of time it was in view.

ProductInsightsAgentViewTrackingData

class ProductInsightsAgentViewTrackingData( val itemId: String, val questions: List<ProductInsightsAgentQuestion>, val itemName: String? = null, val variationId: String? = null, val threadId: String? = null, val sectionName: String? = null, val analyticsTags: Map<String, String>? = null) : ProductInsightsAgentTrackingData

Create a Product Insights Agent view tracking request object utilizing a builder. Sent when the Product Insights Agent comes into view.

QuizRequest

class QuizRequest( val quizId: String, val quizVersionId: String? = null, val quizSessionId: String? = null, val answers: List<List<String>>? = null, val section: String? = null, val page: Int? = null, val perPage: Int? = null, val filters: Map<String, List<String>>? = null)

Create a Quiz request object utilizing a builder

RecommendationsRequest

class RecommendationsRequest( val podId: String, val filters: Map<String, List<String>>? = null, val itemIds: List<String>? = null, val term: String? = null, val numResults: Int? = null, val section: String? = null, val hiddenFields: List<String>? = null, val variationsMap: VariationsMap? = null, val preFilterExpression: String? = null)

Create a Recommendations request object utilizing a builder

SearchRequest

class SearchRequest( val term: String, val filters: Map<String, List<String>>? = null, val page: Int? = null, val perPage: Int? = null, val sortBy: String? = null, val sortOrder: String? = null, val section: String? = null, val hiddenFields: List<String>? = null, val hiddenFacets: List<String>? = null, val groupsSortBy: String? = null, val groupsSortOrder: String? = null, val variationsMap: VariationsMap? = null, val preFilterExpression: String? = null, val fmtOptions: Map<String, Any>? = null)

Create a Search request object utilizing a builder

SearchResultsLoadedData

class SearchResultsLoadedData( val term: String, val resultCount: Int, val items: List<TrackingItem>? = null, val sectionName: String? = null, val url: String = "Not Available", val analyticsTags: Map<String, String>? = null, val resultId: String? = null, val resultPage: Int? = null, val resultOffset: Int? = null, val sortOrder: String? = null, val sortBy: String? = null, val selectedFilters: Map<String, List<String>>? = null)

Create a Search Results Loaded tracking request object utilizing a builder

SearchSubmitTrackingData

class SearchSubmitTrackingData( val searchTerm: String, val originalQuery: String, val resultGroup: ResultGroup? = null, val analyticsTags: Map<String, String>? = null)

Create a Search Submit tracking request object utilizing a builder