Class: Google::Apis::RetailV2::GoogleCloudRetailV2Rule

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

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) ⇒ GoogleCloudRetailV2Rule

Returns a new instance of GoogleCloudRetailV2Rule.



3149
3150
3151
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3149

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

Instance Attribute Details

#boost_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleBoostAction

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

Returns:



3085
3086
3087
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3085

def boost_action
  @boost_action
end

#condition ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Condition

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:



3095
3096
3097
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3095

def condition
  @condition
end

#do_not_associate_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleDoNotAssociateAction

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:



3101
3102
3103
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3101

def do_not_associate_action
  @do_not_associate_action
end

#filter_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleFilterAction

  • 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:



3112
3113
3114
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3112

def filter_action
  @filter_action
end

#ignore_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleIgnoreAction

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

Returns:



3118
3119
3120
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3118

def ignore_action
  @ignore_action
end

#oneway_synonyms_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleOnewaySynonymsAction

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:



3126
3127
3128
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3126

def oneway_synonyms_action
  @oneway_synonyms_action
end

#redirect_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleRedirectAction

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:



3133
3134
3135
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3133

def redirect_action
  @redirect_action
end

#replacement_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleReplacementAction

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:



3140
3141
3142
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3140

def replacement_action
  @replacement_action
end

#twoway_synonyms_action ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2RuleTwowaySynonymsAction

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:



3147
3148
3149
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3147

def twoway_synonyms_action
  @twoway_synonyms_action
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3154

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