Method: indexing.datasources.items.index

Aktualisiert die ACL, Metadaten und Inhalte von Item. Wenn der Item nicht vorhanden ist, wird er eingefügt. Diese Methode unterstützt keine Teilaktualisierungen. Felder ohne Werte werden aus dem Cloud Search-Index gelöscht.

Zum Ausführen dieser API ist ein Administrator- oder Dienstkonto erforderlich. Das verwendete Dienstkonto ist das Dienstkonto, das in der entsprechenden Datenquelle auf die Zulassungsliste gesetzt wurde.

HTTP-Anfrage

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
item.name

string

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

Dies ist ein Pflichtfeld. Die maximale Länge beträgt 1.536 Zeichen.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "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)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "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.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
Felder
item.acl

object (ItemAcl)

Zugriffssteuerungsliste für dieses Element.

item.metadata

object (ItemMetadata)

Die Metadaten-Informationen.

item.structuredData

object (ItemStructuredData)

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

item.content

object (ItemContent)

Inhalt des Artikels, der indexiert und der Text suchbar gemacht werden soll.

item.version

string (bytes format)

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.

item.status

object (ItemStatus)

Status des Artikels Nur Ausgabefeld.

item.queue

string

Warteschlange, zu der dieses Element gehört. Die maximale Länge beträgt 100 Zeichen.

item.payload

string (bytes format)

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

Ein base64-codierter String.

item.itemType

enum (Item.ItemType)

Der Typ für dieses Element.

connectorName

string

Der Name des Connectors, der diesen Aufruf durchführt.

Format: Datenquellen/{Quell-ID}/Connectors/{ID}

mode

enum (RequestMode.Mode)

Erforderlich. Der RequestMode für diese Anfrage.

debugOptions

object (DebugOptions)

Häufig verwendete Optionen zur Fehlerbehebung.

indexItemOptions

object (IndexItemOptions)

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

IndexItemOptions

JSON-Darstellung
{
  "allowUnknownGsuitePrincipals": boolean
}
Felder
allowUnknownGsuitePrincipals

boolean

Gibt an, ob die Indexanfrage Google Workspace-Hauptkonten zulassen soll, die nicht vorhanden sind oder gelöscht werden.