Close httplib2 connections.
create(parent, body=None, controlId=None, x__xgafv=None)
Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
Gets a Control.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Controls by their parent Catalog.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.
close()
Close httplib2 connections.
create(parent, body=None, controlId=None, x__xgafv=None)
Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
Args:
parent: string, Required. Full resource name of parent catalog. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` (required)
body: object, The request body.
The object takes the form of:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
"associatedServingConfigIds": [ # Output only. List of serving config 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.
"A String",
],
"displayName": "A 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.
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
"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. # 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".
"boostAction": { # A boost action to apply to results matching condition specified above. # A boost action.
"boost": 3.14, # 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": "A 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")) *
},
"condition": { # 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. # Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.
"activeTimeRange": [ # Range of time(s) specifying when Condition is active. Condition true if any time range matches.
{ # Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
"endTime": "A String", # End of time range. Range is inclusive.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"pageCategories": [ # Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
"A String",
],
"queryTerms": [ # 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).
{ # Query terms that we want to match on.
"fullMatch": True or False, # Whether this is supposed to be a full or partial match.
"value": "A 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.
},
],
},
"doNotAssociateAction": { # Prevents `query_term` from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap". # Prevents term from being associated with other terms.
"doNotAssociateTerms": [ # Cannot contain duplicates or the query term. Can specify up to 100 terms.
"A String",
],
"queryTerms": [ # Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
"A String",
],
"terms": [ # Will be [deprecated = true] post migration;
"A String",
],
},
"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. # Filters results.
"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * 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")) *
},
"forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request.
"facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.
{ # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
"attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
"position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100.
},
],
},
"ignoreAction": { # Prevents a term in the query from being used in search. Example: Don't search for "shoddy". # Ignores specific terms from query during search.
"ignoreTerms": [ # Terms to ignore in the search query.
"A String",
],
},
"onewaySynonymsAction": { # 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". # Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
"onewayTerms": [ # Will be [deprecated = true] post migration;
"A String",
],
"queryTerms": [ # Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
"A String",
],
"synonyms": [ # Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
"A String",
],
},
"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. # Redirects a shopper to a specific page.
"redirectUri": "A String", # URL must have length equal or less than 2000 characters.
},
"removeFacetAction": { # Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present). # Remove an attribute as a facet in the request (if present).
"attributeNames": [ # The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
"A String",
],
},
"replacementAction": { # 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". # Replaces specific terms in the query.
"queryTerms": [ # Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
"A String",
],
"replacementTerm": "A String", # Term that will be used for replacement.
"term": "A String", # Will be [deprecated = true] post migration;
},
"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". # Treats a set of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
"A String",
],
},
},
"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 search_solution_use_case per control.
"A String",
],
"solutionTypes": [ # 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.
"A String",
],
}
controlId: string, Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
"associatedServingConfigIds": [ # Output only. List of serving config 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.
"A String",
],
"displayName": "A 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.
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
"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. # 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".
"boostAction": { # A boost action to apply to results matching condition specified above. # A boost action.
"boost": 3.14, # 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": "A 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")) *
},
"condition": { # 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. # Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.
"activeTimeRange": [ # Range of time(s) specifying when Condition is active. Condition true if any time range matches.
{ # Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
"endTime": "A String", # End of time range. Range is inclusive.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"pageCategories": [ # Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
"A String",
],
"queryTerms": [ # 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).
{ # Query terms that we want to match on.
"fullMatch": True or False, # Whether this is supposed to be a full or partial match.
"value": "A 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.
},
],
},
"doNotAssociateAction": { # Prevents `query_term` from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap". # Prevents term from being associated with other terms.
"doNotAssociateTerms": [ # Cannot contain duplicates or the query term. Can specify up to 100 terms.
"A String",
],
"queryTerms": [ # Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
"A String",
],
"terms": [ # Will be [deprecated = true] post migration;
"A String",
],
},
"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. # Filters results.
"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * 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")) *
},
"forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request.
"facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.
{ # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
"attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
"position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100.
},
],
},
"ignoreAction": { # Prevents a term in the query from being used in search. Example: Don't search for "shoddy". # Ignores specific terms from query during search.
"ignoreTerms": [ # Terms to ignore in the search query.
"A String",
],
},
"onewaySynonymsAction": { # 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". # Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
"onewayTerms": [ # Will be [deprecated = true] post migration;
"A String",
],
"queryTerms": [ # Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
"A String",
],
"synonyms": [ # Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
"A String",
],
},
"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. # Redirects a shopper to a specific page.
"redirectUri": "A String", # URL must have length equal or less than 2000 characters.
},
"removeFacetAction": { # Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present). # Remove an attribute as a facet in the request (if present).
"attributeNames": [ # The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
"A String",
],
},
"replacementAction": { # 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". # Replaces specific terms in the query.
"queryTerms": [ # Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
"A String",
],
"replacementTerm": "A String", # Term that will be used for replacement.
"term": "A String", # Will be [deprecated = true] post migration;
},
"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". # Treats a set of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
"A String",
],
},
},
"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 search_solution_use_case per control.
"A String",
],
"solutionTypes": [ # 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.
"A String",
],
}
delete(name, x__xgafv=None)
Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
Args:
name: string, Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets a Control.
Args:
name: string, Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
"associatedServingConfigIds": [ # Output only. List of serving config 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.
"A String",
],
"displayName": "A 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.
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
"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. # 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".
"boostAction": { # A boost action to apply to results matching condition specified above. # A boost action.
"boost": 3.14, # 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": "A 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")) *
},
"condition": { # 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. # Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.
"activeTimeRange": [ # Range of time(s) specifying when Condition is active. Condition true if any time range matches.
{ # Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
"endTime": "A String", # End of time range. Range is inclusive.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"pageCategories": [ # Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
"A String",
],
"queryTerms": [ # 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).
{ # Query terms that we want to match on.
"fullMatch": True or False, # Whether this is supposed to be a full or partial match.
"value": "A 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.
},
],
},
"doNotAssociateAction": { # Prevents `query_term` from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap". # Prevents term from being associated with other terms.
"doNotAssociateTerms": [ # Cannot contain duplicates or the query term. Can specify up to 100 terms.
"A String",
],
"queryTerms": [ # Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
"A String",
],
"terms": [ # Will be [deprecated = true] post migration;
"A String",
],
},
"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. # Filters results.
"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * 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")) *
},
"forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request.
"facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.
{ # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
"attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
"position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100.
},
],
},
"ignoreAction": { # Prevents a term in the query from being used in search. Example: Don't search for "shoddy". # Ignores specific terms from query during search.
"ignoreTerms": [ # Terms to ignore in the search query.
"A String",
],
},
"onewaySynonymsAction": { # 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". # Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
"onewayTerms": [ # Will be [deprecated = true] post migration;
"A String",
],
"queryTerms": [ # Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
"A String",
],
"synonyms": [ # Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
"A String",
],
},
"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. # Redirects a shopper to a specific page.
"redirectUri": "A String", # URL must have length equal or less than 2000 characters.
},
"removeFacetAction": { # Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present). # Remove an attribute as a facet in the request (if present).
"attributeNames": [ # The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
"A String",
],
},
"replacementAction": { # 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". # Replaces specific terms in the query.
"queryTerms": [ # Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
"A String",
],
"replacementTerm": "A String", # Term that will be used for replacement.
"term": "A String", # Will be [deprecated = true] post migration;
},
"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". # Treats a set of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
"A String",
],
},
},
"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 search_solution_use_case per control.
"A String",
],
"solutionTypes": [ # 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.
"A String",
],
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Controls by their parent Catalog.
Args:
parent: string, Required. The catalog resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}` (required)
filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListControls method.
"controls": [ # All the Controls for a given catalog.
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
"associatedServingConfigIds": [ # Output only. List of serving config 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.
"A String",
],
"displayName": "A 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.
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
"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. # 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".
"boostAction": { # A boost action to apply to results matching condition specified above. # A boost action.
"boost": 3.14, # 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": "A 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")) *
},
"condition": { # 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. # Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.
"activeTimeRange": [ # Range of time(s) specifying when Condition is active. Condition true if any time range matches.
{ # Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
"endTime": "A String", # End of time range. Range is inclusive.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"pageCategories": [ # Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
"A String",
],
"queryTerms": [ # 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).
{ # Query terms that we want to match on.
"fullMatch": True or False, # Whether this is supposed to be a full or partial match.
"value": "A 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.
},
],
},
"doNotAssociateAction": { # Prevents `query_term` from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap". # Prevents term from being associated with other terms.
"doNotAssociateTerms": [ # Cannot contain duplicates or the query term. Can specify up to 100 terms.
"A String",
],
"queryTerms": [ # Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
"A String",
],
"terms": [ # Will be [deprecated = true] post migration;
"A String",
],
},
"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. # Filters results.
"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * 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")) *
},
"forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request.
"facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.
{ # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
"attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
"position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100.
},
],
},
"ignoreAction": { # Prevents a term in the query from being used in search. Example: Don't search for "shoddy". # Ignores specific terms from query during search.
"ignoreTerms": [ # Terms to ignore in the search query.
"A String",
],
},
"onewaySynonymsAction": { # 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". # Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
"onewayTerms": [ # Will be [deprecated = true] post migration;
"A String",
],
"queryTerms": [ # Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
"A String",
],
"synonyms": [ # Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
"A String",
],
},
"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. # Redirects a shopper to a specific page.
"redirectUri": "A String", # URL must have length equal or less than 2000 characters.
},
"removeFacetAction": { # Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present). # Remove an attribute as a facet in the request (if present).
"attributeNames": [ # The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
"A String",
],
},
"replacementAction": { # 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". # Replaces specific terms in the query.
"queryTerms": [ # Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
"A String",
],
"replacementTerm": "A String", # Term that will be used for replacement.
"term": "A String", # Will be [deprecated = true] post migration;
},
"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". # Treats a set of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
"A String",
],
},
},
"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 search_solution_use_case per control.
"A String",
],
"solutionTypes": [ # 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.
"A String",
],
},
],
"nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.
Args:
name: string, Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*` (required)
body: object, The request body.
The object takes the form of:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
"associatedServingConfigIds": [ # Output only. List of serving config 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.
"A String",
],
"displayName": "A 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.
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
"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. # 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".
"boostAction": { # A boost action to apply to results matching condition specified above. # A boost action.
"boost": 3.14, # 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": "A 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")) *
},
"condition": { # 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. # Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.
"activeTimeRange": [ # Range of time(s) specifying when Condition is active. Condition true if any time range matches.
{ # Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
"endTime": "A String", # End of time range. Range is inclusive.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"pageCategories": [ # Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
"A String",
],
"queryTerms": [ # 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).
{ # Query terms that we want to match on.
"fullMatch": True or False, # Whether this is supposed to be a full or partial match.
"value": "A 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.
},
],
},
"doNotAssociateAction": { # Prevents `query_term` from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap". # Prevents term from being associated with other terms.
"doNotAssociateTerms": [ # Cannot contain duplicates or the query term. Can specify up to 100 terms.
"A String",
],
"queryTerms": [ # Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
"A String",
],
"terms": [ # Will be [deprecated = true] post migration;
"A String",
],
},
"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. # Filters results.
"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * 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")) *
},
"forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request.
"facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.
{ # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
"attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
"position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100.
},
],
},
"ignoreAction": { # Prevents a term in the query from being used in search. Example: Don't search for "shoddy". # Ignores specific terms from query during search.
"ignoreTerms": [ # Terms to ignore in the search query.
"A String",
],
},
"onewaySynonymsAction": { # 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". # Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
"onewayTerms": [ # Will be [deprecated = true] post migration;
"A String",
],
"queryTerms": [ # Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
"A String",
],
"synonyms": [ # Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
"A String",
],
},
"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. # Redirects a shopper to a specific page.
"redirectUri": "A String", # URL must have length equal or less than 2000 characters.
},
"removeFacetAction": { # Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present). # Remove an attribute as a facet in the request (if present).
"attributeNames": [ # The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
"A String",
],
},
"replacementAction": { # 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". # Replaces specific terms in the query.
"queryTerms": [ # Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
"A String",
],
"replacementTerm": "A String", # Term that will be used for replacement.
"term": "A String", # Will be [deprecated = true] post migration;
},
"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". # Treats a set of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
"A String",
],
},
},
"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 search_solution_use_case per control.
"A String",
],
"solutionTypes": [ # 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.
"A String",
],
}
updateMask: string, Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name If not set or empty, all supported fields are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
"associatedServingConfigIds": [ # Output only. List of serving config 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.
"A String",
],
"displayName": "A 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.
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
"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. # 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".
"boostAction": { # A boost action to apply to results matching condition specified above. # A boost action.
"boost": 3.14, # 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": "A 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")) *
},
"condition": { # 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. # Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.
"activeTimeRange": [ # Range of time(s) specifying when Condition is active. Condition true if any time range matches.
{ # Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
"endTime": "A String", # End of time range. Range is inclusive.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"pageCategories": [ # Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
"A String",
],
"queryTerms": [ # 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).
{ # Query terms that we want to match on.
"fullMatch": True or False, # Whether this is supposed to be a full or partial match.
"value": "A 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.
},
],
},
"doNotAssociateAction": { # Prevents `query_term` from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap". # Prevents term from being associated with other terms.
"doNotAssociateTerms": [ # Cannot contain duplicates or the query term. Can specify up to 100 terms.
"A String",
],
"queryTerms": [ # Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
"A String",
],
"terms": [ # Will be [deprecated = true] post migration;
"A String",
],
},
"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. # Filters results.
"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * 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")) *
},
"forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request.
"facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.
{ # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
"attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
"position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100.
},
],
},
"ignoreAction": { # Prevents a term in the query from being used in search. Example: Don't search for "shoddy". # Ignores specific terms from query during search.
"ignoreTerms": [ # Terms to ignore in the search query.
"A String",
],
},
"onewaySynonymsAction": { # 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". # Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
"onewayTerms": [ # Will be [deprecated = true] post migration;
"A String",
],
"queryTerms": [ # Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
"A String",
],
"synonyms": [ # Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
"A String",
],
},
"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. # Redirects a shopper to a specific page.
"redirectUri": "A String", # URL must have length equal or less than 2000 characters.
},
"removeFacetAction": { # Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present). # Remove an attribute as a facet in the request (if present).
"attributeNames": [ # The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
"A String",
],
},
"replacementAction": { # 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". # Replaces specific terms in the query.
"queryTerms": [ # Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
"A String",
],
"replacementTerm": "A String", # Term that will be used for replacement.
"term": "A String", # Will be [deprecated = true] post migration;
},
"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". # Treats a set of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
"A String",
],
},
},
"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 search_solution_use_case per control.
"A String",
],
"solutionTypes": [ # 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.
"A String",
],
}