REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

Der Name des Artikels. Format: datasources/{sourceId}/items/{itemId}

Dieses Feld ist erforderlich. Die maximale Länge beträgt 1.536 Zeichen.

object (ItemAcl)

Zugriffssteuerungsliste für dieses Element.

object (ItemMetadata)

Die Metadateninformationen.

object (ItemStructuredData)

Die strukturierten Daten für das Element, die einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen sollten.

object (ItemContent)

Der Inhalt des Artikels, der indexiert und nach dem Text durchsucht werden soll.

string (bytes format)

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.

object (ItemStatus)

Status des Artikels. Nur Ausgabefeld.

string

Dieses Element in die Warteschlange stellen. Die maximale Länge beträgt 100 Zeichen.

string (bytes format)

Ein zusätzlicher Status-Connector kann dieses Element speichern. Die maximale Länge beträgt 10.000 Byte.

Ein base64-codierter String.

enum (Item.ItemType)

Der Typ dieses Elements.

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

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 inheritAclFrom auf das übergeordnete Element verweisen. Das Element ist noch im Index, wird aber möglicherweise nicht in den Suchergebnissen angezeigt. Wenn Sie dagegen ein Containerelement löschen, werden auch alle Elemente gelöscht, die über das Feld containerName auf den Container verweisen. Die maximale Länge dieses Felds beträgt 1.536 Zeichen.

enum (ItemAcl.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 inheritAclFrom festgelegt werden. Wenn das Feld inheritAclFrom festgelegt ist, sollte dieses Feld außerdem auf einen gültigen AclInheritanceType festgelegt werden.

object (Principal)

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. virtual containers. Es sind maximal 1.000 Elemente zulässig.

object (Principal)

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.

object (Principal)

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.

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object (GSuitePrincipal)

Dieses Hauptkonto ist ein Google Workspace-Nutzer, eine Google Workspace-Gruppe oder eine Google Workspace-Domain.

string

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}

string

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}

{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}

string

Der Titel des Artikels. Falls angegeben, ist dies der angezeigte Titel des „query.search“-Ergebnisses. Die maximale Länge beträgt 2.048 Zeichen.

string

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.

string

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 inheritAclFrom, um die ACL-Vererbung für ein Element festzulegen. Die maximale Länge beträgt 1.536 Zeichen.

string

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.

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

object (Interaction)

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.

string

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.

string

Der ursprüngliche MIME-Typ von ItemContent.content im Quell-Repository. Die maximale Länge beträgt 256 Zeichen.

object (SearchQualityMetadata)

Zusätzliche Metadaten zur Suchqualität des Elements

string

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.

string

Hash-Wert, der vom API-Aufrufer bereitgestellt wird. Kann zusammen mit der Methode items.push verwendet werden, um den geänderten Zustand zu berechnen. Die maximale Länge beträgt 2.048 Zeichen.

object (ContextAttribute)

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.

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum (Interaction.InteractionType)

object (Principal)

Der Nutzer, der eine Aktion für den Artikel ausgeführt hat.

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

{
  "quality": number
}

number

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.

{
  "name": string,
  "values": [
    string
  ]
}

string

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).

string

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.

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object (StructuredDataObject)

Das strukturierte Datenobjekt, das einer registrierten Objektdefinition im Schema der Datenquelle entsprechen muss.

string

Hash-Wert, der vom API-Aufrufer bereitgestellt wird. Kann zusammen mit der Methode items.push verwendet werden, um den geänderten Zustand zu berechnen. Die maximale Länge beträgt 2.048 Zeichen.

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object (NamedProperty)

Die Eigenschaften des Objekts. Es sind maximal 1.000 Elemente zulässig.

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

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.

object (NamedProperty.IntegerValues)

object (NamedProperty.DoubleValues)

object (NamedProperty.TimestampValues)

boolean

object (NamedProperty.ObjectValues)

object (NamedProperty.EnumValues)

object (NamedProperty.DateValues)

object (NamedProperty.TextValues)

object (NamedProperty.HtmlValues)

{
  "values": [
    string
  ]
}

string (int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string (Timestamp format)

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

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

Die maximal zulässige Länge für Stringwerte beträgt 32 Zeichen.

{
  "values": [
    {
      object (Date)
    }
  ]
}

object (Date)

{
  "values": [
    string
  ]
}

string

Die maximal zulässige Länge für Textwerte beträgt 2.048 Zeichen.

{
  "values": [
    string
  ]
}

string

Die maximal zulässige Länge für HTML-Werte beträgt 2.048 Zeichen.

{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}

enum (ItemContent.ContentFormat)

string

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.

string (bytes format)

Inhalt, der innerhalb der Aktualisierungsmethode bereitgestellt wird. Die maximale Länge beträgt 102.400 Byte (100 KiB).

Ein base64-codierter String.

object (UploadItemRef)

Referenz-ID eines zuvor hochgeladenen Inhalts über die Schreibmethode hochladen

{
  "name": string
}

string

Der Name der Inhaltsreferenz. Die maximale Länge beträgt 2.048 Zeichen.

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum (ItemStatus.Code)

Statuscode.

object (ProcessingError)

Fehlerdetails für den Fall, dass das Element den Status ERROR hat.

object (RepositoryError)

Vom Connector gemeldeter Repository-Fehler.

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum (ProcessingErrorCode)

Fehlercode, der die Art des Fehlers angibt.

string

Die Beschreibung des Fehlers.

object (FieldViolation)

Falls die Artikelfelder ungültig sind, enthält dieses Feld die Details zu den Validierungsfehlern.

{
  "field": string,
  "description": string
}

string

Pfad des Felds mit Verstoß.

string

Die Beschreibung des Fehlers.

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum (RepositoryError.Type)

Die Art des Fehlers.

integer

Fehlercodes. Entspricht der Definition von HTTP-Statuscodes.

string

Meldung, die den Fehler beschreibt. Die Nachricht darf maximal 8.192 Zeichen lang sein.