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

Recurso: controlo

Define um comportamento condicionado a usar durante a publicação. Tem de estar associado a um ServingConfig para ser considerado no momento da publicação. Ações permitidas dependentes de SolutionType.

Representação 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

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

string

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

Tem de ser uma string codificada em UTF-8. O limite de comprimento é de 128 carateres. Caso contrário, é gerado um erro INVALID ARGUMENT.
associatedServingConfigIds[]

string

Apenas saída. Lista de todos os IDs de ServingConfig aos quais este controlo está anexado. A atualização pode demorar até 10 minutos após as alterações.
solutionType

enum (SolutionType)

Obrigatório. Imutável. A que solução pertence o controlo.

Tem de ser compatível com o vertical do recurso. Caso contrário, é gerado um erro INVALID ARGUMENT.
useCases[]

enum (SearchUseCase)

Especifica o exemplo de utilização do controlo. Afeta os campos de condições que podem ser definidos. Aplica-se apenas a SOLUTION_TYPE_SEARCH. Atualmente, só é permitido um exemplo de utilização por controlo. Tem de ser definido quando solutionType é SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Determina quando a ação associada é acionada.

Omita para aplicar sempre a ação. Atualmente, só é possível especificar uma condição. Caso contrário, é gerado um erro INVALID ARGUMENT.

Campo de união action. As ações estão restritas por vertical e solução

Obrigatório. action só pode ser uma das seguintes opções:
boostAction

object (BoostAction)

Define um controlo do tipo aumento
filterAction

object (FilterAction)

Define um controlo do tipo de filtro. Atualmente, não é suportado pela recomendação
redirectAction

object (RedirectAction)

Define um controlo do tipo redirecionamento.
synonymsAction

object (SynonymsAction)

Trata um grupo de termos como sinónimos entre si.
promoteAction

object (PromoteAction)

Promova determinados links com base em consultas de acionamento predefinidas.

Métodos

create

 Cria um controlo.

delete

 Elimina um controlo.

get

 Obtém um controlo.

list

 Lista todos os controlos pelo respetivo elemento principal DataStore.

patch

 Atualiza um controlo.