Method: indexing.datasources.items.push

Invia un elemento in una coda per il polling e l'aggiornamento successivi.

L'esecuzione di questa API richiede un account amministratore o di servizio. L'account di servizio utilizzato è quello consentito nell'origine dati corrispondente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
item.name

string

Il nome del item da inserire nella coda di indicizzazione.

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

Questo campo è obbligatorio. La lunghezza massima è di 1536 caratteri.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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)
  }
}
Campi
item.type

enum (PushItem.Type)

Il tipo di operazione push che definisce il comportamento di push.
item.metadataHash

string

L'hash dei metadati dell'elemento in base al repository. Se specificato, viene utilizzato per determinare come modificare lo stato dell'elemento. L'impostazione di questo campo e del campo type restituisce un errore di argomento. La lunghezza massima è di 2048 caratteri.
item.structuredDataHash

string

Hash dei dati strutturati dell'elemento secondo il repository. Se specificato, viene utilizzato per determinare come modificare lo stato dell'elemento. L'impostazione di questo campo e del campo type restituisce un errore di argomento. La lunghezza massima è di 2048 caratteri.
item.contentHash

string

Hash dei contenuti dell'elemento secondo il repository. Se specificato, viene utilizzato per determinare come modificare lo stato dell'elemento. L'impostazione di questo campo e del campo type restituisce un errore di argomento. La lunghezza massima è di 2048 caratteri.
item.payload

string (bytes format)

Fornisce ulteriori informazioni sullo stato dei documenti per il connettore, ad esempio un ID repository alternativo e altri metadati. La lunghezza massima è 8192 byte.

Una stringa con codifica base64.
item.queue

string

Coda a cui appartiene l'elemento. Se questo campo non viene specificato, viene scelta la coda default. La lunghezza massima è di 512 caratteri.
item.repositoryError

object (RepositoryError)

Compila questo campo per archiviare i dettagli dell'errore del connettore o del repository. Queste informazioni vengono visualizzate nella Console di amministrazione. Questo campo può essere compilato solo se il valore di type è REPOSITORY_ERROR.
connectorName

string

Il nome del connettore che effettua la chiamata.

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

object (DebugOptions)

Opzioni di debug comuni.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Item.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

PushItem

Rappresenta un elemento da trasferire alla coda di indicizzazione.

Rappresentazione JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Campi
name

string

Il nome del item da inserire nella coda di indicizzazione.

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

Questo campo è obbligatorio. La lunghezza massima è di 1536 caratteri.
type

enum (PushItem.Type)

Il tipo di operazione push che definisce il comportamento di push.
metadataHash

string

L'hash dei metadati dell'elemento in base al repository. Se specificato, viene utilizzato per determinare come modificare lo stato dell'elemento. L'impostazione di questo campo e del campo type restituisce un errore di argomento. La lunghezza massima è di 2048 caratteri.
structuredDataHash

string

Hash dei dati strutturati dell'elemento secondo il repository. Se specificato, viene utilizzato per determinare come modificare lo stato dell'elemento. L'impostazione di questo campo e del campo type restituisce un errore di argomento. La lunghezza massima è di 2048 caratteri.
contentHash

string

Hash dei contenuti dell'elemento secondo il repository. Se specificato, viene utilizzato per determinare come modificare lo stato dell'elemento. L'impostazione di questo campo e del campo type restituisce un errore di argomento. La lunghezza massima è di 2048 caratteri.
payload

string (bytes format)

Fornisce ulteriori informazioni sullo stato dei documenti per il connettore, ad esempio un ID repository alternativo e altri metadati. La lunghezza massima è 8192 byte.

Una stringa con codifica base64.
queue

string

Coda a cui appartiene l'elemento. Se questo campo non viene specificato, viene scelta la coda default. La lunghezza massima è di 512 caratteri.
repositoryError

object (RepositoryError)

Compila questo campo per archiviare i dettagli dell'errore del connettore o del repository. Queste informazioni vengono visualizzate nella Console di amministrazione. Questo campo può essere compilato solo se il valore di type è REPOSITORY_ERROR.

PushItem.Type

Il tipo di operazione push che definisce il comportamento di push.

Enum
UNSPECIFIED Predefinito UNSPECIFIED. Specifica che l'operazione push non deve modificare ItemStatus
MODIFIED Indica che il documento del repository è stato modificato o aggiornato dopo la chiamata update precedente. Questo modifica lo stato in MODIFIED per un elemento esistente. Se questa funzionalità viene richiamata per un elemento non esistente, lo stato viene modificato in NEW_ITEM.
NOT_MODIFIED L'elemento nel repository non è stato modificato dall'ultima chiamata di aggiornamento. Questa operazione di push imposterà lo stato sullo stato ACCEPTED.
REPOSITORY_ERROR Il connettore sta riscontrando un errore del repository relativo a questo elemento. Cambia lo stato impostandolo su REPOSITORY_ERROR. La prenotazione dell'elemento viene annullata e viene ripianificata in un momento futuro determinato dal backoff esponenziale.
REQUEUE Chiama il push con REQUEUE solo per gli elementi che sono stati prenotati. Questa azione annulla la prenotazione dell'articolo e reimposta il suo orario disponibile all'ora reale.