Method: indexing.datasources.items.poll

Führt eine Abfrage auf nicht reservierte Elemente aus der Indexierungswarteschlange durch und markiert eine Gruppe als reserviert, wobei die Elemente mit dem ältesten Zeitstempel der höchsten Priorität (ItemStatus) beginnen. Die Prioritätsreihenfolge lautet wie folgt:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Durch das Reservieren von Elementen wird sichergestellt, dass beim Abfragen von anderen Threads keine überlappenden Sätze erstellt werden.

Nach der Verarbeitung der reservierten Elemente sollte der Client die Elemente wieder in den nicht reservierten Status versetzen, entweder durch Aufrufen von index, oder durch Aufrufen von push mit dem Typ REQUEUE.

Elemente sind nach 4 Stunden automatisch verfügbar (nicht reserviert), auch wenn kein Update oder keine Push-Methode aufgerufen wird.

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Der Name der Datenquelle, von der 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 durchführt.

Format: Datenquellen/{Quell-ID}/Connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

Beschränken Sie die abgefragten Elemente auf diejenigen mit diesem Status.
limit

integer

Maximale Anzahl der Artikel, die zurückgegeben werden sollen.

Der Maximalwert beträgt 100 und der Standardwert 20.
queue

string

Name der Warteschlange, aus der Elemente abgerufen werden sollen. Wenn keine Angabe erfolgt, ruft „items.poll“ aus der „Standardwarteschlange“ ab. Die maximale Länge beträgt 100 Zeichen.
debugOptions

object (DebugOptions)

Häufig verwendete 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)

Gruppe von Elementen aus der Warteschlange, die vom Connector verarbeitet werden können.

Für diese Elemente ist die folgende Teilmenge von Feldern 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.