Method: indexing.datasources.items.poll

Es wird nach nicht reservierten Elementen in der Indexierungswarteschlange gesucht und ein Satz wird als reserviert markiert, beginnend mit den Elementen mit dem ältesten Zeitstempel der höchsten Priorität ItemStatus. Die Prioritätsreihenfolge ist folgende:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Durch die Reservierung von Elementen wird verhindert, dass durch Abfragen aus anderen Threads sich überschneidende Sätze erstellen lassen.

Nachdem der Kunde die reservierten Artikel bearbeitet hat, sollte er sie wieder in den Status „Nicht reserviert“ versetzen. Rufe dazu entweder index, oder push mit dem Typ REQUEUE. auf.

Artikel werden nach 4 Stunden automatisch wieder verfügbar (nicht mehr reserviert), auch wenn keine Update- oder Push-Methode aufgerufen wird.

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/{name=datasources/*}/items:poll

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Der Name der Datenquelle, für die Elemente abgefragt werden sollen. Format: datasources/{sourceId}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Felder
connectorName

string

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

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

statusCodes[]

enum (ItemStatus.Code)

Beschränken Sie die abgefragten Elemente auf die mit diesen Status.

limit

integer

Die maximale Anzahl der Elemente, die zurückgegeben werden sollen.

Der Maximalwert ist 100 und der Standardwert ist 20.

queue

string

Name der Warteschlange, aus der Elemente abgerufen werden sollen. Wenn keine Angabe gemacht wird, wird „items.poll“ aus der Warteschlange „default“ abgerufen. Die maximale Länge beträgt 100 Zeichen.

debugOptions

object (DebugOptions)

Gängige Optionen zur Fehlerbehebung

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung
{
  "items": [
    {
      object (Item)
    }
  ]
}
Felder
items[]

object (Item)

Elemente aus der Warteschlange, die vom Connector verarbeitet werden können.

Für diese Elemente sind die folgenden Felder ausgefüllt:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

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.