REST Resource: settings.searchapplications

Ressource: SearchApplication

SearchApplication

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
Felder
name

string

Der Name der Suchanwendung.

Format: searchapplications/{applicationId}.

displayName

string

Anzeigename der Suchanwendung Die maximale Länge beträgt 300 Zeichen.

dataSourceRestrictions[]

object (DataSourceRestriction)

Auf die Konfigurationen angewendete Einschränkungen. Es sind maximal 10 Elemente zulässig.

sourceConfig[]

object (SourceConfig)

Konfiguration für eine Quelle, die in dataSourceRestrictions angegeben ist.

scoringConfig

object (ScoringConfig)

Konfiguration für das Ranking von Ergebnissen.

defaultSortOptions

object (SortOptions)

Standardoptionen zum Sortieren der Suchergebnisse

defaultFacetOptions[]

object (FacetOptions)

Die Standardfelder für die Rückgabe von Attributergebnissen. Die hier angegebenen Quellen wurden auch oben in dataSourceRestrictions aufgenommen.

returnResultThumbnailUrls

boolean

Bei jedem Ergebnis sollte der URI für die Miniaturansicht zurückgegeben werden (falls zutreffend).

operationIds[]

string

Nur Ausgabe IDs der lang andauernden Vorgänge, die derzeit für dieses Schema ausgeführt werden. Nur Ausgabefeld.

enableAuditLog

boolean

Gibt an, ob das Audit-Logging für Anfragen an die Suchanwendung in Abfrage-APIs aktiviert/deaktiviert ist.

queryInterpretationConfig

object (QueryInterpretationConfig)

Standardoptionen für die Abfrageinterpretation

DataSourceRestriction

Beschränkung für Datenquelle.

JSON-Darstellung
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Felder
source

object (Source)

Die Quelle der Einschränkung.

filterOptions[]

object (FilterOptions)

Filteroptionen, die die Ergebnisse einschränken. Sind mehrere Filter vorhanden, werden sie vor dem Zusammenführen nach Objekttyp gruppiert. Filter mit demselben Objekttyp werden konjunktiv verknüpft, dann werden die resultierenden Ausdrücke disjunktiv verknüpft.

Es sind maximal 20 Elemente zulässig.

HINWEIS: Die Google Suggest API unterstützt derzeit nur die folgenden Filter: „objecttype“, „type“ und „mimetype“. Derzeit können schemaspezifische Filter nicht zum Filtern von Vorschlägen verwendet werden.

Quelle

Definiert Quellen für die Suggest/Search APIs.

JSON-Darstellung
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
Felder

Union-Feld source.

Für source ist nur einer der folgenden Werte zulässig:

name

string

Name der Quelle für Inhalte, die von Indexing API indexiert wurden.

predefinedSource

enum (Source.PredefinedSource)

Vordefinierte Inhaltsquelle für Google Apps.

Source.PredefinedSource

Vordefinierte Quellen:

Enums
NONE
QUERY_HISTORY Schlägt Suchanfragen vor, die vom Nutzer in der Vergangenheit gestellt wurden. Nur gültig in Verbindung mit der Suggest API. Wird bei Verwendung in der Query API ignoriert.
PERSON Personen in der Organisation vorschlagen. Nur gültig in Verbindung mit der Suggest API. Führt bei Verwendung in der Abfrage-API zu einem Fehler.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Filteroptionen, die auf die Abfrage angewendet werden.

JSON-Darstellung
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Felder
objectType

string

Wenn „objectType“ festgelegt ist, werden nur Objekte dieses Typs zurückgegeben. Dieser sollte dem Namen des Objekts entsprechen, das in der Definition des Schemas registriert wurde. Die maximale Länge beträgt 256 Zeichen.

filter

object (Filter)

Generischer Filter zum Einschränken der Suche, z. B. lang:en, site:xyz.

Filtern

Generische Form von Filtern in einer Abfrage, die zwei Ansätze unterstützt:

1. Einen ValueFilter festlegen. Der Name muss mit einem OperatorName übereinstimmen, der im Schema für Ihre Datenquelle definiert ist.

2. CompositeFilter festlegen. Die Filter werden mit dem logischen Operator ausgewertet. Die Operatoren der obersten Ebene können nur AND oder NOT sein. UND kann nur auf der obersten Ebene erscheinen. ODER darf nur unter einem UND auf oberster Ebene erscheinen.

