- 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, bei dem es sich um ein Element im Suchindex handelt, z. B. eine Datei, einen Ordner oder einen Datenbankeintrag.
JSON-Darstellung |
---|
{ "name": string, "acl": { object ( |
Felder | |
---|---|
name |
Der Name des Artikels. Format: datasources/{sourceId}/items/{itemId} Dies ist ein Pflichtfeld. Die maximale Länge beträgt 1.536 Zeichen. |
acl |
Zugriffssteuerungsliste für dieses Element. |
metadata |
Die Metadaten-Informationen. |
structuredData |
Die strukturierten Daten für das Element, die einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen müssen. |
content |
Inhalt des Artikels, der indexiert und der Text suchbar gemacht werden soll. |
version |
Erforderlich. Das Indexierungssystem speichert die Version aus der Datenquelle als Bytestring und vergleicht die Elementversion im Index mit der Version des Elements in der Warteschlange unter Verwendung der lexikalischen Reihenfolge. Durch die Cloud Search-Indexierung werden keine Elemente in der Warteschlange indexiert oder gelöscht, deren Versionswert kleiner oder gleich der Version des aktuell indexierten Elements ist. Die maximale Länge für dieses Feld beträgt 1.024 Byte. Informationen dazu, wie sich die Artikelversion auf den Löschvorgang auswirkt, finden Sie unter Umgang mit Überarbeitungen nach manuellen Löschvorgängen. Ein base64-codierter String. |
status |
Status des Artikels Nur Ausgabefeld. |
queue |
Warteschlange, zu der dieses Element gehört. Die maximale Länge beträgt 100 Zeichen. |
payload |
Ein zusätzlicher Status-Connector kann für dieses Element speichern. Die maximale Länge beträgt 10.000 Byte. Ein base64-codierter String. |
itemType |
Der Typ für dieses Element. |
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: Bei der ACL-Vererbung werden ausschließlich Zugriffsberechtigungen für untergeordnete Elemente gewährt. Es werden weder strukturelle Beziehungen definiert noch lässt sich auf einfache Weise große Gruppen von Elementen löschen. Wenn Sie ein übergeordnetes ACL-Element aus dem Index löschen, werden nur die Zugriffsberechtigungen für untergeordnete Elemente geändert, die im Feld |
aclInheritanceType |
Legt den Typ der Zugriffsregeln fest, die angewendet werden sollen, wenn ein Element die ACL eines übergeordneten Elements erbt. Dieser 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 wenn 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 „Verweigerte 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 keinen Einfluss auf Berechtigungen für den Dokumentzugriff. Sie bietet jedoch ein leichtes Ranking Booster für Elemente, bei denen der anfragende Nutzer Inhaber ist. Es sind maximal fünf Elemente zulässig. |
ItemAcl.AclInheritanceType
Die Arten der ACL-Vererbung.
Enums | |
---|---|
NOT_APPLICABLE |
Der Standardwert, wenn für dieses Element keine ACL übernommen wird. Verwenden Sie NOT_APPLICABLE, wenn inheritAclFrom leer ist. Für Elemente ohne ACL-Vererbung können ACLs weiterhin über die eigenen Felder readers und deniedReaders angegeben werden. |
CHILD_OVERRIDE |
Während eines Autorisierungskonflikts wird der Lesezugriff durch die ACL des untergeordneten Elements bestimmt. |
PARENT_OVERRIDE |
Während eines Autorisierungskonflikts wird der Lesezugriff durch die ACL des übergeordneten Elements bestimmt, das im Feld inheritAclFrom angegeben ist. |
BOTH_PERMIT |
Der Zugriff wird nur gewährt, wenn sowohl dieses Element als auch das im Feld inheritAclFrom angegebene übergeordnete Element Lesezugriff gewähren. |
Hauptkonto
Verweis auf einen Nutzer, eine Gruppe oder eine Domain
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
gsuitePrincipal |
Dieses Hauptkonto ist ein Nutzer, eine Gruppe oder eine Domain von Google Workspace. |
userResourceName |
Dieses Hauptkonto ist ein Nutzer, der mithilfe einer externen Identität identifiziert wurde. Im Feld „Name“ muss der Name der Nutzerressource in folgendem Format angegeben werden: identitysources/{sourceId}/users/{ID} |
groupResourceName |
Dieses Hauptkonto ist eine Gruppe, die mithilfe einer externen Identität identifiziert wird. Im Feld „Name“ muss der Name der Gruppenressource in folgendem Format angegeben werden: Identitysources/{Quell-ID}/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. Bei Suchergebnissen wird dieser Link auf den Titel angewendet. Leerräume oder Sonderzeichen können dazu führen, dass Cloud Search-Ergebnislinks eine Weiterleitung auslösen. Um dies zu vermeiden, sollten Sie die URL codieren. Die maximale Länge beträgt 2.048 Zeichen. |
containerName |
Der Name des Containers für dieses Element. Wenn Sie das Containerelement löschen, wird es automatisch gelöscht. Hinweis: ACLs werden nicht von einem Containerelement übernommen. Verwenden Sie das Feld |
objectType |
Der Typ des Elements. Er sollte dem Namen einer Objektdefinition im für die Datenquelle registrierten Schema entsprechen. Wenn beispielsweise das Schema für die Datenquelle eine Objektdefinition mit dem Namen „document“ enthält, sollte bei Anfragen zur Elementindexierung für Objekte dieses Typs „objectType“ auf „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 Nanosekundenauflösung 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 Nanosekundenauflösung 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 dem Artikel entsprechen 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 |
Vom API-Aufrufer bereitgestellter Hashwert. Dies kann mit der Methode |
contextAttributes[] |
Eine Gruppe benannter Attribute, die mit dem Element verknüpft sind. Dies kann verwendet werden, um das Ranking des Elements basierend auf dem Kontext in der Anfrage zu beeinflussen. Es sind maximal 10 Elemente zulässig. |
Interaktion
Interaktion zwischen einem Nutzer und einem Artikel
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 für einen einzelnen Nutzer mehrere Aktionen desselben Typs vorhanden sind, wird nur die letzte Aktion erfasst. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
Interaction.InteractionType
Die Art der Aktivität, die der Nutzer für den Artikel ausgeführt hat.
Enums | |
---|---|
UNSPECIFIED |
Ungültiger Wert. |
VIEW |
Diese Interaktion zeigt an, dass der Nutzer den Artikel angesehen hat. |
EDIT |
Diese Interaktion zeigt an, dass der Nutzer das Element bearbeitet hat. |
SearchQualityMetadata
Zusätzliche Metadaten zur Suchqualität des Elements.
JSON-Darstellung |
---|
{ "quality": number } |
Felder | |
---|---|
quality |
Gibt die Qualität des Elements an, die zur Beeinflussung der Suchqualität verwendet wird. 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 Artikel verknüpft ist und dazu verwendet werden kann, das Ranking des Artikels basierend auf dem Kontext in der Anfrage zu beeinflussen.
JSON-Darstellung |
---|
{ "name": string, "values": [ string ] } |
Felder | |
---|---|
name |
Der Name des Attributs. Dieses 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 normalisiert (in Kleinbuchstaben), bevor er abgeglichen wird. |
values[] |
Textwerte des Attributs. Es sind maximal 10 Elemente zulässig. Ein Element im Array darf maximal 32 Zeichen lang sein. Der Wert wird normalisiert (kleingeschrieben), bevor er abgeglichen wird. |
ItemStructuredData
Verfügbare strukturierte Datenfelder 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 |
Vom API-Aufrufer bereitgestellter Hashwert. Dies kann 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 typisiertes 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 . Wert(e) der benannten Eigenschaft 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 Ganzzahlwerten.
JSON-Darstellung |
---|
{ "values": [ string ] } |
Felder | |
---|---|
values[] |
|
NamedProperty.DoubleValues
Liste mit doppelten 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 Nanosekundenauflösung 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 Zeichenfolgenwerte beträgt 32 Zeichen. |
NamedProperty.DateValues
Liste der Datumswerte
JSON-Darstellung |
---|
{
"values": [
{
object ( |
Felder | |
---|---|
values[] |
|
NamedProperty.TextValues
Liste mit Textwerten.
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 von Cloud Search indexiert und angezeigt werden soll. Als inlineContent
sind nur UTF-8-codierte Strings zulässig. Wenn die hochgeladenen Inhalte nicht binär sind, müssen sie 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 Methode items.push zur Berechnung des geänderten Status verwendet werden. Die maximale Länge beträgt 2.048 Zeichen. |
Union-Feld Für |
|
inlineContent |
Inhalte, die innerhalb der Aktualisierungsmethode bereitgestellt werden. Die maximale Länge beträgt 102.400 Byte (100 KiB). Ein base64-codierter String. |
contentDataRef |
Referenz-ID eines zuvor hochgeladenen Inhalts mithilfe der Schreibmethode hochladen. |
ItemContent.ContentFormat
Das Format des Inhalts. Im RAW-Format müssen die Inhalte in dem unter mimeType
angegebenen Format vorliegen.
Enums | |
---|---|
UNSPECIFIED |
Ungültiger Wert. |
HTML |
contentFormat ist HTML. |
TEXT |
contentFormat ist Freitext. |
RAW |
contentFormat ist Rohbyte. |
UploadItemRef
Stellt eine Uploadsitzungsreferenz dar. Diese Referenz wird über upload method
erstellt. Diese Referenz ist nach ihrer Erstellung 30 Tage lang gültig. Wenn du den Inhalt des Artikels aktualisierst, kann über contentDataRef
auf diese hochgeladenen Inhalte zugegriffen werden.
JSON-Darstellung |
---|
{ "name": string } |
Felder | |
---|---|
name |
Der Name der Inhaltsreferenz. Die maximale Länge beträgt 2.048 Zeichen. |
ItemStatus
Sie enthält den Status des Artikels und etwaige Fehler.
JSON-Darstellung |
---|
{ "code": enum ( |
Felder | |
---|---|
code |
Statuscode. |
processingErrors[] |
Fehlerdetails, falls sich das Element im Status ERROR befindet |
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 Details zu den Validierungsfehlern. |
ProcessingErrorCode
Codes zur Angabe des Fehlers, der während der Verarbeitung von Elementen durch den Cloud Search-Server aufgetreten ist. Ein einzelner Artikel kann mehrere Verarbeitungsfehler aufweisen.
Enums | |
---|---|
PROCESSING_ERROR_CODE_UNSPECIFIED |
Nur Eingabewert. Verwenden Sie diesen Wert unter „Artikel“. |
MALFORMED_REQUEST |
Die ACL, die Metadaten oder der Inhalt des Elements ist fehlerhaft oder ungültig. Feldverstoß 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, weil andere Elemente mit einer fehlerhaften ACL übernommen wurden oder Gruppen mit nicht zugeordneten untergeordneten Elementen enthalten sind. |
ACL_CYCLE |
Die ACL-Vererbungsgrafik bildete einen Zyklus. |
FieldViolation
JSON-Darstellung |
---|
{ "field": string, "description": string } |
Felder | |
---|---|
field |
Pfad des Felds mit dem Verstoß. |
description |
Die Beschreibung des Fehlers. |
RepositoryError
Fehler, wenn der Connector mit dem Quell-Repository kommuniziert
JSON-Darstellung |
---|
{
"type": enum ( |
Felder | |
---|---|
type |
Die Art des Fehlers. |
httpStatusCode |
Fehlercodes. Stimmt mit der Definition der HTTP-Statuscodes überein. |
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 |
Ein DNS-Problem, z. B. dass der DNS-Server nicht reagiert. |
CONNECTION_ERROR |
Verbindung zum Repository-Server kann nicht hergestellt werden. |
AUTHENTICATION_ERROR |
Die Authentifizierung ist 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 Artikel, der ausschließlich zur Bereitstellung von Informationen indexiert wurde. Auf diese Elemente kann nicht in den Feldern containerName oder inheritAclFrom verwiesen werden. |
CONTAINER_ITEM |
Ein Element, das indexiert wird und dessen Zweck darin besteht, andere Elemente mit ACLs zu versorgen und/oder weitere 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 einer Warteschlange. |
|
Ruft Item resource nach Elementname ab. |
|
Aktualisiert die ACL, Metadaten und Inhalte von Item . |
|
Listet alle oder einen Teil von Item resources auf. |
|
Führt eine Abfrage auf nicht reservierte Elemente aus der Indexierungswarteschlange durch und markiert eine Gruppe als reserviert, wobei die Elemente mit dem ältesten Zeitstempel der höchsten Priorität (ItemStatus ) beginnen. |
|
Setzt 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 Upload-Sitzung für das Hochladen von Artikelinhalten |