REST Resource: projects.locations.collections.engines.controls

Recurso: Control

Define un comportamiento condicionado que se debe emplear durante la entrega. Debe estar adjunto a un ServingConfig para que se tenga en cuenta en el momento de la publicación. Acciones permitidas que 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 completamente calificado projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obligatorio. Es el nombre legible. 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 la lista de todos los IDs de ServingConfig a los que se adjunta este control. La actualización puede tardar hasta 10 minutos después de los cambios.
solutionType

enum (SolutionType)

Obligatorio. Inmutable. 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.

Si se omite, la acción se aplicará siempre. 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 solución

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

object (BoostAction)

Define un control de tipo refuerzo
filterAction

object (FilterAction)

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

object (RedirectAction)

Define un control de tipo redireccionamiento.
synonymsAction

object (SynonymsAction)

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

object (PromoteAction)

Promocionar ciertos vínculos según búsquedas de activación predefinidas

Métodos

create

 Crea un Control.

delete

 Borra un control.

get

 Obtiene un Control.

list

 Enumera todos los controles por su DataStore principal.

patch

 Actualiza un control.