Method: indexing.datasources.items.push

Envía un elemento a una cola para sondear y actualizar más tarde.

Para ejecutar esta API, se requiere una cuenta de administrador o de servicio. La cuenta de servicio que se usa es la que está incluida en la lista blanca de la fuente de datos correspondiente.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
item.name

string

El nombre de la item que se enviará a la cola de indexación.

Formato: fuentes de datos/{sourceId}/items/{ID}

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,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Campos
item.type

enum (PushItem.Type)

El tipo de operación de envío que define el comportamiento de envío.
item.metadataHash

string

El hash de metadatos del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo type, se generará un error de argumento. La longitud máxima es de 2,048 caracteres.
item.structuredDataHash

string

Hash de datos estructurados del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo type, se generará un error de argumento. La longitud máxima es de 2,048 caracteres.
item.contentHash

string

Hash de contenido del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo type, se generará un error de argumento. La longitud máxima es de 2,048 caracteres.
item.payload

string (bytes format)

Proporciona información adicional sobre el estado del documento para el conector, como un ID de repositorio alternativo y otros metadatos. La longitud máxima es 8,192 bytes.

String codificada en base64.
item.queue

string

Fila a la que pertenece este elemento. Si no se especifica este campo, se elige la cola de default. La longitud máxima es de 512 caracteres.
item.repositoryError

object (RepositoryError)

Propaga este campo para almacenar los detalles de los errores del conector o del repositorio. Esta información se muestra en la Consola del administrador. Este campo solo se puede completar cuando type es REPOSITORY_ERROR.
connectorName

string

El nombre del conector que realiza esta llamada.

Formato: fuentes de datos/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

Opciones de depuración comunes.

Cuerpo de la respuesta

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

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.

PushItem

Representa un elemento que se enviará a la cola de indexación.

Representación JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Campos
name

string

El nombre de la item que se enviará a la cola de indexación.

Formato: fuentes de datos/{sourceId}/items/{ID}

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

enum (PushItem.Type)

El tipo de operación de envío que define el comportamiento de envío.
metadataHash

string

El hash de metadatos del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo type, se generará un error de argumento. La longitud máxima es de 2,048 caracteres.
structuredDataHash

string

Hash de datos estructurados del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo type, se generará un error de argumento. La longitud máxima es de 2,048 caracteres.
contentHash

string

Hash de contenido del elemento según el repositorio. Si se especifica, se usa para determinar cómo modificar el estado de este elemento. Si configuras este campo y el campo type, se generará un error de argumento. La longitud máxima es de 2,048 caracteres.
payload

string (bytes format)

Proporciona información adicional sobre el estado del documento para el conector, como un ID de repositorio alternativo y otros metadatos. La longitud máxima es 8,192 bytes.

String codificada en base64.
queue

string

Fila a la que pertenece este elemento. Si no se especifica este campo, se elige la cola de default. La longitud máxima es de 512 caracteres.
repositoryError

object (RepositoryError)

Propaga este campo para almacenar los detalles de los errores del conector o del repositorio. Esta información se muestra en la Consola del administrador. Este campo solo se puede completar cuando type es REPOSITORY_ERROR.

PushItem.Type

El tipo de operación de envío que define el comportamiento de envío.

Enumeraciones
UNSPECIFIED Predeterminado: UNSPECIFIED. Especifica que la operación de envío no debe modificar ItemStatus.
MODIFIED Indica que se modificó o actualizó el documento del repositorio desde la llamada anterior a update. Esto cambia el estado de un elemento existente a MODIFIED. Si se llama a este método en un elemento no existente, el estado cambia a NEW_ITEM.
NOT_MODIFIED No se modificó el elemento del repositorio desde la última llamada de actualización. Esta operación de envío establecerá el estado en ACCEPTED.
REPOSITORY_ERROR El conector enfrenta un error de repositorio en relación con este elemento. Cambia el estado a REPOSITORY_ERROR. El artículo no está reservado y se reprograma en un momento futuro determinado por la retirada exponencial.
REQUEUE Llama al envío con REQUEUE solo para los elementos que se reservaron. Esta acción deja de reservar el elemento y restablece su hora disponible al reloj de pared.