Method: indexing.datasources.items.poll

Wyszukuje niezarezerwowane elementy z kolejki indeksowania i oznacza zestaw jako zarezerwowany, zaczynając od elementów, które mają najstarszą sygnaturę czasową od elementu ItemStatus o najwyższym priorytecie. Ich priorytet jest następujący:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Zarezerwowanie elementów gwarantuje, że odpytywanie z innych wątków nie może tworzyć nakładających się zestawów.

Po obsłudze zarezerwowanych elementów klient powinien przywrócić je do stanu niezarezerwowanego, wywołując index, lub wywołując push typu REQUEUE.

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

Do wykonania tego interfejsu API wymagane jest konto administratora lub konto usługi. Użyte konto usługi 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 służącego do ankietowania elementów. Format: źródła danych/{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: źródła danych/{sourceId}/oprogramowanie sprzęgające/{ID}
statusCodes[]

enum (ItemStatus.Code)

Ogranicz ankietowane elementy do tych o tym stanie.
limit

integer

Maksymalna liczba produktó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 określono inaczej, plik items.poll zostanie pobrany z kolejki „default”. 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)

Zbiór elementów z kolejki dostępnych do przetworzenia przez oprogramowanie sprzęgające.

Te elementy mają wypełniony podzbiór pól:

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 po autoryzacji.