Method: indexing.datasources.items.index

Actualiza la LCA, los metadatos y el contenido de Item. Insertará el Item si no existe. Este método no admite actualizaciones parciales. Los campos sin valores proporcionados se borran del índice de Cloud Search.

Esta API requiere una cuenta de administrador o de servicio para ejecutarse. La cuenta de servicio que se usa es la que se incluye en la lista de entidades permitidas de la fuente de datos correspondiente.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
item.name

string

Es el nombre del artículo. Formato: datasources/{sourceId}/items/{itemId}

Este es un campo obligatorio. La longitud máxima es de 1,536 caracteres.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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)

Es la lista de control de acceso de este elemento.
item.metadata

object (ItemMetadata)

La información de los metadatos
item.structuredData

object (ItemStructuredData)

Son los datos estructurados del elemento que deben cumplir con una definición de objeto registrada en el esquema de la fuente de datos.
item.content

object (ItemContent)

Es el contenido del elemento que se indexará y que se podrá buscar en el texto.
item.version

string (bytes format)

Obligatorio. El sistema de indexación almacena la versión de la fuente de datos como una cadena de bytes y compara la versión del artículo en el índice con la versión del artículo en cola mediante el orden léxico.

La indexación de Cloud Search no indexará ni borrará ningún elemento en cola con un valor de versión que sea menor o igual que la versión del elemento indexado actualmente. La longitud máxima de este campo es de 1,024 bytes.

Para obtener información sobre cómo la versión del elemento afecta el proceso de eliminación, consulta Cómo controlar las revisiones después de las eliminaciones manuales.

String codificada en base64.
item.status

object (ItemStatus)

Estado del artículo. Es un campo de solo salida.
item.queue

string

Es la cola a la que pertenece este elemento. La longitud máxima es de 100 caracteres.
item.payload

string (bytes format)

El conector de estado adicional puede almacenar para este elemento. La longitud máxima es de 10,000 bytes.

String codificada en base64.
item.itemType

enum (Item.ItemType)

Es el tipo de este elemento.
connectorName

string

Es el nombre del conector que realiza esta llamada.

Formato: datasources/{sourceId}/connectors/{ID}
mode

enum (RequestMode.Mode)

Obligatorio. El RequestMode de esta solicitud.
debugOptions

object (DebugOptions)

Opciones de depuración comunes.
indexItemOptions

object (IndexItemOptions)

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.

IndexItemOptions

Representación JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
Campos
allowUnknownGsuitePrincipals

boolean

Especifica si la solicitud de indexación debe permitir principales de Google Workspace que no existen o se borran.