Method: indexing.datasources.items.poll

Führt eine Abfrage für nicht reservierte Elemente aus der Indexierungswarteschlange durch und markiert einen Satz als reserviert, beginnend mit den Elementen mit dem ältesten Zeitstempel aus der höchsten Priorität ItemStatus. Die Prioritätsreihenfolge sieht so aus:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Durch das Reservieren von Elementen wird sichergestellt, dass Abfragen von anderen Threads keine überlappenden Sets erstellen können.

Nach der Verarbeitung der reservierten Elemente sollte der Client die Elemente in den nicht reservierten Zustand zurückversetzen, entweder durch Aufrufen von index, oder durch Aufrufen von push des Typs REQUEUE.

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

Zum Ausführen dieser API ist ein Administrator oder Dienstkonto erforderlich. Es wird das Dienstkonto verwendet, das in der entsprechenden Datenquelle auf der weißen Liste steht.

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 Umfrageelemente erstellt 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: datasources/{sourceId}/connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

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

integer

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

Der Höchstwert ist 100 und der Standardwert 20.
queue

string

Name der Warteschlange, aus der Elemente abgerufen werden sollen. Wenn nicht angegeben, wird „items.poll“ von „default“ abgerufen in die Warteschlange stellen. Die maximale Länge beträgt 100 Zeichen.
debugOptions

object (DebugOptions)

Gängige Fehlerbehebungsoptionen.

Antworttext

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

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

object (Item)

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

Bei diesen Elementen sind folgende Felder bereits 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.