serving_configs_control

Creates, updates, deletes, gets or lists a serving_configs_control resource.

Overview

Name	serving_configs_control
Type	Resource
Id	google.retail.serving_configs_control

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_catalogs_serving_configs_add_control	insert	projectsId, locationsId, catalogsId, servingConfigsId		Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.
projects_locations_catalogs_serving_configs_remove_control	delete	projectsId, locationsId, catalogsId, servingConfigsId		Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalogsId	string
locationsId	string
projectsId	string
servingConfigsId	string

INSERT examples

projects_locations_catalogs_serving_configs_add_control

Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

INSERT INTO google.retail.serving_configs_control (
data__controlId,
projectsId,
locationsId,
catalogsId,
servingConfigsId
)
SELECT 
'{{ controlId }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ catalogsId }}',
'{{ servingConfigsId }}'
RETURNING
name,
boostControlIds,
displayName,
diversityLevel,
diversityType,
doNotAssociateControlIds,
dynamicFacetSpec,
enableCategoryFilterLevel,
facetControlIds,
filterControlIds,
ignoreControlIds,
ignoreRecsDenylist,
modelId,
onewaySynonymsControlIds,
personalizationSpec,
priceRerankingLevel,
redirectControlIds,
replacementControlIds,
solutionTypes,
twowaySynonymsControlIds
;

Manifest

# Description fields are for documentation purposes
- name: serving_configs_control
  props:
    - name: projectsId
      value: string
      description: Required parameter for the serving_configs_control resource.
    - name: locationsId
      value: string
      description: Required parameter for the serving_configs_control resource.
    - name: catalogsId
      value: string
      description: Required parameter for the serving_configs_control resource.
    - name: servingConfigsId
      value: string
      description: Required parameter for the serving_configs_control resource.
    - name: controlId
      value: string
      description: >
        Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.
        

DELETE examples

projects_locations_catalogs_serving_configs_remove_control

Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

DELETE FROM google.retail.serving_configs_control
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND catalogsId = '{{ catalogsId }}' --required
AND servingConfigsId = '{{ servingConfigsId }}' --required;