Method: indexing.datasources.items.push

Inserisce un elemento in una coda per il successivo polling e aggiornamento.

Per l'esecuzione di questa API è necessario un account amministratore o un account di servizio. L'account di servizio utilizzato è quello inserito nella lista consentita 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 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 genera un errore di argomento. La lunghezza massima è di 2048 caratteri.
item.structuredDataHash

string

Hash dei dati strutturati 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 genera un errore di argomento. La lunghezza massima è di 2048 caratteri.
item.contentHash

string

Hash dei contenuti 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 genera un errore di argomento. La lunghezza massima è di 2048 caratteri.
item.payload

string (bytes format)

Fornisce informazioni aggiuntive sullo stato del documento per il connettore, ad esempio un ID repository alternativo e altri metadati. La lunghezza massima è di 8192 byte.

Una stringa con codifica Base64.
item.queue

string

La coda a cui appartiene questo elemento. La coda default viene scelta se questo campo non è specificato. La lunghezza massima è di 512 caratteri.
item.repositoryError

object (RepositoryError)

Compila questo campo per memorizzare i dettagli degli errori del connettore o del repository. Queste informazioni vengono visualizzate nella Console di amministrazione. Questo campo può essere compilato solo quando type è REPOSITORY_ERROR.
connectorName

string

Il nome del connettore che effettua questa 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 inviare 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 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 genera un errore di argomento. La lunghezza massima è di 2048 caratteri.
structuredDataHash

string

Hash dei dati strutturati 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 genera un errore di argomento. La lunghezza massima è di 2048 caratteri.
contentHash

string

Hash dei contenuti 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 genera un errore di argomento. La lunghezza massima è di 2048 caratteri.
payload

string (bytes format)

Fornisce informazioni aggiuntive sullo stato del documento per il connettore, ad esempio un ID repository alternativo e altri metadati. La lunghezza massima è di 8192 byte.

Una stringa con codifica Base64.
queue

string

La coda a cui appartiene questo elemento. La coda default viene scelta se questo campo non è specificato. La lunghezza massima è di 512 caratteri.
repositoryError

object (RepositoryError)

Compila questo campo per memorizzare i dettagli degli errori del connettore o del repository. Queste informazioni vengono visualizzate nella Console di amministrazione. Questo campo può essere compilato solo quando type è REPOSITORY_ERROR.

PushItem.Type

Il tipo di operazione push che definisce il comportamento push.

Enum
UNSPECIFIED Valore predefinito UNSPECIFIED. Specifica che l'operazione di push non deve modificare ItemStatus
MODIFIED Indica che il documento del repository è stato modificato o aggiornato dalla chiamata update precedente. Lo stato di un elemento esistente viene modificato in MODIFIED. Se viene chiamato 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 push imposterà lo stato su ACCEPTED.
REPOSITORY_ERROR Il connettore ha riscontrato un errore del repository relativo a questo elemento. Modifica lo stato in REPOSITORY_ERROR. L'elemento non è prenotato e viene riprogrammato in un momento futuro determinato dal backoff esponenziale.
REQUEUE Esegui una chiamata push con REQUEUE solo per gli elementi che sono stati prenotati. Questa azione annulla la prenotazione dell'articolo e reimposta la relativa ora disponibile sull'ora del sistema.