Method: indexing.datasources.items.poll

Wypytuje o niezarezerwowane elementy z kolejki indeksowania i oznacza zestaw jako zarezerwowany, zaczynając od elementów o najstarszym sygnaturze czasowej o najwyższym priorytecie ItemStatus. Kolejność priorytetów:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Rezerwowanie elementów zapewnia, że odpytywanie z innych wątków nie może tworzyć nakładających się zbiorów.

Po obsłudze zablokowanych elementów klient powinien przywrócić je do stanu niezablokowanego, wywołując funkcję index, lub push z typem REQUEUE..

Produkty stają się automatycznie dostępne (niezarezerwowane) po 4 godzinach, nawet jeśli nie zostanie wywołana żadna metoda aktualizacji ani metoda push.

Do wykonania tej operacji wymagane jest konto administratora lub konto usługi. Używane konto usługi to to, które znajduje się na białej liście w odpowiednim źródle danych.

Żądanie HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Nazwa źródła danych, z którego mają być pobierane informacje. Format: datasources/{sourceId}

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

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

string

Nazwa oprogramowania sprzęgającego wykonującego to wywołanie.

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

statusCodes[]

enum (ItemStatus.Code)

Ogranicz elementy do tych, które mają te stany.

limit

integer

Maksymalna liczba elementów do zwrócenia.

Maksymalna wartość to 100, a wartość domyślna to 20.

queue

string

Nazwa kolejki, z której mają być pobierane elementy. Jeśli nie podasz tego parametru, funkcja items.poll pobiera dane z kolejki „domyślnej”. Maksymalna długość to 100 znaków.

debugOptions

object (DebugOptions)

Typowe opcje debugowania.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "items": [
    {
      object (Item)
    }
  ]
}
Pola
items[]

object (Item)

Zestaw elementów z kolejki dostępnych dla usługi do przetwarzania.

Te elementy mają wypełnione te pola:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.