Class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaModelPageOptimizationConfig

Returns a new instance of GoogleCloudRetailV2alphaModelPageOptimizationConfig.



7522
7523
7524
 
# File 'lib/google/apis/retail_v2/classes.rb', line 7522

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#page_optimization_event_type ⇒ String

Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: * add- to-cart: Products being added to cart. * detail-page-view: Products detail page viewed. * home-page-view: Homepage viewed * category-page-view: Homepage viewed * shopping-cart-page-view: User viewing a shopping cart. home-page-view only allows models with type recommended-for-you. All other page_optimization_event_type allow all Model.types. Corresponds to the JSON property pageOptimizationEventType

Returns:

  • (String) 


7508
7509
7510
 
# File 'lib/google/apis/retail_v2/classes.rb', line 7508

def page_optimization_event_type
  @page_optimization_event_type
end

#panels ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel>

Required. A list of panel configurations. Limit = 5. Corresponds to the JSON property panels

Returns:



7513
7514
7515
 
# File 'lib/google/apis/retail_v2/classes.rb', line 7513

def panels
  @panels
end

#restriction ⇒ String

Optional. How to restrict results across panels e.g. can the same ServingConfig be shown on multiple panels at once. If unspecified, default to UNIQUE_MODEL_RESTRICTION. Corresponds to the JSON property restriction

Returns:

  • (String) 


7520
7521
7522
 
# File 'lib/google/apis/retail_v2/classes.rb', line 7520

def restriction
  @restriction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7527
7528
7529
7530
7531
 
# File 'lib/google/apis/retail_v2/classes.rb', line 7527

def update!(**args)
  @page_optimization_event_type = args[:page_optimization_event_type] if args.key?(:page_optimization_event_type)
  @panels = args[:panels] if args.key?(:panels)
  @restriction = args[:restriction] if args.key?(:restriction)
end