- Ressource: Artikel
- ItemAcl
- ItemAcl.AclInheritanceType
- Hauptkonto
- ItemMetadata
- Interaktion
- Interaction.InteractionType
- SearchQualityMetadata
- ContextAttribute
- ItemStructuredData
- StructuredDataObject
- NamedProperty
- NamedProperty.IntegerValues
- NamedProperty.DoubleValues
- NamedProperty.TimestampValues
- NamedProperty.ObjectValues
- NamedProperty.EnumValues
- NamedProperty.DateValues
- NamedProperty.TextValues
- NamedProperty.HtmlValues
- ItemContent
- ItemContent.ContentFormat
- UploadItemRef
- ItemStatus
- ProcessingError
- ProcessingErrorCode
- FieldViolation
- RepositoryError
- RepositoryError.Type
- Item.ItemType
- Methoden
Ressource: Artikel
Stellt ein einzelnes Objekt dar, das ein Element im Suchindex ist, z. B. eine Datei, einen Ordner oder einen Datensatz.
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 Metadaten. |
structuredData |
Die strukturierten Daten für das Element, die einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen müssen. |
content |
Elementinhalte, die indexiert und für die Textsuche verfügbar gemacht werden sollen. |
version |
Erforderlich. Das Indexierungssystem speichert die Version aus der Datenquelle als Byte-String und vergleicht die Artikelversion im Index mit der Version des Artikels in der Warteschlange anhand der lexikalischen Sortierung. Bei der Cloud Search-Indexierung werden keine Elemente in der Warteschlange indexiert oder gelöscht, deren Versionsnummer kleiner oder gleich der des aktuell indexierten Elements ist. Die maximale Länge dieses Felds beträgt 1.024 Byte. Informationen dazu, wie sich die Artikelversion auf das Löschen auswirkt, finden Sie unter Überarbeitungen nach manuellem Löschen verarbeiten. Ein base64-codierter String. |
status |
Status des Artikels. Nur Ausgabefeld. |
queue |
Die Warteschlange, zu der dieses Element gehört. Die maximale Länge beträgt 100 Zeichen. |
payload |
Zusätzlicher Status-Connector, der für dieses Element gespeichert werden kann. Die maximale Länge beträgt 10.000 Byte. Ein base64-codierter String. |
itemType |
Der Typ dieses Artikels. |
ItemAcl
Informationen zur Zugriffskontrollliste 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 Zugriffsberechtigungsliste (ACL) übernommen werden soll. Hinweis: Die ACL-Übernahme bietet nur Zugriffsberechtigungen für untergeordnete Elemente. Sie definiert keine strukturellen Beziehungen und bietet keine praktischen Möglichkeiten zum Löschen großer Gruppen von Elementen. Wenn Sie ein übergeordnetes ACL aus dem Index löschen, werden nur die Zugriffsberechtigungen der untergeordneten Elemente geändert, die im Feld |
aclInheritanceType |
Legt den Typ der Zugriffsregeln fest, die angewendet werden, wenn ein Element seine ACL von einem übergeordneten Element erbt. Dieser Wert sollte immer zusammen mit dem Feld |
readers[] |
Liste der Hauptkonten, die das Element in den Suchergebnissen sehen dürfen. Optional, wenn 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 ausdrücklich verweigert wird. Hauptkonten wird standardmäßig der Zugriff verweigert. Verwenden Sie abgelehnte Leser, um Ausnahmen zu behandeln und die Liste der zulässigen Leser zu überschreiben. Die maximale Anzahl von Elementen ist 100. |
owners[] |
Optional. Liste der Inhaber des Artikels. Dieses Feld hat keinen Einfluss auf die Berechtigungen für den Dokumentzugriff. Es gibt jedoch einen leichten Ranking-Boost für Elemente, bei denen der Nutzer, der die Abfrage ausführt, Inhaber ist. Die maximale Anzahl von Elementen ist 5. |
ItemAcl.AclInheritanceType
Die Arten der ACL-Vererbung.
Enums | |
---|---|
NOT_APPLICABLE |
Der Standardwert, wenn für dieses Element keine ACL übernommen wird. Verwenden Sie „NICHT_ANWENDBAR“, wenn inheritAclFrom leer ist. Für ein Element ohne ACL-Übernahme können weiterhin ACLs über die eigenen readers - und deniedReaders -Felder angegeben werden. |
CHILD_OVERRIDE |
Bei einem Autorisierungskonflikt wird der Lesezugriff durch die ACL des untergeordneten Elements bestimmt. |
PARENT_OVERRIDE |
Bei einem Autorisierungskonflikt wird der Lesezugriff durch die ACL des übergeordneten Elements bestimmt, die im Feld inheritAclFrom angegeben ist. |
BOTH_PERMIT |
Der Zugriff wird nur gewährt, wenn sowohl für dieses Element als auch für das übergeordnete Element, das im Feld inheritAclFrom angegeben ist, Lesezugriff zulässig ist. |
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 |
Dieser Hauptnutzer ist ein Nutzer, der mit einer externen Identität identifiziert wird. Im Feld „Name“ muss der Name der Nutzerressource im folgenden Format angegeben werden: identitysources/{sourceId}/users/{ID} |
groupResourceName |
Dieses Hauptkonto ist eine Gruppe, die mit einer externen Identität identifiziert wird. Das Feld „Name“ muss den Namen der Gruppenressource im folgenden 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. Wenn angegeben, ist dies der angezeigte Titel des Suchergebnisses für die Abfrage. 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 Links zu Cloud Search-Ergebnissen eine Weiterleitungsbenachrichtigung auslösen. Codieren Sie die URL, um dies zu vermeiden. Die maximale Länge beträgt 2.048 Zeichen. |
containerName |
Der Name des Containers für diesen Artikel. Wenn das Containerelement gelöscht wird, wird dieses Element automatisch gelöscht. Hinweis: ACLs werden nicht von einem Containerelement übernommen. Verwenden Sie das Feld |
objectType |
Der Typ des Artikels. Dieser sollte dem Namen einer Objektdefinition im für die Datenquelle registrierten Schema entsprechen. Wenn das Schema für die Datenquelle beispielsweise eine Objektdefinition mit dem Namen „document“ enthält, sollte für die Indexierungsanfragen für Objekte dieses Typs „objectType“ auf „document“ festgelegt werden. Die maximale Länge beträgt 256 Zeichen. |
createTime |
Die Uhrzeit, zu der 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 im Quell-Repository zuletzt 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 den Artikel. Interaktionen werden verwendet, um die Qualität von „query.search“ zu verbessern, sind aber für Endnutzer nicht sichtbar. Die maximale Anzahl von Elementen ist 1.000. |
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 Artikels |
keywords[] |
Zusätzliche Keywords oder Wortgruppen, die zum Artikel passen sollten. Wird intern für von Nutzern erstellte Inhalte verwendet. Die maximale Anzahl von Elementen ist 100. Die maximale Länge beträgt 8.192 Zeichen. |
hash |
Hash-Wert, der vom API-Aufrufer bereitgestellt wird. Dieser Wert kann mit der Methode |
contextAttributes[] |
Eine Reihe von benannten Attributen, die mit dem Artikel verknüpft sind. So lässt sich das Ranking des Artikels basierend auf dem Kontext in der Anfrage beeinflussen. Die maximale Anzahl von Elementen ist 10. |
Interaktion
Stellt eine Interaktion zwischen einem Nutzer und einem Element dar.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type |
|
principal |
Der Nutzer, der eine Aktion für das Element ausgeführt hat. |
interactionTime |
Die Zeit, zu der der Nutzer eine Aktion für das Element ausgeführt hat. Wenn für einen einzelnen Nutzer mehrere Aktionen desselben Typs 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 mit dem Artikel ausgeführt hat.
Enums | |
---|---|
UNSPECIFIED |
Ungültiger Wert. |
VIEW |
Diese Interaktion gibt an, dass sich der Nutzer das Element angesehen hat. |
EDIT |
Diese Interaktion gibt an, dass der Nutzer das Element bearbeitet hat. |
SearchQualityMetadata
Zusätzliche Metadaten zur Suchqualität des Artikels.
JSON-Darstellung |
---|
{ "quality": number } |
Felder | |
---|---|
quality |
Ein Hinweis auf die Qualität des Artikels, 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 benanntes Attribut, das mit einem Element verknüpft ist und verwendet werden kann, um das Ranking des Elements basierend auf dem Kontext in der Anfrage zu beeinflussen.
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 Ziffern (0–9) enthalten. Der Name wird vor dem Abgleich normalisiert (in Kleinbuchstaben). |
values[] |
Textwerte des Attributs. Die maximale Anzahl von Elementen ist 10. Die maximale Länge eines Elements im Array beträgt 32 Zeichen. Der Wert wird vor dem Abgleich normalisiert (in Kleinbuchstaben umgewandelt). |
ItemStructuredData
Verfügbare Felder für strukturierte Daten für das Element.
JSON-Darstellung |
---|
{
"object": {
object ( |
Felder | |
---|---|
object |
Das strukturierte Datenobjekt, das einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen muss. |
hash |
Hash-Wert, der vom API-Aufrufer bereitgestellt wird. Dieser Wert kann mit der Methode |
StructuredDataObject
Ein strukturiertes Datenobjekt, das aus benannten Properties besteht.
JSON-Darstellung |
---|
{
"properties": [
{
object ( |
Felder | |
---|---|
properties[] |
Die Eigenschaften des Objekts. Die maximale Anzahl von Elementen ist 1.000. |
NamedProperty
Ein typisiertes Name/Wert-Paar für strukturierte Daten. Der Werttyp muss mit dem registrierten Typ für die Property name
in der Objektdefinition von objectType
übereinstimmen.
JSON-Darstellung |
---|
{ "name": string, // Union field |
Felder | |
---|---|
name |
Der Name der Unterkunft. Dieser Name sollte mit dem Namen der Property übereinstimmen, die für die Objektdefinition im Schema registriert wurde. Die maximale Länge für dieses Attribut beträgt 256 Zeichen. |
Union-Feld value . Der Wert bzw. die Werte der benannten Property. Eine Property kann nur Werte eines Typs enthalten. Für value ist nur einer der folgenden Werte zulässig: |
|
integerValues |
|
doubleValues |
|
timestampValues |
|
booleanValue |
|
objectValues |
|
enumValues |
|
dateValues |
|
textValues |
|
htmlValues |
|
NamedProperty.IntegerValues
Liste von Ganzzahlwerten.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Liste von Double-Werten.
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 maximale Länge für Stringwerte beträgt 32 Zeichen. |
NamedProperty.DateValues
Liste mit Datumswerten.
JSON-Darstellung |
---|
{
"values": [
{
object ( |
Felder | |
---|---|
values[] |
|
NamedProperty.TextValues
Liste mit Textwerten.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
Textwerte dürfen maximal 2.048 Zeichen lang sein. |
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 von Cloud Search indexiert und angezeigt werden soll. Als inlineContent
sind nur UTF-8-codierte Strings zulässig. Wenn der Inhalt hochgeladen 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 mit der items.push-Methode verwendet werden, um den geänderten Status zu berechnen. Die maximale Länge beträgt 2.048 Zeichen. |
Union-Feld Für |
|
inlineContent |
Inhalte, die in der Update-Methode inline bereitgestellt werden. Die maximale Länge beträgt 102.400 Byte (100 KiB). Ein base64-codierter String. |
contentDataRef |
Lade die Referenz-ID eines zuvor hochgeladenen Inhalts über die Schreibmethode hoch. |
ItemContent.ContentFormat
Das Format des Inhalts. Wenn das Format RAW ist, sollte der Inhalt im von mimeType
angegebenen Format vorliegen.
Enums | |
---|---|
UNSPECIFIED |
Ungültiger Wert. |
HTML |
contentFormat ist HTML. |
TEXT |
„contentFormat“ ist ein freier Text. |
RAW |
contentFormat ist „raw bytes“. |
UploadItemRef
Stellt eine Referenz auf eine Uploadsitzung dar. Diese Referenz wird über upload method
erstellt. Diese Referenz ist 30 Tage nach der Erstellung gültig. Die Aktualisierung von Artikelinhalten kann sich auf diese hochgeladenen Inhalte über contentDataRef
beziehen.
JSON-Darstellung |
---|
{ "name": string } |
Felder | |
---|---|
name |
Der Name der Inhaltsreferenz. Die maximale Länge beträgt 2.048 Zeichen. |
ItemStatus
Dieser enthält den Status des Artikels und alle Fehler.
JSON-Darstellung |
---|
{ "code": enum ( |
Felder | |
---|---|
code |
Statuscode. |
processingErrors[] |
Fehlerdetails, falls der Artikel den Status „FEHLER“ hat. |
repositoryErrors[] |
Vom Connector gemeldeter Repository-Fehler. |
ProcessingError
JSON-Darstellung |
---|
{ "code": enum ( |
Felder | |
---|---|
code |
Fehlercode, der die Art des Fehlers angibt. |
errorMessage |
Die Fehlerbeschreibung. |
fieldViolations[] |
Wenn die Artikelfelder ungültig sind, enthält dieses Feld die Details zu den Validierungsfehlern. |
ProcessingErrorCode
Codes, die den Fehler angeben, 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 Eingabe. Verwenden Sie diesen Wert in „Artikel“. |
MALFORMED_REQUEST |
Die ACL, die Metadaten oder der Inhalt des Elements sind fehlerhaft oder im ungültigen Status. Im Feld „FieldViolations“ finden Sie weitere Informationen zur Ursache des Problems. |
UNSUPPORTED_CONTENT_FORMAT |
Das Inhaltsformat wird nicht unterstützt. |
INDIRECT_BROKEN_ACL |
Elemente mit unvollständigen ACL-Informationen, weil andere Elemente mit einer fehlerhaften ACL übernommen wurden oder Gruppen mit nicht zugeordneten Nachkommen vorhanden sind. |
ACL_CYCLE |
Der ACL-Vererbungsgraph bildet einen Zyklus. |
FieldViolation
JSON-Darstellung |
---|
{ "field": string, "description": string } |
Felder | |
---|---|
field |
Feldweg mit Verstoß |
description |
Die Fehlerbeschreibung. |
RepositoryError
Fehler bei der Kommunikation des Connectors mit dem Quellrepository.
JSON-Darstellung |
---|
{
"type": enum ( |
Felder | |
---|---|
type |
Die Art des Fehlers. |
httpStatusCode |
Fehlercodes Entspricht der Definition von HTTP-Statuscodes. |
errorMessage |
Eine Nachricht, in der der Fehler beschrieben wird. 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. wenn der DNS-Server nicht reagiert |
CONNECTION_ERROR |
Verbindung zum Repository-Server kann nicht hergestellt werden. |
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 |
Clientbezogener Fehler, z. B. eine ungültige Anfrage vom Connector an den Repository-Server. |
Item.ItemType
Enums | |
---|---|
UNSPECIFIED |
|
CONTENT_ITEM |
Ein Element, das ausschließlich zum Zweck der Bereitstellung von Informationen indexiert wird. Auf diese Elemente kann nicht in containerName - oder inheritAclFrom -Feldern verwiesen werden. |
CONTAINER_ITEM |
Ein Element, das indexiert wird und dem Zweck dient, anderen Elementen ACLs zur Verfügung zu stellen 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. |
|
Alle Elemente in einer Warteschlange werden gelöscht. |
|
Ruft Item resource nach Artikelnamen ab. |
|
Aktualisiert die Item -ACL, die Metadaten und den Inhalt. |
|
Listet alle oder eine Teilmenge von Item resources auf. |
|
Es wird nach nicht reservierten Elementen in der Indexierungswarteschlange gesucht und ein Satz wird als reserviert markiert, beginnend mit den Elementen mit dem ältesten Zeitstempel der höchsten Priorität ItemStatus . |
|
Ein Element wird in eine Warteschlange für spätere Abfragen und Aktualisierungen geschoben. |
|
Hiermit werden alle Elemente aus einer Warteschlange aufgehoben, sodass sie alle abgefragt werden können. |
|
Erstellt eine Uploadsitzung zum Hochladen von Artikelinhalten. |