REST Resource: projects.locations.dataStores.controls

Recurso: Control

Define um comportamento condicionado a ser usado durante a exibição. Precisa ser anexado a um ServingConfig para ser considerado no momento da exibição. Ações permitidas dependem de SolutionType.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of mutually exclusive fields.
}
Campos
name

string

Imutável. Nome totalmente qualificado projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obrigatório. Nome legível. O identificador usado nas visualizações da UI.

Precisa ser uma string codificada em UTF-8. O limite de comprimento é de 128 caracteres. Caso contrário, um erro de argumento inválido será gerado.
associatedServingConfigIds[]

string

Apenas saída. Lista de todos os IDs de ServingConfig a que esse controle está anexado. Pode levar até 10 minutos para atualizar após as mudanças.
solutionType

enum (SolutionType)

Obrigatório. Imutável. A qual solução o controle pertence.

Precisa ser compatível com a vertical do recurso. Caso contrário, um erro de argumento inválido será gerado.
useCases[]

enum (SearchUseCase)

Especifica o caso de uso do controle. Afeta quais campos de condição podem ser definidos. Só se aplica a SOLUTION_TYPE_SEARCH. Atualmente, só é permitido um caso de uso por controle. Precisa ser definido quando solutionType é SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Determina quando a ação associada será acionada.

Omita para sempre aplicar a ação. Atualmente, apenas uma condição pode ser especificada. Caso contrário, um erro de argumento inválido será gerado.
A seguir, uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
boostAction

object (BoostAction)

Define um controle do tipo "aumento"
filterAction

object (FilterAction)

Define um controle do tipo "filtro". Atualmente indisponível para a recomendação
redirectAction

object (RedirectAction)

Define um controle do tipo "redirecionamento".
synonymsAction

object (SynonymsAction)

Trata um grupo de termos como sinônimos.
promoteAction

object (PromoteAction)

Promove determinados links com base em consultas de acionamento predefinidas.
Fim dos campos mutuamente exclusivos.

Métodos

create

 Cria um controle.

delete

 Exclui um controle.

get

 Recebe um controle.

list

 Lista todos os controles pelo DataStore pai.

patch

 Atualiza um controle.