Method: indexing.datasources.items.index

Atualiza a ACL, os metadados e o conteúdo do Item. A Item será inserida se ela não existir. Esse método não oferece suporte a atualizações parciais. Os campos sem valores fornecidos são apagados do índice do Cloud Search.

Esta API requer uma conta de administrador ou de serviço para ser executada. A conta de serviço usada está na lista de permissões da fonte de dados correspondente.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
item.name

string

O nome do item. Formato: fontes de dados/{sourceId}/items/{itemId}

Este campo é obrigatório. O tamanho máximo é de 1.536 caracteres.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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)
  }
}
Campos
item.acl

object (ItemAcl)

Lista de controle de acesso para este item.
item.metadata

object (ItemMetadata)

As informações dos metadados.
item.structuredData

object (ItemStructuredData)

São os dados estruturados do item que precisam estar em conformidade com uma definição de objeto registrado no esquema da fonte de dados.
item.content

object (ItemContent)

Conteúdo do item a ser indexado e o texto pesquisável.
item.version

string (bytes format)

Obrigatório. O sistema de indexação armazena a versão da fonte de dados como uma string de bytes e compara a versão do item no índice com a versão do item na fila usando a ordem léxica.

A indexação do Cloud Search não indexa nem exclui itens na fila com um valor de versão menor ou igual à versão do item indexado no momento. O tamanho máximo desse campo é de 1.024 bytes.

Para mais informações sobre como a versão do item afeta o processo de exclusão, consulte Processar revisões após exclusões manuais.

Uma string codificada em base64.
item.status

object (ItemStatus)

Status do item. Campo somente de saída.
item.queue

string

Colocar este item na fila. O comprimento máximo é de 100 caracteres.
item.payload

string (bytes format)

O conector de estado adicional pode armazenar para este item. O tamanho máximo é de 10.000 bytes.

Uma string codificada em base64.
item.itemType

enum (Item.ItemType)

O tipo deste item.
connectorName

string

O nome do conector que está fazendo a chamada.

Formato: fontes de dados/{sourceId}/connectors/{ID}
mode

enum (RequestMode.Mode)

Obrigatório. O RequestMode para esta solicitação.
debugOptions

object (DebugOptions)

Opções comuns de depuração.
indexItemOptions

object (IndexItemOptions)

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o Guia de autorização.

IndexItemOptions

Representação JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
Campos
allowUnknownGsuitePrincipals

boolean

Especifica se a solicitação de índice vai permitir principais do Google Workspace que não existem ou foram excluídos.