Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule

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

Overview

A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaRule

Returns a new instance of GoogleCloudRetailV2betaRule.



6111
6112
6113
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6111

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

Instance Attribute Details

#boost_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleBoostAction

A boost action to apply to results matching condition specified above. Corresponds to the JSON property boostAction

Returns:



6047
6048
6049
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6047

def boost_action
  @boost_action
end

#condition ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCondition

Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted. Corresponds to the JSON property condition

Returns:



6057
6058
6059
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6057

def condition
  @condition
end

#do_not_associate_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleDoNotAssociateAction

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap". Corresponds to the JSON property doNotAssociateAction

Returns:



6063
6064
6065
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6063

def do_not_associate_action
  @do_not_associate_action
end

#filter_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleFilterAction

  • Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. * Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule( s). NOTE: May result in 0 results when filters conflict. * Action Result: Filters the returned objects to be ONLY those that passed the filter. Corresponds to the JSON property filterAction

Returns:



6074
6075
6076
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6074

def filter_action
  @filter_action
end

#ignore_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleIgnoreAction

Prevents a term in the query from being used in search. Example: Don't search for "shoddy". Corresponds to the JSON property ignoreAction

Returns:



6080
6081
6082
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6080

def ignore_action
  @ignore_action
end

#oneway_synonyms_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleOnewaySynonymsAction

Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". " shoes" will not use a synonym of "sneakers". Corresponds to the JSON property onewaySynonymsAction

Returns:



6088
6089
6090
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6088

def oneway_synonyms_action
  @oneway_synonyms_action
end

#redirect_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleRedirectAction

Redirects a shopper to a specific page. * Rule Condition: - Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri. Corresponds to the JSON property redirectAction

Returns:



6095
6096
6097
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6095

def redirect_action
  @redirect_action
end

#replacement_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleReplacementAction

Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe". Corresponds to the JSON property replacementAction

Returns:



6102
6103
6104
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6102

def replacement_action
  @replacement_action
end

#twoway_synonyms_action ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleTwowaySynonymsAction

Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes" . * "shoes" will use a synonym of "sneakers". Corresponds to the JSON property twowaySynonymsAction

Returns:



6109
6110
6111
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6109

def twoway_synonyms_action
  @twoway_synonyms_action
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 6116

def update!(**args)
  @boost_action = args[:boost_action] if args.key?(:boost_action)
  @condition = args[:condition] if args.key?(:condition)
  @do_not_associate_action = args[:do_not_associate_action] if args.key?(:do_not_associate_action)
  @filter_action = args[:filter_action] if args.key?(:filter_action)
  @ignore_action = args[:ignore_action] if args.key?(:ignore_action)
  @oneway_synonyms_action = args[:oneway_synonyms_action] if args.key?(:oneway_synonyms_action)
  @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
  @replacement_action = args[:replacement_action] if args.key?(:replacement_action)
  @twoway_synonyms_action = args[:twoway_synonyms_action] if args.key?(:twoway_synonyms_action)
end