REST Resource: projects.locations.dataStores.controls

Ressourcen: Steuerelement

Definiert ein bedingtes Verhalten, das bei der Bereitstellung verwendet werden soll. Muss an eine ServingConfig angehängt sein, damit es bei der Bereitstellung berücksichtigt wird. Zulässige Aktionen in Abhängigkeit von SolutionType.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Nicht veränderbar. Voll qualifizierter Name projects/*/locations/global/dataStore/*/controls/*
displayName

string

Erforderlich. Menschenlesbarer Name. Die in UI-Ansichten verwendete Kennung.

Muss ein UTF-8-codierter String sein. Die maximale Länge beträgt 128 Zeichen. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
associatedServingConfigIds[]

string

Nur Ausgabe. Liste aller ServingConfig-IDs, an die dieses Steuerelement angehängt ist. Nach Änderungen kann es bis zu 10 Minuten dauern, bis die Aktualisierung erfolgt.
solutionType

enum (SolutionType)

Erforderlich. Nicht veränderbar. Zu welcher Lösung das Steuerelement gehört.

Muss mit dem Ressourcentyp kompatibel sein. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
useCases[]

enum (SearchUseCase)

Gibt den Anwendungsfall für das Steuerelement an. Wirkt sich darauf aus, welche Bedingungsfelder festgelegt werden können. Gilt nur für SOLUTION_TYPE_SEARCH. Derzeit ist nur ein Anwendungsfall pro Steuerelement zulässig. Muss festgelegt werden, wenn „solutionType“ SolutionType.SOLUTION_TYPE_SEARCH ist.
conditions[]

object (Condition)

Bestimmt, wann die zugehörige Aktion ausgelöst wird.

Lassen Sie das Feld leer, um die Aktion immer anzuwenden. Derzeit kann nur eine Bedingung angegeben werden. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

Union-Feld action. Aktionen sind nach Ressourcentyp und Lösung eingeschränkt.

Erforderlich. Für action ist nur einer der folgenden Werte zulässig:
boostAction

object (BoostAction)

Definiert ein Steuerelement vom Typ „Boost“
filterAction

object (FilterAction)

Definiert ein Steuerelement vom Typ „Filter“. Wird derzeit nicht von Recommendation unterstützt.
redirectAction

object (RedirectAction)

Definiert ein Steuerelement vom Typ „Weiterleitung“.
synonymsAction

object (SynonymsAction)

Behandelt eine Gruppe von Begriffen als Synonyme.
promoteAction

object (PromoteAction)

Bestimmte Links auf Grundlage vordefinierter Triggerabfragen hervorheben.

Methoden

create

 Erstellt ein Steuerelement.

delete

 Löscht ein Steuerelement.

get

 Ruft ein Steuerelement ab.

list

 Listet alle Steuerelemente nach ihrem übergeordneten Element DataStore auf.

patch

 Aktualisiert ein Steuerelement.