JSON-Darstellung
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
Felder

Union-Feld filter.

Für filter ist nur einer der folgenden Werte zulässig:

valueFilter

object (Filter.ValueFilter)

compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

JSON-Darstellung
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Felder
operatorName

string

Der auf die Abfrage angewendete operatorName, z. B. price_greater_than. Der Filter kann für beide Arten von Filtern verwendet werden, die im Schema für Ihre Datenquelle definiert sind:

  1. operatorName, wobei die Abfrage die Ergebnisse nach dem Attribut filtert, das dem Wert entspricht.

  2. greaterThanOperatorName oder lessThanOperatorName in Ihrem Schema. Die Abfrage filtert die Ergebnisse für die Attributwerte, die größer oder kleiner als der in der Abfrage angegebene Wert sind.

value

object (Value)

Wert, mit dem verglichen werden soll

Wert

Definition eines einzelnen Werts mit generischem Typ.

JSON-Darstellung
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Felder
Union-Feld value. Der Wert der benannten Eigenschaft. Für value ist nur einer der folgenden Werte zulässig:
stringValue

string

integerValue

string (int64 format)

doubleValue

number

timestampValue

string (Timestamp format)

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

booleanValue

boolean

dateValue

object (Date)

Filter.CompositeFilter

JSON-Darstellung
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Felder
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Der logische Operator des Unterfilters.

subFilters[]

object (Filter)

Untergeordnete Filter.

Filter.CompositeFilter.LogicOperator

Enums
AND Logische Operatoren, die nur auf untergeordnete Filter angewendet werden können.
OR
NOT NOT kann nur auf einen einzelnen Unterfilter angewendet werden.

SourceConfig

Konfigurationen für eine Quelle während der Verarbeitung einer query.search- oder query.suggest-Anfrage.

JSON-Darstellung
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Felder
source

object (Source)

Die Quelle, für die diese Konfiguration verwendet werden soll.

scoringConfig

object (SourceScoringConfig)

Die Bewertungskonfiguration für die Quelle.

crowdingConfig

object (SourceCrowdingConfig)

Die Crowding-Konfiguration für die Quelle.

SourceScoringConfig

Legen Sie die Bewertungskonfiguration fest. Dadurch kann das Ranking der Ergebnisse für eine Quelle geändert werden.

JSON-Darstellung
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Felder
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Bedeutung der Quelle.

SourceScoringConfig.SourceImportance

Die Wichtigkeit einer Quelle, anhand derer angegeben werden kann, ob einer Quelle im Vergleich zu einer anderen Quelle mehr Priorität beim Ranking eingeräumt werden sollte.

Enums
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Sie können Beschränkungen für die Anzahl der Suchergebnisse festlegen. Crowding bedeutet, dass mehrere Ergebnisse aus derselben Quelle oder aus demselben Host andere Ergebnisse „verdrängen“, was die Qualität der Suche für Nutzer vermindert. Um die Suchqualität und die Quellenvielfalt in den Suchergebnissen zu verbessern, können Sie eine Bedingung festlegen, um wiederholte Ergebnisse nach Quelle zu reduzieren.

JSON-Darstellung
{
  "numResults": integer,
  "numSuggestions": integer
}
Felder
numResults

integer

Maximal zulässige Anzahl von Ergebnissen von einer Datenquelle in einer Ergebnisseite, solange Ergebnisse aus anderen Quellen nicht erschöpft sind. Der angegebene Wert darf nicht negativ sein. Ist dieser Wert gleich 0, wird ein Standardwert verwendet. Um die Mengenbeschränkung zu deaktivieren, legen Sie einen Wert größer als 100 fest.

numSuggestions

integer

Maximal zulässige Anzahl von Vorschlägen einer Quelle. Wenn dieser Wert kleiner oder gleich 0 ist, werden keine Grenzwerte für Ergebnisse festgelegt.

ScoringConfig

Bewertungskonfigurationen für eine Quelle während der Verarbeitung einer query.search- oder query.suggest-Anfrage.

JSON-Darstellung
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Felder
disableFreshness

boolean

Gibt an, ob die Aktualität als Ranking-Signal verwendet werden soll. Standardmäßig wird die Aktualität als Ranking-Signal verwendet. Diese Einstellung ist in der Admin-Benutzeroberfläche nicht verfügbar.

