Method: indexing.datasources.items.push

Setzt ein Element zur späteren Abfrage und Aktualisierung in eine Warteschlange.

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/*}:push

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
item.name

string

Der Name des item, der in die Indexierungswarteschlange verschoben werden soll.

Format: datasources/{sourceId}/items/{ID}

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,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Felder
item.type

enum (PushItem.Type)

Der Typ des Push-Vorgangs, der das Push-Verhalten definiert.
item.metadataHash

string

Der Metadaten-Hash des Elements gemäß Repository. Wenn dieses Flag angegeben ist, wird damit festgelegt, wie der Status dieses Elements geändert werden soll. Wenn dieses Feld und das Feld type festgelegt werden, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
item.structuredDataHash

string

Hash der strukturierten Daten des Elements gemäß Repository. Wenn dieses Flag angegeben ist, wird damit festgelegt, wie der Status dieses Elements geändert werden soll. Wenn dieses Feld und das Feld type festgelegt werden, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
item.contentHash

string

Inhalts-Hash des Elements gemäß Repository. Wenn dieses Flag angegeben ist, wird damit festgelegt, wie der Status dieses Elements geändert werden soll. Wenn dieses Feld und das Feld type festgelegt werden, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
item.payload

string (bytes format)

Stellt zusätzliche Informationen zum Dokumentstatus für den Connector bereit, z. B. eine alternative Repository-ID und andere Metadaten. Die maximale Länge beträgt 8.192 Byte.

Ein base64-codierter String.
item.queue

string

Die Warteschlange, zu der dieses Element gehört. Die default-Warteschlange wird ausgewählt, wenn dieses Feld nicht angegeben ist. Die maximale Länge beträgt 512 Zeichen.
item.repositoryError

object (RepositoryError)

Füllen Sie dieses Feld aus, um Details zu Connector- oder Repository-Fehlern zu speichern. Diese Informationen werden in der Admin-Konsole angezeigt. Dieses Feld darf nur ausgefüllt werden, wenn type den Wert REPOSITORY_ERROR hat.
connectorName

string

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

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

object (DebugOptions)

Häufig verwendete Optionen zur Fehlerbehebung.

Antworttext

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

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.

PushItem

Stellt ein Element dar, das in die Indexierungswarteschlange verschoben wird.

JSON-Darstellung 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Felder
name

string

Der Name des item, der in die Indexierungswarteschlange verschoben werden soll.

Format: datasources/{sourceId}/items/{ID}

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

enum (PushItem.Type)

Der Typ des Push-Vorgangs, der das Push-Verhalten definiert.
metadataHash

string

Der Metadaten-Hash des Elements gemäß Repository. Wenn dieses Flag angegeben ist, wird damit festgelegt, wie der Status dieses Elements geändert werden soll. Wenn dieses Feld und das Feld type festgelegt werden, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
structuredDataHash

string

Hash der strukturierten Daten des Elements gemäß Repository. Wenn dieses Flag angegeben ist, wird damit festgelegt, wie der Status dieses Elements geändert werden soll. Wenn dieses Feld und das Feld type festgelegt werden, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
contentHash

string

Inhalts-Hash des Elements gemäß Repository. Wenn dieses Flag angegeben ist, wird damit festgelegt, wie der Status dieses Elements geändert werden soll. Wenn dieses Feld und das Feld type festgelegt werden, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
payload

string (bytes format)

Stellt zusätzliche Informationen zum Dokumentstatus für den Connector bereit, z. B. eine alternative Repository-ID und andere Metadaten. Die maximale Länge beträgt 8.192 Byte.

Ein base64-codierter String.
queue

string

Die Warteschlange, zu der dieses Element gehört. Die default-Warteschlange wird ausgewählt, wenn dieses Feld nicht angegeben ist. Die maximale Länge beträgt 512 Zeichen.
repositoryError

object (RepositoryError)

Füllen Sie dieses Feld aus, um Details zu Connector- oder Repository-Fehlern zu speichern. Diese Informationen werden in der Admin-Konsole angezeigt. Dieses Feld darf nur ausgefüllt werden, wenn type den Wert REPOSITORY_ERROR hat.

PushItem.Type

Der Typ des Push-Vorgangs, der das Push-Verhalten definiert.

Enums
UNSPECIFIED Standardeinstellung UNSPECIFIED. Gibt an, dass der Push-Vorgang ItemStatus nicht ändern soll
MODIFIED Gibt an, dass das Repository-Dokument seit dem vorherigen update-Aufruf geändert oder aktualisiert wurde. Dadurch wird für ein vorhandenes Element der Status zu MODIFIED geändert. Wird sie für ein nicht vorhandenes Element aufgerufen, ändert sich der Status in NEW_ITEM.
NOT_MODIFIED Das Element im Repository wurde seit dem letzten Aktualisierungsaufruf nicht geändert. Durch diesen Push-Vorgang wird der Status auf ACCEPTED gesetzt.
REPOSITORY_ERROR Für den Connector ist bei diesem Element ein Repository-Fehler aufgetreten. Ändere den Status zu „REPOSITORY_ERROR“. Die Reservierung des Elements wird aufgehoben und es wird zu einem späteren Zeitpunkt neu geplant, der durch den exponentiellen Backoff bestimmt wird.
REQUEUE Rufen Sie Push mit REQUEUE nur für reservierte Elemente auf. Dadurch wird die Reservierung des Elements aufgehoben und die verfügbare Zeit wird auf die tatsächlich verstrichene Zeit zurückgesetzt.