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
- JSON-Darstellung
PushItem.Type
Testen!

Ein Element wird in eine Warteschlange für spätere Abfragen und Aktualisierungen geschoben.

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter

Parameter
`item.name`	`string` Der Name der `item`, die in die Indexierungswarteschlange geschoben 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 Indexierungswarteschlange geschoben 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 Artikels gemäß dem Repository. Wenn angegeben, wird anhand dieses Attributs festgelegt, wie der Status dieses Elements geändert werden soll. Wenn Sie dieses Feld und das Feld `type` festlegen, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`item.structuredDataHash`	`string` Der Hashwert der strukturierten Daten des Artikels gemäß dem Repository. Wenn angegeben, wird anhand dieses Attributs festgelegt, wie der Status dieses Elements geändert werden soll. Wenn Sie dieses Feld und das Feld `type` festlegen, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`item.contentHash`	`string` Inhalts-Hash des Artikels gemäß dem Repository. Wenn angegeben, wird anhand dieses Attributs festgelegt, wie der Status dieses Elements geändert werden soll. Wenn Sie dieses Feld und das Feld `type` festlegen, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`item.payload`	`string (bytes format)` Bietet zusätzliche Informationen zum Dokumentstatus für den Connector, 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 dieser Artikel 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)` Geben Sie in dieses Feld Details zu Connector- oder Repository-Fehlern ein. Diese Informationen werden in der Admin-Konsole angezeigt. Dieses Feld kann nur ausgefüllt werden, wenn `type` den Wert `REPOSITORY_ERROR` hat.
`connectorName`	`string` Der Name des Connectors, der diesen Aufruf ausführt. Format: datasources/{sourceId}/connectors/{ID}
`debugOptions`	`object (DebugOptions)` Gängige 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 geschoben 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 Indexierungswarteschlange geschoben 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 Artikels gemäß dem Repository. Wenn angegeben, wird anhand dieses Attributs festgelegt, wie der Status dieses Elements geändert werden soll. Wenn Sie dieses Feld und das Feld `type` festlegen, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`structuredDataHash`	`string` Der Hashwert der strukturierten Daten des Artikels gemäß dem Repository. Wenn angegeben, wird anhand dieses Attributs festgelegt, wie der Status dieses Elements geändert werden soll. Wenn Sie dieses Feld und das Feld `type` festlegen, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`contentHash`	`string` Inhalts-Hash des Artikels gemäß dem Repository. Wenn angegeben, wird anhand dieses Attributs festgelegt, wie der Status dieses Elements geändert werden soll. Wenn Sie dieses Feld und das Feld `type` festlegen, führt dies zu einem Argumentfehler. Die maximale Länge beträgt 2.048 Zeichen.
`payload`	`string (bytes format)` Bietet zusätzliche Informationen zum Dokumentstatus für den Connector, 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 dieser Artikel 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)` Geben Sie in dieses Feld Details zu Connector- oder Repository-Fehlern ein. Diese Informationen werden in der Admin-Konsole angezeigt. Dieses Feld kann 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 `ItemStatus` durch den Push-Vorgang nicht geändert werden soll.
`MODIFIED`	Gibt an, dass das Repository-Dokument seit dem letzten `update`-Aufruf geändert oder aktualisiert wurde. Dadurch ändert sich der Status eines vorhandenen Artikels in `MODIFIED`. Wenn diese Funktion für ein nicht vorhandenes Element aufgerufen wird, ändert sich der Status zu `NEW_ITEM`.
`NOT_MODIFIED`	Das Element im Repository wurde seit dem letzten Updateaufruf nicht geändert. Durch diesen Push-Vorgang wird der Status auf `ACCEPTED` gesetzt.
`REPOSITORY_ERROR`	Beim Connector ist ein Repositoryfehler für dieses Element aufgetreten. Ändern Sie den Status in `REPOSITORY_ERROR`. Der Artikel wird nicht reserviert und zu einem zukünftigen Zeitpunkt neu geplant, der durch exponentielles Backoff bestimmt wird.
`REQUEUE`	Rufe Push mit REQUEUE nur für Artikel auf, die reserviert wurden. Dadurch wird die Reservierung des Artikels aufgehoben und die Verfügbarkeit auf die aktuelle Uhrzeit zurückgesetzt.