Method: indexing.datasources.items.poll

Опрашивает незарезервированные элементы из очереди индексирования и помечает набор как зарезервированный, начиная с элементов, имеющих самую старую временную метку из ItemStatus с наивысшим приоритетом. Порядок приоритета следующий:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Резервирование элементов гарантирует, что опросы из других потоков не смогут создать перекрывающиеся наборы.

После обработки зарезервированных элементов клиент должен вернуть элементы в незарезервированное состояние либо путем вызова index, либо путем вызова push с типом REQUEUE.

Элементы автоматически становятся доступными (незарезервированными) через 4 часа, даже если не вызывается метод обновления или отправки.

Для выполнения этого API требуется учетная запись администратора или службы. Используемая учетная запись службы находится в белом списке соответствующего источника данных.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Имя источника данных для опроса элементов. Формат: источники данных/{sourceId}

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Поля
connectorName

string

Имя соединителя, выполняющего этот вызов.

Формат: источники данных/{sourceId}/коннекторы/{ID}

statusCodes[]

enum ( ItemStatus.Code )

Ограничьте опрашиваемые элементы только теми, которые имеют эти статусы.

limit

integer

Максимальное количество товаров для возврата.

Максимальное значение — 100, значение по умолчанию — 20.

queue

string

Имя очереди, из которой извлекаются элементы. Если не указано, items.poll будет выбираться из очереди «по умолчанию». Максимальная длина — 100 символов.

debugOptions

object ( DebugOptions )

Общие параметры отладки.

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "items": [
    {
      object (Item)
    }
  ]
}
Поля
items[]

object ( Item )

Набор элементов из очереди, доступных для обработки соединителем.

В этих элементах заполнены следующие подмножества полей:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

Области авторизации

Требуется одна из следующих областей OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .