REST Resource: projects.locations.catalogs.controls

Stay organized with collections Save and categorize content based on your preferences.

Resource: Control

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

JSON representation
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionTypes": [
    enum (SolutionType)
  ],
  "searchSolutionUseCase": [
    enum (SearchSolutionUseCase)
  ],
  "rule": {
    object (Rule)
  }
}
Fields
name

string

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

displayName

string

Required. The human readable control display name. Used in Retail UI.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

associatedServingConfigIds[]

string

Output only. List of serving configuration ids that are associated with this control in the same Catalog.

Note the association is managed via the ServingConfig, this is an output only denormalized view.

solutionTypes[]

enum (SolutionType)

Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time.

Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

searchSolutionUseCase[]

enum (SearchSolutionUseCase)

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one searchSolutionUseCase per control.

rule

object (Rule)

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

Rule

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.
JSON representation
{
  "condition": {
    object (Condition)
  },

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "onewaySynonymsAction": {
    object (OnewaySynonymsAction)
  },
  "doNotAssociateAction": {
    object (DoNotAssociateAction)
  },
  "replacementAction": {
    object (ReplacementAction)
  },
  "ignoreAction": {
    object (IgnoreAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "twowaySynonymsAction": {
    object (TwowaySynonymsAction)
  }
  // End of list of possible types for union field action.
}
Fields
condition

object (Condition)

Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

Union field action. An action must be provided. action can be only one of the following:
boostAction

object (BoostAction)

A boost action.

redirectAction

object (RedirectAction)

Redirects a shopper to a specific page.

onewaySynonymsAction

object (OnewaySynonymsAction)

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

doNotAssociateAction

object (DoNotAssociateAction)

Prevents term from being associated with other terms.

replacementAction

object (ReplacementAction)

Replaces specific terms in the query.

ignoreAction

object (IgnoreAction)

Ignores specific terms from query during search.

filterAction

object (FilterAction)

Filters results.

twowaySynonymsAction

object (TwowaySynonymsAction)

Treats a set of terms as synonyms of one another.

BoostAction

A boost action to apply to results matching condition specified above.

JSON representation
{
  "boost": number,
  "productsFilter": string
}
Fields
boost

number

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items.

Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.

Setting to 0.0 means no boost applied. The boosting condition is ignored.

productsFilter

string

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

Examples:

  • To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue":
    (id: ANY("product_1", "product_2"))
    AND
    (colorFamilies: ANY("Red", "Blue"))

RedirectAction

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.
JSON representation
{
  "redirectUri": string
}
Fields
redirectUri

string

URL must have length equal or less than 2000 characters.

OnewaySynonymsAction

Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. queryTerms 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".

JSON representation
{
  "queryTerms": [
    string
  ],
  "synonyms": [
    string
  ],
  "onewayTerms": [
    string
  ]
}
Fields
queryTerms[]

string

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

synonyms[]

string

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

onewayTerms[]

string

Will be [deprecated = true] post migration;

DoNotAssociateAction

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

JSON representation
{
  "queryTerms": [
    string
  ],
  "doNotAssociateTerms": [
    string
  ],
  "terms": [
    string
  ]
}
Fields
queryTerms[]

string

Terms from the search query. Will not consider doNotAssociateTerms for search if in search query. Can specify up to 100 terms.

doNotAssociateTerms[]

string

Cannot contain duplicates or the query term. Can specify up to 100 terms.

terms[]

string

Will be [deprecated = true] post migration;

ReplacementAction

Replaces a term in the query. Multiple replacement candidates can be specified. All queryTerms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".

JSON representation
{
  "queryTerms": [
    string
  ],
  "replacementTerm": string,
  "term": string
}
Fields
queryTerms[]

string

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

replacementTerm

string

Term that will be used for replacement.

term

string

Will be [deprecated = true] post migration;

IgnoreAction

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

JSON representation
{
  "ignoreTerms": [
    string
  ]
}
Fields
ignoreTerms[]

string

Terms to ignore in the search query.

FilterAction

  • 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.
JSON representation
{
  "filter": string
}
Fields
filter

string

A filter to apply on the matching condition results. Supported features:

  • filter must be set.
  • Filter syntax is identical to SearchRequest.filter. See more details at the Retail placements.search user guide.
  • To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue":
    (id: ANY("product_1", "product_2"))
    AND
    (colorFamilies: ANY("Red", "Blue"))

TwowaySynonymsAction

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".
JSON representation
{
  "synonyms": [
    string
  ]
}
Fields
synonyms[]

string

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

Condition

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

JSON representation
{
  "queryTerms": [
    {
      object (QueryTerm)
    }
  ],
  "activeTimeRange": [
    {
      object (TimeRange)
    }
  ]
}
Fields
queryTerms[]

object (QueryTerm)

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

activeTimeRange[]

object (TimeRange)

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

QueryTerm

Query terms that we want to match on.

JSON representation
{
  "value": string,
  "fullMatch": boolean
}
Fields
value

string

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

fullMatch

boolean

Whether this is supposed to be a full or partial match.

TimeRange

Used for time-dependent conditions. Example: Want to have rule applied for week long sale.

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Start of time range. Range is inclusive.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

End of time range. Range is inclusive.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

SearchSolutionUseCase

The use case of Cloud Retail placements.search.

Enums
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.
SEARCH_SOLUTION_USE_CASE_BROWSE Browse use case. Expects the traffic has an empty query.

Methods

create

Creates a Control.

delete

Deletes a Control.

get

Gets a Control.

list

Lists all Controls by their parent Catalog.

patch

Updates a Control.