Diese Seite wurde von der Cloud Translation API übersetzt.

Method: indexing.datasources.items.push

HTTP-Anfrage
Pfadparameter
Anfragetext
- JSON-Darstellung
  - JSON-Darstellung
Antworttext
Autorisierungsbereiche
PushItem <ph type="x-smartling-placeholder">
- JSON-Darstellung
PushItem.Type
Testen!

Verschiebt 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 Konto, 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

Parameter
`item.name`	`string` Der Name der `item`, die in die Warteschlange für die Indexierung übertragen werden soll. Format: datasources/{sourceId}/items/{ID} Dieses Feld ist erforderlich. Die maximale Länge beträgt 1.536 Zeichen.

item.name

string

Der Name der item, die in die Warteschlange für die Indexierung übertragen werden soll.

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

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung

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`) } }

{
  "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äß dem Repository. Wenn angegeben, wird damit festgelegt, wie der Status dieses Elements geändert wird. Das Festlegen dieses Felds und des Felds `type` führt zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`item.structuredDataHash`	`string` Strukturierter Daten-Hash des Elements gemäß Repository. Wenn angegeben, wird damit festgelegt, wie der Status dieses Elements geändert wird. Das Festlegen dieses Felds und des Felds `type` führt zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`item.contentHash`	`string` Inhalts-Hash des Elements gemäß Repository. Wenn angegeben, wird damit festgelegt, wie der Status dieses Elements geändert wird. Das Festlegen dieses Felds und des Felds `type` führt 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` Warteschlange, zu der dieses Element gehört. Wenn dieses Feld nicht angegeben ist, wird die Warteschlange `default` ausgewählt. 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: datasources/{sourceId}/connectors/{ID}
`debugOptions`	`object (DebugOptions)` Gängige Fehlerbehebungsoptionen.

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 werden soll.

JSON-Darstellung

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

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

Felder
`name`	`string` Der Name der `item`, die in die Warteschlange für die Indexierung übertragen werden soll. Format: datasources/{sourceId}/items/{ID} Dieses Feld ist erforderlich. 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äß dem Repository. Wenn angegeben, wird damit festgelegt, wie der Status dieses Elements geändert wird. Das Festlegen dieses Felds und des Felds `type` führt zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`structuredDataHash`	`string` Strukturierter Daten-Hash des Elements gemäß Repository. Wenn angegeben, wird damit festgelegt, wie der Status dieses Elements geändert wird. Das Festlegen dieses Felds und des Felds `type` führt zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`contentHash`	`string` Inhalts-Hash des Elements gemäß Repository. Wenn angegeben, wird damit festgelegt, wie der Status dieses Elements geändert wird. Das Festlegen dieses Felds und des Felds `type` führt 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` Warteschlange, zu der dieses Element gehört. Wenn dieses Feld nicht angegeben ist, wird die Warteschlange `default` ausgewählt. 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 der Status eines vorhandenen Elements in `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 Updateaufruf nicht geändert. Dieser Push-Vorgang setzt den Status auf `ACCEPTED`.
`REPOSITORY_ERROR`	Dem Connector wird ein Repository-Fehler in Bezug auf dieses Element angezeigt. Ändere den Status zu „`REPOSITORY_ERROR`“. Die Reservierung des Elements wurde aufgehoben und der Termin wird zu einem späteren Zeitpunkt verschoben, der durch exponentiellen Backoff bestimmt wird.
`REQUEUE`	Rufen Sie die Push-Übertragung mit REQUEUE nur für Elemente auf, die reserviert wurden. Durch diese Aktion wird die Reservierung des Elements aufgehoben und die verfügbare Zeit auf die tatsächlich verstrichene Zeit zurückgesetzt.