Method: indexing.datasources.items.push

Envía un elemento a una cola para consultarlo y actualizarlo más tarde.

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/*}:push

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 item que se enviará a la cola de indexación.

Formato: datasources/{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)

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

string

Es 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 producirá un error de argumento. La longitud máxima es de 2,048 caracteres.
item.structuredDataHash

string

Es el hash de datos estructurados del artículo 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 producirá un error de argumento. La longitud máxima es de 2,048 caracteres.
item.contentHash

string

Es el 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 producirá un error de argumento. La longitud máxima es de 2,048 caracteres.
item.payload

string (bytes format)

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

String codificada en base64.
item.queue

string

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

object (RepositoryError)

Completa 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 propagar cuando type es REPOSITORY_ERROR.
connectorName

string

Es el nombre del conector que realiza esta llamada.

Formato: datasources/{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

Es el nombre del item que se enviará a la cola de indexación.

Formato: datasources/{sourceId}/items/{ID}

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

enum (PushItem.Type)

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

string

Es 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 producirá un error de argumento. La longitud máxima es de 2,048 caracteres.
structuredDataHash

string

Es el hash de datos estructurados del artículo 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 producirá un error de argumento. La longitud máxima es de 2,048 caracteres.
contentHash

string

Es el 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 producirá un error de argumento. La longitud máxima es de 2,048 caracteres.
payload

string (bytes format)

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

String codificada en base64.
queue

string

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

object (RepositoryError)

Completa 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 propagar cuando type es REPOSITORY_ERROR.

PushItem.Type

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

Enumeraciones
UNSPECIFIED El valor predeterminado es UNSPECIFIED. Especifica que la operación de envío no debe modificar ItemStatus.
MODIFIED Indica que el documento del repositorio se modificó o actualizó desde la llamada update anterior. Esto cambia el estado a MODIFIED para un elemento existente. Si se llama a esta función en un elemento que no existe, el estado cambia a NEW_ITEM.
NOT_MODIFIED El elemento del repositorio no se modificó desde la última llamada de actualización. Esta operación de envío establecerá el estado en ACCEPTED.
REPOSITORY_ERROR El conector tiene un error de repositorio relacionado con este elemento. Cambia el estado a REPOSITORY_ERROR. El elemento se desreserva y se reprograma para una hora futura determinada por la retirada exponencial.
REQUEUE Realiza una llamada push con REQUEUE solo para los elementos que se reservaron. Esta acción anula la reserva del elemento y restablece su tiempo disponible a la hora del reloj.