Method: indexing.datasources.items.index

Aggiorna Item ACL, metadati e contenuti. Inserisce Item se non esiste. Questo metodo non supporta gli aggiornamenti parziali. I campi senza valori forniti vengono cancellati nell'indice di Cloud Search.

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

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
item.name

string

Il nome dell'articolo. Formato: datasources/{sourceId}/items/{itemId}

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,
    "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)
  }
}
Campi
item.acl

object (ItemAcl)

Elenco di controllo di accesso per questo elemento.
item.metadata

object (ItemMetadata)

Le informazioni sui metadati.
item.structuredData

object (ItemStructuredData)

I dati strutturati per l'elemento che devono essere conformi a una definizione di oggetto registrato nello schema dell'origine dati.
item.content

object (ItemContent)

Contenuti dell'elemento da indicizzare e rendere il testo disponibile per la ricerca.
item.version

string (bytes format)

Obbligatorio. Il sistema di indicizzazione archivia la versione dall'origine dati come stringa di byte e confronta la versione dell'elemento nell'indice con la versione dell'elemento in coda utilizzando l'ordinamento lessicale.

L'indicizzazione di Cloud Search non indicizza né elimina gli elementi in coda con un valore di versione inferiore o uguale alla versione dell'elemento attualmente indicizzato. La lunghezza massima per questo campo è 1024 byte.

Per informazioni su come la versione di un elemento influisce sul processo di eliminazione, consulta l'articolo Gestire le revisioni dopo le eliminazioni manuali.

Una stringa con codifica Base64.
item.status

object (ItemStatus)

Lo stato dell'articolo. Campo di solo output.
item.queue

string

Coda a cui appartiene questo elemento. La lunghezza massima è di 100 caratteri.
item.payload

string (bytes format)

Il connettore di stato aggiuntivo può archiviare questo elemento. La lunghezza massima è di 10.000 byte.

Una stringa con codifica Base64.
item.itemType

enum (Item.ItemType)

Il tipo di questo elemento.
connectorName

string

Il nome del connettore che effettua la chiamata.

Formato: origini dati/{sourceId}/connectors/{ID}
mode

enum (RequestMode.Mode)

Obbligatorio. Il valore RequestMode per questa richiesta.
debugOptions

object (DebugOptions)

Opzioni di debug comuni.
indexItemOptions

object (IndexItemOptions)

Corpo della risposta

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

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 alle autorizzazioni.

IndexItemOptions

Rappresentazione JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
Campi
allowUnknownGsuitePrincipals

boolean

Specifica se la richiesta di indicizzazione deve consentire entità Google Workspace che non esistono o sono state eliminate.