- Ressource: Element
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ItemAcl
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ItemAcl.AclInheritanceType
- Hauptkonto
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ItemMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Interaktion
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Interaction.InteractionType
- SearchQualityMetadata
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ContextAttribute
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ItemStructuredData
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- StructuredDataObject
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.IntegerValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.DoubleValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.TimestampValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.ObjectValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.EnumValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.DateValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.TextValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- NamedProperty.HtmlValues
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ItemContent
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ItemContent.ContentFormat
- UploadItemRef
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ItemStatus
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ProcessingError
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ProcessingErrorCode
- FieldViolation
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- RepositoryError
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- RepositoryError.Type
- Item.ItemType
- Methoden
Ressource: Artikel
Stellt ein einzelnes Objekt dar, das ein Element im Suchindex ist, z. B. eine Datei, ein Ordner oder ein Datenbankeintrag.
JSON-Darstellung |
---|
{ "name": string, "acl": { object ( |
Felder | |
---|---|
name |
Der Name des Artikels. Format: datasources/{sourceId}/items/{itemId} Dieses Feld ist erforderlich. Die maximale Länge beträgt 1.536 Zeichen. |
acl |
Zugriffssteuerungsliste für dieses Element. |
metadata |
Die Metadateninformationen. |
structuredData |
Die strukturierten Daten für das Element, die einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen sollten. |
content |
Der Inhalt des Artikels, der indexiert und nach dem Text durchsucht werden soll. |
version |
Erforderlich. Das Indexierungssystem speichert die Version aus der Datenquelle als Bytestring und vergleicht die Artikelversion im Index mit der Version des in der Warteschlange befindlichen Elements unter Verwendung der lexikalischen Sortierung. Elemente in der Warteschlange, deren Versionswert kleiner oder gleich der Version des aktuell indexierten Elements ist, werden durch die Cloud Search-Indexierung nicht indexiert oder gelöscht. Die maximale Länge dieses Felds beträgt 1.024 Byte. Informationen dazu, wie sich die Elementversion auf den Löschvorgang auswirkt, finden Sie unter Umgang mit Überarbeitungen nach manuellen Löschungen. Ein base64-codierter String. |
status |
Status des Artikels. Nur Ausgabefeld. |
queue |
Dieses Element in die Warteschlange stellen. Die maximale Länge beträgt 100 Zeichen. |
payload |
Ein zusätzlicher Status-Connector kann dieses Element speichern. Die maximale Länge beträgt 10.000 Byte. Ein base64-codierter String. |
itemType |
Der Typ dieses Elements. |
ItemAcl
Informationen zur Zugriffssteuerungsliste für das Element. Weitere Informationen finden Sie unter ACLs zuordnen.
JSON-Darstellung |
---|
{ "inheritAclFrom": string, "aclInheritanceType": enum ( |
Felder | |
---|---|
inheritAclFrom |
Der Name des Elements, von dem die Access Permission List (ACL) übernommen werden soll. Hinweis: Die ACL-Vererbung bietet nur Zugriffsberechtigungen für untergeordnete Elemente, definiert keine strukturellen Beziehungen und bietet auch keine bequemen Möglichkeiten zum Löschen großer Elementgruppen. Durch das Löschen eines übergeordneten ACL-Elements aus dem Index werden nur die Zugriffsberechtigungen der untergeordneten Elemente geändert, die im Feld |
aclInheritanceType |
Legt den Typ der Zugriffsregeln fest, die angewendet werden sollen, wenn ein Element die ACL von einem übergeordneten Element übernimmt. Dieser Wert sollte immer zusammen mit dem Feld |
readers[] |
Liste der Hauptkonten, die das Element in Suchergebnissen sehen dürfen. Optional, wenn die Berechtigungen von einem anderen Element übernommen werden oder das Element nicht sichtbar sein soll, z. B. |
deniedReaders[] |
Liste der Hauptkonten, denen der Zugriff auf das Element in den Suchergebnissen explizit verweigert wird. Während Hauptkonten der Zugriff standardmäßig verweigert wird, verwenden Sie abgelehnte Leser, um Ausnahmen zu verarbeiten und die Liste der zugelassenen Leser zu überschreiben. Es sind maximal 100 Elemente zulässig. |
owners[] |
Optional. Liste der Eigentümer des Elements. Dieses Feld hat keine Auswirkungen auf Berechtigungen für den Dokumentzugriff. Es bietet jedoch ein leichtes Ranking verbessert Elemente, bei denen der fragende Nutzer ein Eigentümer ist. Es sind maximal 5 Elemente zulässig. |
ItemAcl.AclInheritanceType
Die Arten der ACL-Vererbung.
Enums | |
---|---|
NOT_APPLICABLE |
Der Standardwert, wenn für dieses Element keine ACL übernommen wird. Wenn inheritAclFrom leer ist, verwenden Sie NOT_APPLICABLE. Auch für Elemente ohne ACL-Vererbung können ACLs über die eigenen Felder readers und deniedReaders bereitgestellt werden. |
CHILD_OVERRIDE |
Während eines Autorisierungskonflikts bestimmt die ACL des untergeordneten Elements den Lesezugriff. |
PARENT_OVERRIDE |
Während eines Autorisierungskonflikts bestimmt die ACL des übergeordneten Elements, das im Feld inheritAclFrom angegeben ist, den Lesezugriff. |
BOTH_PERMIT |
Der Zugriff wird nur gewährt, wenn sowohl das Element als auch das übergeordnete Element im Feld inheritAclFrom Lesezugriff zulassen. |
Hauptkonto
Verweis auf einen Nutzer, eine Gruppe oder eine Domain
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
gsuitePrincipal |
Dieses Hauptkonto ist ein Google Workspace-Nutzer, eine Google Workspace-Gruppe oder eine Google Workspace-Domain. |
userResourceName |
Dieses Hauptkonto ist ein Nutzer, der mithilfe einer externen Identität identifiziert wurde. Das Feld „Name“ muss den Namen der Nutzerressource in folgendem Format angeben: Identitysources/{sourceId}/users/{ID} |
groupResourceName |
Dieses Hauptkonto ist eine Gruppe, die mithilfe einer externen Identität identifiziert wird. Das Feld „Name“ muss den Namen der Gruppenressource in folgendem Format angeben: Identitysources/{sourceId}/groups/{ID} |
ItemMetadata
Verfügbare Metadatenfelder für das Element.
JSON-Darstellung |
---|
{ "title": string, "sourceRepositoryUrl": string, "containerName": string, "objectType": string, "createTime": string, "updateTime": string, "interactions": [ { object ( |
Felder | |
---|---|
title |
Der Titel des Artikels. Falls angegeben, ist dies der angezeigte Titel des „query.search“-Ergebnisses. Die maximale Länge beträgt 2.048 Zeichen. |
sourceRepositoryUrl |
Link zum Quell-Repository, das die Daten bereitstellt. In den Suchergebnissen wird dieser Link auf den Titel angewendet. Leerzeichen oder Sonderzeichen können dazu führen, dass Suchergebnisse in Cloud Search einen Weiterleitungshinweis auslösen. Um dies zu vermeiden, codieren Sie die URL. Die maximale Länge beträgt 2.048 Zeichen. |
containerName |
Der Name des Containers für dieses Element. Wenn das Containerelement gelöscht wird, wird es automatisch gelöscht. Hinweis: ACLs werden nicht von Containerelementen übernommen. Verwenden Sie das Feld |
objectType |
Der Typ des Elements. Dieser sollte dem Namen einer Objektdefinition im Schema entsprechen, das für die Datenquelle registriert ist. Wenn das Schema für die Datenquelle beispielsweise eine Objektdefinition mit dem Namen „document“ enthält, sollte bei Anfragen zur Elementindexierung für Objekte dieses Typs für „objectType“ „document“ festgelegt werden. Die maximale Länge beträgt 256 Zeichen. |
createTime |
Der Zeitpunkt, zu dem das Element im Quell-Repository erstellt wurde. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
updateTime |
Der Zeitpunkt, zu dem das Element zuletzt im Quell-Repository geändert wurde. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
interactions[] |
Eine Liste der Interaktionen für das Element. Interaktionen werden verwendet, um die Qualität von „query.search“ zu verbessern, sind aber nicht für Endnutzer sichtbar. Es sind maximal 1.000 Elemente zulässig. |
contentLanguage |
Der BCP-47-Sprachcode für den Artikel, z. B. „en-US“ oder "sr-Latn". Weitere Informationen finden Sie unter http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Die maximale Länge beträgt 32 Zeichen. |
mimeType |
Der ursprüngliche MIME-Typ von |
searchQualityMetadata |
Zusätzliche Metadaten zur Suchqualität des Elements |
keywords[] |
Zusätzliche Keywords oder Wortgruppen, die mit dem Element übereinstimmen sollten. Wird intern für von Nutzern erstellte Inhalte verwendet. Es sind maximal 100 Elemente zulässig. Die maximale Länge beträgt 8.192 Zeichen. |
hash |
Hash-Wert, der vom API-Aufrufer bereitgestellt wird. Kann zusammen mit der Methode |
contextAttributes[] |
Eine Reihe benannter Attribute, die dem Artikel zugeordnet sind. Damit kann die Rangfolge des Elements basierend auf dem Kontext in der Anfrage beeinflusst werden. Es sind maximal 10 Elemente zulässig. |
Interaktion
Eine Interaktion zwischen einem Nutzer und einem Element.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type |
|
principal |
Der Nutzer, der eine Aktion für den Artikel ausgeführt hat. |
interactionTime |
Die Zeit, zu der der Nutzer eine Aktion für das Element ausgeführt hat. Wenn mehrere Aktionen desselben Typs für einen einzelnen Nutzer vorhanden sind, wird nur die letzte Aktion aufgezeichnet. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
Interaction.InteractionType
Die Art der Aktivität, die der Nutzer bei dem Artikel ausgeführt hat.
Enums | |
---|---|
UNSPECIFIED |
Ungültiger Wert. |
VIEW |
Diese Interaktion gibt an, dass der Nutzer den Artikel aufgerufen hat. |
EDIT |
Diese Interaktion gibt an, dass der Nutzer das Element bearbeitet hat. |
SearchQualityMetadata
Zusätzliche Metadaten zur Suchqualität des Elements.
JSON-Darstellung |
---|
{ "quality": number } |
Felder | |
---|---|
quality |
Ein Hinweis auf die Qualität des Elements, der die Suchqualität beeinflusst. Der Wert sollte zwischen 0,0 (niedrigste Qualität) und 1,0 (höchste Qualität) liegen. Der Standardwert ist 0,0. |
ContextAttribute
Ein mit einem Element verknüpftes benanntes Attribut, mit dem die Rangfolge des Elements basierend auf dem Kontext in der Anfrage beeinflusst werden kann.
JSON-Darstellung |
---|
{ "name": string, "values": [ string ] } |
Felder | |
---|---|
name |
Der Name des Attributs. Das Feld darf nicht leer sein. Die maximale Länge beträgt 32 Zeichen. Der Name muss mit einem Buchstaben beginnen und darf nur Buchstaben (A–Z, a–z) oder Zahlen (0–9) enthalten. Der Name wird vor dem Abgleich normalisiert (kleingeschrieben). |
values[] |
Textwerte des Attributs. Es sind maximal 10 Elemente zulässig. Die maximale Länge eines Elements im Array beträgt 32 Zeichen. Der Wert wird normalisiert (kleingeschrieben), bevor er abgeglichen wird. |
ItemStructuredData
Verfügbare strukturierte Datenfelder für den Artikel.
JSON-Darstellung |
---|
{
"object": {
object ( |
Felder | |
---|---|
object |
Das strukturierte Datenobjekt, das einer registrierten Objektdefinition im Schema der Datenquelle entsprechen muss. |
hash |
Hash-Wert, der vom API-Aufrufer bereitgestellt wird. Kann zusammen mit der Methode |
StructuredDataObject
Ein strukturiertes Datenobjekt, das aus benannten Properties besteht.
JSON-Darstellung |
---|
{
"properties": [
{
object ( |
Felder | |
---|---|
properties[] |
Die Eigenschaften des Objekts. Es sind maximal 1.000 Elemente zulässig. |
NamedProperty
Ein eingegebenes Name/Wert-Paar für strukturierte Daten. Der Typ des Werts muss mit dem registrierten Typ für das Attribut name
in der Objektdefinition von objectType
übereinstimmen.
JSON-Darstellung |
---|
{ "name": string, // Union field |
Felder | |
---|---|
name |
Der Name der Eigenschaft. Dieser Name sollte dem Namen der Eigenschaft entsprechen, die für die Objektdefinition im Schema registriert wurde. Die maximal zulässige Länge für diese Property beträgt 256 Zeichen. |
Union-Feld value . Der Wert der benannten Property. Beachten Sie, dass ein Attribut nur Werte eines Typs enthalten kann. Für value ist nur einer der folgenden Werte zulässig: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Liste mit ganzzahligen Werten.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Liste der Werte mit doppelter Genauigkeit.
JSON-Darstellung |
---|
{ "values": [ number ] } |
Felder | |
---|---|
values[] |
|
NamedProperty.TimestampValues
Liste der Zeitstempelwerte.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
NamedProperty.ObjectValues
Liste der Objektwerte.
JSON-Darstellung |
---|
{
"values": [
{
object ( |
Felder | |
---|---|
values[] |
|
NamedProperty.EnumValues
Liste der enum-Werte.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
Die maximal zulässige Länge für Stringwerte beträgt 32 Zeichen. |
NamedProperty.DateValues
Liste der Datumswerte.
JSON-Darstellung |
---|
{
"values": [
{
object ( |
Felder | |
---|---|
values[] |
|
NamedProperty.TextValues
Liste der Textwerte.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
Die maximal zulässige Länge für Textwerte beträgt 2.048 Zeichen. |
NamedProperty.HtmlValues
Liste der HTML-Werte.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
Die maximal zulässige Länge für HTML-Werte beträgt 2.048 Zeichen. |
ItemContent
Inhalt eines Elements, das indexiert und in Cloud Search angezeigt werden soll. Als inlineContent
sind nur UTF-8-codierte Strings zulässig. Wenn der Inhalt hochgeladen wird und nicht binär ist, muss er UTF-8-codiert sein.
JSON-Darstellung |
---|
{ "contentFormat": enum ( |
Felder | |
---|---|
contentFormat |
|
hash |
Hash-Informationen, die vom API-Client für Inhalte berechnet und bereitgestellt werden. Kann zusammen mit der Methode „items.push“ verwendet werden, um den geänderten Status zu berechnen. Die maximale Länge beträgt 2.048 Zeichen. |
Union-Feld Für |
|
inlineContent |
Inhalt, der innerhalb der Aktualisierungsmethode bereitgestellt wird. Die maximale Länge beträgt 102.400 Byte (100 KiB). Ein base64-codierter String. |
contentDataRef |
Referenz-ID eines zuvor hochgeladenen Inhalts über die Schreibmethode hochladen |
ItemContent.ContentFormat
Das Format des Inhalts. Wenn das Format RAW ist, sollte der Inhalt im durch mimeType
angegebenen Format vorliegen.
Enums | |
---|---|
UNSPECIFIED |
Ungültiger Wert. |
HTML |
„contentFormat“ ist HTML. |
TEXT |
„contentFormat“ ist Freitext. |
RAW |
contentFormat sind Rohbyte. |
UploadItemRef
Stellt eine Uploadsitzungsreferenz dar. Diese Referenz wird über upload method
erstellt. Diese Referenz ist nach ihrer Erstellung 30 Tage lang gültig. Die Aktualisierung des Artikelinhalts kann über contentDataRef
auf diese hochgeladenen Inhalte verweisen.
JSON-Darstellung |
---|
{ "name": string } |
Felder | |
---|---|
name |
Der Name der Inhaltsreferenz. Die maximale Länge beträgt 2.048 Zeichen. |
ItemStatus
Enthält den Status des Elements und eventuelle Fehler.
JSON-Darstellung |
---|
{ "code": enum ( |
Felder | |
---|---|
code |
Statuscode. |
processingErrors[] |
Fehlerdetails für den Fall, dass das Element den Status ERROR hat. |
repositoryErrors[] |
Vom Connector gemeldeter Repository-Fehler. |
ProcessingError
JSON-Darstellung |
---|
{ "code": enum ( |
Felder | |
---|---|
code |
Fehlercode, der die Art des Fehlers angibt. |
errorMessage |
Die Beschreibung des Fehlers. |
fieldViolations[] |
Falls die Artikelfelder ungültig sind, enthält dieses Feld die Details zu den Validierungsfehlern. |
ProcessingErrorCode
Codes zum Anzeigen des Fehlers, der bei der Verarbeitung von Elementen durch den Cloud Search-Server aufgetreten ist. Ein einzelner Artikel kann mehrere Verarbeitungsfehler enthalten.
Enums | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Nur Eingabewert. Verwenden Sie diesen Wert in „Artikel“. |
MALFORMED_REQUEST |
Die ACL, die Metadaten oder der Inhalt des Elements sind fehlerhaft oder haben einen ungültigen Status. FieldViolations enthält weitere Details zum Ort des Problems. |
UNSUPPORTED_CONTENT_FORMAT |
Das Zählformat wird nicht unterstützt. |
INDIRECT_BROKEN_ACL |
Elemente mit unvollständigen ACL-Informationen, da sie andere Elemente mit fehlerhaften ACLs übernehmen oder Gruppen mit nicht zugeordneten Nachfolgerelementen haben |
ACL_CYCLE |
Das ACL-Vererbungsdiagramm hat einen Zyklus gebildet. |
FieldViolation
JSON-Darstellung |
---|
{ "field": string, "description": string } |
Felder | |
---|---|
field |
Pfad des Felds mit Verstoß. |
description |
Die Beschreibung des Fehlers. |
RepositoryError
Fehler bei der Kommunikation des Connectors mit dem Quell-Repository
JSON-Darstellung |
---|
{
"type": enum ( |
Felder | |
---|---|
type |
Die Art des Fehlers. |
httpStatusCode |
Fehlercodes. Entspricht der Definition von HTTP-Statuscodes. |
errorMessage |
Meldung, die den Fehler beschreibt. Die Nachricht darf maximal 8.192 Zeichen lang sein. |
RepositoryError.Type
Liste der Fehlercodes für Kommunikationsprobleme mit dem Repository.
Enums | |
---|---|
UNKNOWN |
Unbekannter Fehler. |
NETWORK_ERROR |
Unbekannter oder nicht erreichbarer Host |
DNS_ERROR |
DNS-Problem, z. B. dass der DNS-Server nicht antwortet. |
CONNECTION_ERROR |
Keine Verbindung zum Repository-Server möglich. |
AUTHENTICATION_ERROR |
Authentifizierung aufgrund falscher Anmeldedaten fehlgeschlagen. |
AUTHORIZATION_ERROR |
Das Dienstkonto ist nicht für das Repository autorisiert. |
SERVER_ERROR |
Repository-Serverfehler. |
QUOTA_EXCEEDED |
Kontingent überschritten. |
SERVICE_UNAVAILABLE |
Der Server ist vorübergehend nicht verfügbar. |
CLIENT_ERROR |
Client-bezogener Fehler, z. B. eine ungültige Anfrage vom Connector an den Repository-Server. |
Item.ItemType
Enums | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Ein Element, das ausschließlich zur Bereitstellung von Informationen indexiert wird. Auf diese Elemente kann nicht in den Feldern containerName oder inheritAclFrom verwiesen werden. |
CONTAINER_ITEM |
Element, das indexiert wird und dazu dient, andere Elemente mit ACLs zu versorgen und/oder andere Elemente zu enthalten. |
VIRTUAL_CONTAINER_ITEM |
Ein Element, das nicht indexiert wird, aber ansonsten denselben Zweck wie CONTAINER_ITEM hat. |
Methoden |
|
---|---|
|
Löscht Item resource für den angegebenen Ressourcennamen. |
|
Löscht alle Elemente in der Warteschlange. |
|
Ruft Item resource anhand des Elementnamens ab. |
|
Aktualisiert ACL, Metadaten und Inhalte von Item . |
|
Listet alle Item resources oder einen Teil davon auf. |
|
Führt eine Abfrage für nicht reservierte Elemente aus der Indexierungswarteschlange durch und markiert einen Satz als reserviert, beginnend mit den Elementen mit dem ältesten Zeitstempel aus der höchsten Priorität ItemStatus . |
|
Verschiebt ein Element zur späteren Abfrage und Aktualisierung in eine Warteschlange. |
|
Hebt die Reservierung aller Elemente in einer Warteschlange auf, sodass sie alle abgefragt werden können. |
|
Erstellt eine Uploadsitzung zum Hochladen von Artikelinhalten. |