Method: indexing.datasources.items.index

Aktualisiert die Item-ACL, die Metadaten und den Inhalt. Wenn Item nicht vorhanden ist, wird es eingefügt. Diese Methode unterstützt keine teilweisen Aktualisierungen. Felder ohne angegebene Werte werden aus dem Cloud Search-Index gelöscht.

Für die Ausführung dieser API ist ein Administrator- oder Dienstkonto erforderlich. Das verwendete Dienstkonto ist dasjenige, 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}

Dieses Feld ist erforderlich. 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.
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)

Elementinhalte, die indexiert und für die Textsuche verfügbar gemacht werden sollen.
item.version

string (bytes format)

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.
item.status

object (ItemStatus)

Status des Artikels. Nur Ausgabefeld.
item.queue

string

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

string (bytes format)

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.
item.itemType

enum (Item.ItemType)

Der Typ dieses Artikels.
connectorName

string

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

Format: datasources/{sourceId}/connectors/{ID}
mode

enum (RequestMode.Mode)

Erforderlich. Der RequestMode für diese Anfrage.
debugOptions

object (DebugOptions)

Gängige 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 bei der Indexanfrage Google Workspace-Principals zugelassen werden sollen, die nicht vorhanden oder gelöscht wurden.