REST Resource: projects.locations.dataStores.controls

Resource: Control

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType .

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "associatedServingConfigIds" 
 : 
 [ 
 string 
 ] 
 , 
 "solutionType" 
 : 
 enum (  SolutionType 
 
) 
 , 
 "useCases" 
 : 
 [ 
 enum (  SearchUseCase 
 
) 
 ] 
 , 
 "conditions" 
 : 
 [ 
 { 
 object (  Condition 
 
) 
 } 
 ] 
 , 
 // Union field action 
can be only one of the following: 
 "boostAction" 
 : 
 { 
 object (  BoostAction 
 
) 
 } 
 , 
 "filterAction" 
 : 
 { 
 object (  FilterAction 
 
) 
 } 
 , 
 "redirectAction" 
 : 
 { 
 object (  RedirectAction 
 
) 
 } 
 , 
 "synonymsAction" 
 : 
 { 
 object (  SynonymsAction 
 
) 
 } 
 , 
 "promoteAction" 
 : 
 { 
 object (  PromoteAction 
 
) 
 } 
 // End of list of possible types for union field action 
. 
 } 
Fields
name

string

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

displayName

string

Required. Human readable name. The identifier used in UI views.

Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.

associatedServingConfigIds[]

string

Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.

solutionType

enum ( SolutionType )

Required. Immutable. What solution the control belongs to.

Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

useCases[]

enum ( SearchUseCase )

Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH . Currently only allow one use case per control. Must be set when solutionType is SolutionType.SOLUTION_TYPE_SEARCH .

conditions[]

object ( Condition )

Determines when the associated action will trigger.

Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.

Union field action . Actions are restricted by Vertical and Solution

Required. action can be only one of the following:

boostAction

object ( BoostAction )

Defines a boost-type control

filterAction

object ( FilterAction )

Defines a filter-type control Currently not supported by Recommendation

redirectAction

object ( RedirectAction )

Defines a redirect-type control.

synonymsAction

object ( SynonymsAction )

Treats a group of terms as synonyms of one another.

promoteAction

object ( PromoteAction )

Promote certain links based on predefined trigger queries.

Methods

create

Creates a Control.

delete

Deletes a Control.

get

Gets a Control.

list

Lists all Controls by their parent DataStore .

patch

Updates a Control.
Design a Mobile Site
View Site in Mobile | Classic
Share by: