Method: indexing.datasources.items.index

Обновляет список управления доступом Item , метаданные и содержимое. Он вставит Item , если он не существует. Этот метод не поддерживает частичные обновления. Поля, в которых не указаны значения, удаляются из индекса Cloud Search.

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

HTTP-запрос

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

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

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

Параметры
item.name

string

Название предмета. Формат: источники данных/{sourceId}/items/{itemId}

Это обязательное поле. Максимальная длина — 1536 символов.

Тело запроса

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

JSON-представление 
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "title": string,
      "sourceRepositoryUrl": string,
      "containerName": string,
      "objectType": string,
      "createTime": string,
      "updateTime": string,
      "interactions": [
        {
          object (Interaction)
        }
      ],
      "contentLanguage": string,
      "mimeType": string,
      "searchQualityMetadata": {
        object (SearchQualityMetadata)
      },
      "keywords": [
        string
      ],
      "hash": string,
      "contextAttributes": [
        {
          object (ContextAttribute)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "contentFormat": enum (ItemContent.ContentFormat),
      "hash": string,

      // Union field content can be only one of the following:
      "inlineContent": string,
      "contentDataRef": {
        object (UploadItemRef)
      }
      // End of list of possible types for union field content.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
Поля
item.acl

object ( ItemAcl )

Список контроля доступа для этого элемента.

item.metadata

object ( ItemMetadata )

Информация метаданных.

item.structuredData

object ( ItemStructuredData )

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

item.content

object ( ItemContent )

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

item.version

string ( bytes format)

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

Индексирование Cloud Search не будет индексировать или удалять элементы в очереди, значение версии которых меньше или равно версии текущего индексируемого элемента. Максимальная длина этого поля составляет 1024 байта.

Информацию о том, как версия элемента влияет на процесс удаления, см. в разделе Обработка редакций после удаления вручную .

Строка в кодировке Base64.

item.status

object ( ItemStatus )

Статус предмета. Поле только для вывода.

item.queue

string

Очередь, к которой принадлежит этот элемент. Максимальная длина — 100 символов.

item.payload

string ( bytes format)

Для этого элемента может храниться дополнительный коннектор состояния. Максимальная длина — 10000 байт.

Строка в кодировке Base64.

item.itemType

enum ( Item.ItemType )

Тип этого элемента.

connectorName

string

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

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

mode

enum ( RequestMode.Mode )

Необходимый. RequestMode для этого запроса.

debugOptions

object ( DebugOptions )

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

indexItemOptions

object ( IndexItemOptions )

Тело ответа

В случае успеха тело ответа содержит экземпляр Operation .

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

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

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

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

Индекситемварианты

JSON-представление 
{
  "allowUnknownGsuitePrincipals": boolean
}
Поля
allowUnknownGsuitePrincipals

boolean

Указывает, должен ли запрос индекса разрешать несуществующие или удаленные субъекты Google Workspace.