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

Ressourcen: Steuerelement

Definiert ein bedingtes Verhalten, das bei der Bereitstellung verwendet werden soll. Muss an ein 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 Triggeranfragen hervorheben.

BoostAction

Passt die Reihenfolge der Produkte in der zurückgegebenen Liste an.

JSON-Darstellung 
{
  "boost": number,
  "filter": string,
  "dataStore": string,

  // Union field boost_spec can be only one of the following:
  "fixedBoost": number,
  "interpolationBoostSpec": {
    object (InterpolationBoostSpec)
  }
  // End of list of possible types for union field boost_spec.
}
Felder
boost
(deprecated)

number

Stärke des Boostings, das im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0 (No-op).
filter

string

Erforderlich. Gibt an, auf welche Produkte der Boost angewendet werden soll.

Wenn kein Filter angegeben ist, wird ein Boost auf alle Produkte angewendet (No-op). Dokumentation zur Syntax: https://cloud.google.com/retail/docs/filter-and-order. Die maximale Länge beträgt 5.000 Zeichen. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
dataStore

string

Erforderlich. Gibt an, welche Dokumente des Datenspeichers durch diese Einstellung einen Boost erhalten können. Vollständiger Name des Datenspeichers, z. B. „projects/123/locations/global/collections/default_collection/dataStores/default_data_store“
Union-Feld boost_spec. Spezifizierung eines konstanten Wert-Boosts oder eines benutzerdefinierten Ranking-basierten Boosts. Für boost_spec ist nur einer der folgenden Werte zulässig:
fixedBoost

number

Optional. Stärke des Boostings, das im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0 (No-op).
interpolationBoostSpec

object (InterpolationBoostSpec)

Optional. Komplexe Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden definierten Attributwert.

InterpolationBoostSpec

Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden angegebenen Attributwert. Sie bietet mehr Steuerungsmöglichkeiten für das benutzerdefinierte Ranking als die oben genannte einfache Kombination aus „Bedingung“ und „Boost“ oben.

JSON-Darstellung 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Felder
fieldName

string

Optional. Der Name des Feldes, dessen Wert zur Bestimmung des Boost-Betrags verwendet wird.
attributeType

enum (AttributeType)

Optional. Der Attributtyp, der zum Ermitteln des Boost-Betrags verwendet werden soll. Der Attributwert kann aus dem Feldwert des angegebenen „fieldName“ abgeleitet werden. Bei numerischen Werten ist das ganz einfach: attributeValue = numerical_field_value. Bei der Aktualität gilt jedoch: attributeValue = (time.now() – datetime_field_value).
interpolationType

enum (InterpolationType)

Optional. Der Interpolationstyp, der zum Verbinden der unten aufgeführten Kontrollpunkte verwendet wird.
controlPoints[]

object (ControlPoint)

Optional. Die Kontrollpunkte, mit denen die Kurve definiert wird. Die monotone Funktion (die oben über „interpolationType“ definiert wurde) geht durch die hier aufgeführten Kontrollpunkte.

AttributeType

Das Attribut (oder die Funktion), auf das bzw. die das benutzerdefinierte Ranking angewendet werden soll.

Enums
ATTRIBUTE_TYPE_UNSPECIFIED Nicht angegebener AttributeType.
NUMERICAL Der Wert des numerischen Felds wird verwendet, um den Boost-Betrag dynamisch zu aktualisieren. In diesem Fall ist der „attributeValue“ (der x-Wert) des Kontrollpunkts der tatsächliche Wert des numerischen Felds, für das „boostAmount“ definiert ist.
FRESHNESS Im Anwendungsfall „Aktualität“ ist der Attributwert die Zeitspanne zwischen der aktuellen Uhrzeit und dem Datum im angegebenen Datums-/Uhrzeitfeld. Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]]. Zum Beispiel 5D, 3DT12H30M, T24H.

InterpolationType

Anzuwendender Interpolationstyp. Der Standardwert ist „linear“ (Piecewise Linear).

Enums
INTERPOLATION_TYPE_UNSPECIFIED Der Interpolationstyp ist nicht angegeben. In diesem Fall wird standardmäßig der Typ „Linear“ verwendet.
LINEAR Die „PiecewiseLinear“-Interpolation wird angewendet.

ControlPoint

Die Kontrollpunkte, mit denen die Kurve definiert wird. Die durch diese Kontrollpunkte definierte Kurve kann nur monoton steigend oder fallend sein (konstante Werte sind zulässig).

JSON-Darstellung 
{
  "attributeValue": string,
  "boostAmount": number
}
Felder
attributeValue

string

Optional. Kann einer der folgenden Werte sein: 1. Der numerische Feldwert. 2. Die Dauerangabe für die Aktualität: Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]].
boostAmount

number

Optional. Der Wert zwischen -1 und 1, der angibt, um wieviel die Punktzahl erhöht werden soll, wenn „attributeValue“ dem oben angegebenen Wert entspricht.

FilterAction

Gibt an, welche Produkte in die Ergebnisse aufgenommen werden. Verwendet denselben Filter wie das Boosting.

JSON-Darstellung 
{
  "filter": string,
  "dataStore": string
}
Felder
filter

string

Erforderlich. Ein Filter, der auf die Ergebnisse der passenden Bedingung angewendet werden soll.

Erforderliche Dokumentation zur Syntax: https://cloud.google.com/retail/docs/filter-and-order. Die maximale Länge beträgt 5.000 Zeichen. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
dataStore

string

Erforderlich. Gibt an, welche Dokumente des Datenspeichers durch diese Einstellung gefiltert werden können. Vollständiger Name des Datenspeichers, z. B. „projects/123/locations/global/collections/default_collection/dataStores/default_data_store“

RedirectAction

Leitet einen Käufer an den angegebenen URI weiter.

JSON-Darstellung 
{
  "redirectUri": string
}
Felder
redirectUri

string

Erforderlich. Der URI, zu dem der Käufer weitergeleitet wird.

Erforderlich. Der URI darf maximal 2.000 Zeichen lang sein. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

SynonymsAction

Erstellt eine Gruppe von Begriffen, die als Synonyme fungieren.

Beispiel: „happy“ wird auch als „glad“ und „glad“ auch als „happy“ betrachtet.

JSON-Darstellung 
{
  "synonyms": [
    string
  ]
}
Felder
synonyms[]

string

Definiert eine Gruppe von Synonymen. Sie können bis zu 100 Synonyme angeben. Es müssen mindestens zwei Synonyme angegeben werden. Andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

PromoteAction

Bestimmte Links auf Grundlage bestimmter Triggeranfragen bewerben.

Beispiel: Link zum Schuhgeschäft bewerben, wenn nach dem Keyword shoe gesucht wird. Der Link kann sich außerhalb des zugehörigen Datenspeichers befinden.

JSON-Darstellung 
{
  "dataStore": string,
  "searchLinkPromotion": {
    object (SearchLinkPromotion)
  }
}
Felder
dataStore

string

Erforderlich. Datenspeicher, dem dieses Angebot zugeordnet ist.

SearchLinkPromotion

Das Angebots-Proto enthält den URI und andere hilfreiche Informationen zum Anzeigen des Angebots.

JSON-Darstellung 
{
  "title": string,
  "uri": string,
  "document": string,
  "imageUri": string,
  "description": string,
  "enabled": boolean
}
Felder
title

string

Erforderlich. Der Titel des Angebots. Maximale Länge: 160 Zeichen.
uri

string

Optional. Die URL der Seite, die der Nutzer bewerben möchte. Muss für die Websitesuche festgelegt werden. Für andere Branchen ist das optional.
document

string

Optional. Das Document, das der Nutzer bewerben möchte. Lassen Sie das Feld für die Website-Suche leer und geben Sie nur „uri“ an. Kann zusammen mit „uri“ festgelegt werden.
imageUri

string

Optional. Die URL der Miniaturansicht für das Angebot.
description

string

Optional. Die Beschreibung des Angebots. Maximale Länge: 200 Zeichen.
enabled

boolean

Optional. Das aktivierte Angebot wird für alle Bereitstellungskonfigurationen zurückgegeben, die mit dem übergeordneten Element des Steuerelements verknüpft sind, an die dieses Angebot angehängt ist.

Dieses Flag wird nur für die einfache Website-Suche verwendet.

SearchUseCase

Definiert eine weitere Unterteilung von SolutionType. Gilt speziell für SOLUTION_TYPE_SEARCH.

Enums
SEARCH_USE_CASE_UNSPECIFIED Wert, der verwendet wird, wenn er nicht festgelegt ist. Gilt nicht für CSS.
SEARCH_USE_CASE_BROWSE Anwendungsfall für das Durchsuchen. Erwartet, dass der Traffic eine leere query hat.

Bedingung

Definiert Umstände, die geprüft werden müssen, bevor ein Verhalten zugelassen wird

JSON-Darstellung 
{
  "queryTerms": [
    {
      object (QueryTerm)
    }
  ],
  "activeTimeRange": [
    {
      object (TimeRange)
    }
  ],
  "queryRegex": string
}
Felder
queryTerms[]

object (QueryTerm)

Nur Suche: Eine Liste mit Begriffen, die mit der Anfrage übereinstimmen sollen. Kann nicht festgelegt werden, wenn Condition.query_regex festgelegt ist.

Maximal 10 Suchbegriffe.
activeTimeRange[]

object (TimeRange)

Zeitbereich(e), der angibt, wann die Bedingung aktiv ist.

Maximal 10 Zeiträume.
queryRegex

string

Optional. Regulärer Ausdruck für die Abfrage, der mit der gesamten Suchanfrage übereinstimmen muss. Kann nicht festgelegt werden, wenn Condition.query_terms festgelegt ist. Nur für die Steuerelemente für die Bereitstellung von Werbeaktionen für die einfache Websitesuche unterstützt.

QueryTerm

Matcher für die Abfrage der Suchanfrage

JSON-Darstellung 
{
  "value": string,
  "fullMatch": boolean
}
Felder
value

string

Der spezifische Abfragewert, mit dem abgeglichen werden soll

Muss in Kleinbuchstaben und UTF-8-codiert sein. Darf höchstens drei durch Leerzeichen getrennte Begriffe enthalten, wenn „fullMatch“ auf „true“ gesetzt wurde. Darf kein leerer String sein. Maximale Länge von 5.000 Zeichen
fullMatch

boolean

Gibt an, ob die Suchanfrage genau mit dem Abfragebegriff übereinstimmen muss.

TimeRange

Wird für zeitabhängige Bedingungen verwendet.

JSON-Darstellung 
{
  "startTime": string,
  "endTime": string
}
Felder
startTime

string (Timestamp format)

Beginn des Zeitraums.

Der Bereich ist inklusiv.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Ende des Zeitraums.

Der Bereich ist inklusiv. Muss in der Zukunft liegen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

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.