REST Resource: projects.locations.dataStores.controls

Recurso: Control

Define un comportamiento condicionado para emplear durante la publicación. Se debe adjuntar a un ServingConfig para que se tenga en cuenta en el momento de la publicación. Las acciones permitidas dependen de SolutionType.

Representación JSON 
{
  "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.
}
Campos
name

string

Inmutable. Nombre completo projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obligatorio. Nombre legible para personas. Es el identificador que se usa en las vistas de la IU.

Debe ser una cadena codificada en UTF-8. El límite de longitud es de 128 caracteres. De lo contrario, se arroja un error INVALID ARGUMENT.
associatedServingConfigIds[]

string

Solo salida. Es una lista de todos los IDs de ServingConfig a los que se adjunta este control. Puede tardar hasta 10 minutos en actualizarse después de los cambios.
solutionType

enum (SolutionType)

Obligatorio. Inmutable. Es la solución a la que pertenece el control.

Debe ser compatible con la vertical del recurso. De lo contrario, se arroja un error INVALID ARGUMENT.
useCases[]

enum (SearchUseCase)

Especifica el caso de uso del control. Afecta los campos de condición que se pueden establecer. Solo se aplica a SOLUTION_TYPE_SEARCH. Actualmente, solo se permite un caso de uso por control. Se debe establecer cuando solutionType es SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Determina cuándo se activará la acción asociada.

Omítelo para aplicar siempre la acción. Actualmente, solo se puede especificar una condición. De lo contrario, se arroja un error INVALID ARGUMENT.

Campo de unión action. Las acciones están restringidas por Vertical y Solution

Obligatorio. action puede ser una de las siguientes opciones:
boostAction

object (BoostAction)

Define un control de tipo aumento.
filterAction

object (FilterAction)

Define un control de tipo filtro. Actualmente, no es compatible con Recommendation.
redirectAction

object (RedirectAction)

Define un control de tipo redireccionamiento.
synonymsAction

object (SynonymsAction)

Trata un grupo de términos como sinónimos entre sí.
promoteAction

object (PromoteAction)

Promueve ciertos vínculos en función de las consultas de activación predefinidas.

Métodos

create

 Crea un control.

delete

 Borra un control.

get

 Obtiene un control.

list

 Muestra todos los controles por su DataStore superior.

patch

 Actualiza un control.