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

Recurso: Control

Define un comportamiento condicionado que se debe emplear durante el servicio. Debe estar adjunto a un ServingConfig para tenerse en cuenta en el momento de la publicación. Acciones permitidas en función 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. El identificador que se usa en las vistas de la interfaz de usuario.

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

string

Solo de salida. Lista de todos los IDs de ServingConfig a los que está asociado este control. Los cambios pueden tardar hasta 10 minutos en aplicarse.
solutionType

enum (SolutionType)

Obligatorio. Inmutable. A qué solución pertenece el control.

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

enum (SearchUseCase)

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

object (Condition)

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

Omite este paso para aplicar siempre la acción. Actualmente, solo se puede especificar una condición. De lo contrario, se producirá un error INVALID ARGUMENT.

Campo de unión action. Las acciones están restringidas por vertical y solución

Obligatorio. action solo puede ser una de estas dos opciones:
boostAction

object (BoostAction)

Define un control de tipo de aumento.
filterAction

object (FilterAction)

Define un control de tipo de filtro. Actualmente no es compatible con Recomendación.
redirectAction

object (RedirectAction)

Define un control de tipo de redirección.
synonymsAction

object (SynonymsAction)

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

object (PromoteAction)

Promocionar determinados enlaces en función de consultas de activación predefinidas.

Métodos

create

 Crea un recurso Control.

delete

 Elimina un recurso Control.

get

 Obtiene un recurso Control.

list

 Enumera todos los controles por su DataStore principal.

patch

 Actualiza un recurso Control.