disablePersonalization

boolean

Gibt an, ob die Ergebnisse personalisiert werden sollen. Standardmäßig werden persönliche Signale verwendet, um bessere Ergebnisse zu erzielen.

SortOptions

JSON-Darstellung
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Felder
operatorName

string

Der Name des Operators für das Feld, nach dem sortiert werden soll. Die entsprechende Property muss als sortable gekennzeichnet sein.

sortOrder

enum (SortOptions.SortOrder)

„Aufsteigend“ ist die Standardsortierreihenfolge.

SortOptions.SortOrder

Enums
ASCENDING
DESCENDING

FacetOptions

Gibt Operatoren an, für die Attributergebnisse zurückgegeben werden sollen. Es gibt ein FacetResult für jede sourceName/objectType/operatorName-Kombination.

JSON-Darstellung
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Felder
sourceName

string

Quellname, für den das Attribut aktiviert werden soll. Format: datasources/{sourceId}. Wenn dieses Feld leer ist, werden alle Datenquellen verwendet.

objectType

string

Wenn „objectType“ festgelegt ist, werden nur die Objekte dieses Typs zum Berechnen von Attributen verwendet. Wenn dieses Feld leer ist, werden alle Objekte zum Berechnen von Attributen verwendet.

operatorName

string

Der Name des für die Facettierung ausgewählten Operators. @see cloudsearch.SchemaPropertyOptions

numFacetBuckets

integer

Maximale Anzahl von Attribut-Buckets, die für dieses Attribut zurückgegeben werden sollen. Der Standardwert ist 10. Der Höchstwert ist 100.

integerFacetingOptions

object (IntegerFacetingOptions)

Wenn festgelegt, werden Ganzzahl-Facet-Optionen für das angegebene Ganzzahlattribut beschrieben. Das entsprechende Ganzzahlattribut im Schema sollte als „isFacetable“ gekennzeichnet sein. Die Anzahl der zurückgegebenen Buckets würde aus diesem und numFacetBuckets mindestens bestehen.

IntegerFacetingOptions

Wird zum Angeben von Ganzzahl-Facet-Optionen verwendet.

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

string (Int64Value format)

Buckets für bestimmte Ganzzahlwerte sollten in streng aufsteigender Reihenfolge angeordnet werden. Wenn die angegebenen Werte beispielsweise (1,5,10,100) sind, werden die folgenden Facetten-Buckets gebildet {<1, [1,5), [5–10), [10–100), >=100}.

QueryInterpretationConfig

Standardoptionen zum Interpretieren der Nutzerabfrage.

JSON-Darstellung
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Felder
forceVerbatimMode

boolean

Aktivieren Sie dieses Flag, um alle internen Optimierungen wie die Interpretation von Suchanfragen in natürlicher Sprache (NL), das Abrufen zusätzlicher Ergebnisse und die Verwendung von Synonymen, einschließlich benutzerdefinierter, zu deaktivieren. Wenn dieses Flag auf „True“ gesetzt ist, hat es Vorrang vor der Option auf Abfrageebene. Ist der Standardwert „False“ festgelegt, wird mit dem Flag auf Abfrageebene die korrekte Interpretation für den wörtlichen Modus festgelegt.

forceDisableSupplementalResults

boolean

Setzen Sie dieses Flag, um das Abrufen zusätzlicher Ergebnisse zu deaktivieren. Wenn Sie hier ein Flag festlegen, werden keine zusätzlichen Ergebnisse für Suchanfragen abgerufen, die mit einer bestimmten Suchanwendung verknüpft sind. Wenn dieses Flag auf „True“ gesetzt ist, hat es Vorrang vor der Option auf Abfrageebene. Ist der Standardwert „False“ festgelegt, wird durch das Flag auf Abfrageebene die richtige Interpretation für zusätzliche Ergebnisse festgelegt.

Methoden

create

Erstellt eine Suchanwendung.

delete

Löscht eine Suchanwendung.

get

Ruft die angegebene Suchanwendung ab.

list

Listet alle Suchanwendungen auf.

patch

Aktualisiert eine Suchanwendung.

reset

Setzt eine Suchanwendung auf die Standardeinstellungen zurück.

update

Aktualisiert eine Suchanwendung.