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 |
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 ( |
Felder | |
---|---|
item.acl |
Zugriffssteuerungsliste für dieses Element. |
item.metadata |
Die Metadaten-Informationen. |
item.structuredData |
Die strukturierten Daten für das Element, die einer registrierten Objektdefinition im Schema für die Datenquelle entsprechen müssen. |
item.content |
Inhalt des Artikels, der indexiert und der Text suchbar gemacht werden soll. |
item.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. |
item.status |
Status des Artikels Nur Ausgabefeld. |
item.queue |
Warteschlange, zu der dieses Element gehört. Die maximale Länge beträgt 100 Zeichen. |
item.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. |
item.itemType |
Der Typ für dieses Element. |
connectorName |
Der Name des Connectors, der diesen Aufruf durchführt. Format: Datenquellen/{Quell-ID}/Connectors/{ID} |
mode |
Erforderlich. Der RequestMode für diese Anfrage. |
debugOptions |
Häufig verwendete Optionen zur Fehlerbehebung. |
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 |
Gibt an, ob die Indexanfrage Google Workspace-Hauptkonten zulassen soll, die nicht vorhanden sind oder gelöscht werden. |