REST Resource: projects.locations.dataStores.controls

Risorsa: Controllo

Definisce un comportamento condizionato da utilizzare durante la pubblicazione. Per essere considerato al momento della pubblicazione, deve essere collegato a un ServingConfig. Le azioni consentite dipendono da SolutionType.

Rappresentazione 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.
}
Campi
name

string

Immutabile. Nome completo projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obbligatorio. Nome leggibile. L'identificatore utilizzato nelle visualizzazioni dell'interfaccia utente.

Deve essere una stringa con codifica UTF-8. Il limite di lunghezza è di 128 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.
associatedServingConfigIds[]

string

Solo output. Elenco di tutti gli ID ServingConfig a cui è collegato questo controllo. L'aggiornamento dopo le modifiche può richiedere fino a 10 minuti.
solutionType

enum (SolutionType)

Obbligatorio. Immutabile. La soluzione a cui appartiene il controllo.

Deve essere compatibile con la verticale della risorsa. In caso contrario, viene generato un errore INVALID ARGUMENT.
useCases[]

enum (SearchUseCase)

Specifica il caso d'uso per il controllo. Influisce sui campi delle condizioni che possono essere impostati. Si applica solo a SOLUTION_TYPE_SEARCH. Al momento è consentito un solo caso d'uso per controllo. Deve essere impostato quando solutionType è SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Determina quando verrà attivata l'azione associata.

Ometti per applicare sempre l'azione. Al momento è possibile specificare una sola condizione. In caso contrario, viene generato un errore INVALID ARGUMENT.
Di seguito è riportato un elenco di campi che si escludono a vicenda. Al massimo uno dei campi verrà impostato in una risposta:
boostAction

object (BoostAction)

Definisce un controllo di tipo boost
filterAction

object (FilterAction)

Definisce un controllo di tipo filtro. Al momento non è supportato da Recommendation
redirectAction

object (RedirectAction)

Definisce un controllo di tipo reindirizzamento.
synonymsAction

object (SynonymsAction)

Considera un gruppo di termini come sinonimi.
promoteAction

object (PromoteAction)

Promuovi determinati link in base a query di attivazione predefinite.
Fine dei campi che si escludono a vicenda.

Metodi

create

 Crea un controllo.

delete

 Elimina un controllo.

get

 Ottiene un controllo.

list

 Elenca tutti i controlli in base al relativo DataStore padre.

patch

 Aggiorna un controllo.