REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

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

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

object (ItemAcl)

Elenco di controllo dell'accesso per questo elemento.

object (ItemMetadata)

Le informazioni sui metadati.

object (ItemStructuredData)

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

object (ItemContent)

Contenuti degli elementi da indicizzare e rendere il testo disponibile per la ricerca.

string (bytes format)

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

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

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

Una stringa con codifica base64.

object (ItemStatus)

Stato dell'articolo. Campo di solo output.

string

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

string (bytes format)

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

Una stringa con codifica base64.

enum (Item.ItemType)

Il tipo di questo elemento.

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

Il nome dell'elemento da cui ereditare l'elenco di autorizzazioni di accesso (ACL). Nota: l'ereditarietà ACL fornisce le autorizzazioni di accesso solo agli elementi secondari e non definisce relazioni strutturali, né offre metodi comodi per eliminare grandi gruppi di elementi. L'eliminazione di un elemento padre ACL dall'indice modifica solo le autorizzazioni di accesso degli elementi secondari che fanno riferimento all'elemento principale nel campo inheritAclFrom. L'elemento è ancora nell'indice, ma potrebbe non essere visibile nei risultati di ricerca. Al contrario, l'eliminazione di un elemento contenitore comporta anche l'eliminazione di tutti gli elementi che fanno riferimento al contenitore tramite il campo containerName. La lunghezza massima per questo campo è 1536 caratteri.

enum (ItemAcl.AclInheritanceType)

Consente di impostare il tipo di regole di accesso da applicare quando un elemento eredita l'ACL da un elemento padre. Deve sempre essere impostato insieme al campo inheritAclFrom. Inoltre, se viene impostato il campo inheritAclFrom, questo campo deve essere impostato su un valore AclInheritanceType valido.

object (Principal)

Elenco di entità autorizzate a visualizzare l'elemento nei risultati di ricerca. Facoltativo se si ereditano le autorizzazioni da un altro elemento o se l'elemento non deve essere visibile, ad esempio virtual containers. Il numero massimo di elementi è 1000.

object (Principal)

Elenco delle entità a cui è stato negato in modo esplicito l'accesso all'elemento nei risultati di ricerca. Mentre alle entità viene negato l'accesso per impostazione predefinita, usa i lettori negati per gestire le eccezioni e sostituire l'elenco dei lettori consentiti. Il numero massimo di elementi è 100.

object (Principal)

(Facoltativo) Elenco dei proprietari dell'elemento. Questo campo non influisce sulle autorizzazioni di accesso ai documenti. Tuttavia, offre un leggero ranking degli elementi in cui l'utente che ha eseguito la query è un proprietario. Il numero massimo di elementi è 5.

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object (GSuitePrincipal)

Questa entità è un utente, un gruppo o un dominio di Google Workspace.

string

Questa entità è un utente identificato utilizzando un'identità esterna. Il campo name deve specificare il nome della risorsa utente con questo formato: Identitysources/{sourceId}/users/{ID}

string

Questa entità è un gruppo identificato utilizzando un'identità esterna. Il campo Name deve specificare il nome della risorsa del gruppo con il seguente formato: Identitysources/{sourceId}/groups/{ID}

{
  "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)
    }
  ]
}

string

Il titolo dell'articolo. Se specificato, sarà il titolo visualizzato del risultato query.search. La lunghezza massima è di 2048 caratteri.

string

Link al repository di origine che gestisce i dati. I risultati di ricerca applicano questo link al titolo. Gli spazi vuoti o i caratteri speciali possono far sì che i link dei risultati di Cloud Seach attivino un avviso di reindirizzamento. per evitarlo, codifica l'URL. La lunghezza massima è di 2048 caratteri.

string

Il nome del contenitore di questo elemento. L'eliminazione dell'elemento contenitore comporta l'eliminazione automatica di questo elemento. Nota: gli ACL non vengono ereditati da un elemento container. Per fornire l'ereditarietà ACL per un elemento, utilizza il campo inheritAclFrom. La lunghezza massima è di 1536 caratteri.

string

Il tipo di articolo. Dovrebbe corrispondere al nome di una definizione di oggetto nello schema registrato per l'origine dati. Ad esempio, se lo schema dell'origine dati contiene una definizione dell'oggetto con il nome "document", le richieste di indicizzazione di elementi per gli oggetti di quel tipo devono impostare objectType su "document". La lunghezza massima è di 256 caratteri.

string (Timestamp format)

L'ora in cui l'elemento è stato creato nel repository di origine.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

La data e l'ora dell'ultima modifica dell'elemento nel repository di codice sorgente.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

object (Interaction)

Un elenco di interazioni per l'elemento. Le interazioni vengono utilizzate per migliorare la qualità query.search, ma non sono esposte agli utenti finali. Il numero massimo di elementi è 1000.

string

Il codice lingua BCP-47 per l'articolo, ad esempio "en-US" o "sr-Latn". Per ulteriori informazioni, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. La lunghezza massima è di 32 caratteri.

string

Il tipo MIME originale di ItemContent.content nel repository di codice sorgente. La lunghezza massima è di 256 caratteri.

object (SearchQualityMetadata)

Metadati aggiuntivi sulla qualità di ricerca dell'elemento

string

Parole chiave o frasi aggiuntive che dovrebbero corrispondere all'elemento. Utilizzati internamente per i contenuti generati dagli utenti. Il numero massimo di elementi è 100. La lunghezza massima è di 8192 caratteri.

string

Valore di hashing fornito dal chiamante dell'API. Può essere utilizzata con il metodo items.push per calcolare lo stato modificato. La lunghezza massima è di 2048 caratteri.

object (ContextAttribute)

Un insieme di attributi con nome associati all'articolo. Questo può essere utilizzato per influenzare il ranking dell'elemento in base al contesto nella richiesta. Il numero massimo di elementi è 10.

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum (Interaction.InteractionType)

object (Principal)

L'utente che ha eseguito un'azione sull'elemento.

string (Timestamp format)

L'ora in cui l'utente ha agito sull'elemento. Se sono presenti più azioni dello stesso tipo per un singolo utente, viene registrata solo l'azione più recente.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

{
  "quality": number
}

number

Un'indicazione della qualità dell'articolo, utilizzata per influenzare la qualità della ricerca. deve essere compreso tra 0,0 (qualità più bassa) e 1,0 (qualità massima). Il valore predefinito è 0,0.

{
  "name": string,
  "values": [
    string
  ]
}

string

Il nome dell'attributo. Il campo non può essere vuoto. La lunghezza massima è di 32 caratteri. Il nome deve iniziare con una lettera e può contenere solo lettere (A-Z, a-z) o numeri (0-9). Il nome viene normalizzato (minuscolo) prima della corrispondenza.

string

Valori di testo dell'attributo. Il numero massimo di elementi è 10. La lunghezza massima di un elemento nell'array è di 32 caratteri. Il valore verrà normalizzato (minuscolo) prima di essere abbinato.

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object (StructuredDataObject)

L'oggetto di dati strutturati che deve essere conforme a una definizione di oggetto registrato nello schema dell'origine dati.

string

Valore di hashing fornito dal chiamante dell'API. Può essere utilizzata con il metodo items.push per calcolare lo stato modificato. La lunghezza massima è di 2048 caratteri.

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object (NamedProperty)

Le proprietà dell'oggetto. Il numero massimo di elementi è 1000.

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

Il nome della struttura. Questo nome deve corrispondere al nome della proprietà registrata per la definizione dell'oggetto nello schema. La lunghezza massima consentita per questa proprietà è 256 caratteri.

object (NamedProperty.IntegerValues)

object (NamedProperty.DoubleValues)

object (NamedProperty.TimestampValues)

boolean

object (NamedProperty.ObjectValues)

object (NamedProperty.EnumValues)

object (NamedProperty.DateValues)

object (NamedProperty.TextValues)

object (NamedProperty.HtmlValues)

{
  "values": [
    string
  ]
}

string (int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string (Timestamp format)

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

La lunghezza massima consentita per i valori di stringa è di 32 caratteri.

{
  "values": [
    {
      object (Date)
    }
  ]
}

object (Date)

{
  "values": [
    string
  ]
}

string

La lunghezza massima consentita per i valori di testo è di 2048 caratteri.

{
  "values": [
    string
  ]
}

string

La lunghezza massima consentita per i valori HTML è di 2048 caratteri.

{
  "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.
}

enum (ItemContent.ContentFormat)

string

Informazioni di hashing calcolate e fornite dal client API per i contenuti. Può essere utilizzato con il metodo items.push per calcolare lo stato modificato. La lunghezza massima è di 2048 caratteri.

string (bytes format)

Contenuti forniti incorporati nel metodo di aggiornamento. La lunghezza massima è 102.400 byte (100 KiB).

Una stringa con codifica base64.

object (UploadItemRef)

Carica l'ID di riferimento di un contenuto caricato in precedenza tramite il metodo di scrittura.

{
  "name": string
}

string

Il nome del riferimento ai contenuti. La lunghezza massima è di 2048 caratteri.

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum (ItemStatus.Code)

Codice di stato.

object (ProcessingError)

Dettagli dell'errore nel caso in cui l'elemento sia in stato ERRORE.

object (RepositoryError)

Errore del repository segnalato dal connettore.

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum (ProcessingErrorCode)

Codice di errore che indica la natura dell'errore.

string

La descrizione dell'errore.

object (FieldViolation)

Se i campi elemento non sono validi, questo campo conterrà i dettagli sugli errori di convalida.

{
  "field": string,
  "description": string
}

string

Percorso del campo con violazione.

string

La descrizione dell'errore.

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum (RepositoryError.Type)

Il tipo di errore.

integer

Codici di errore. Corrisponde alla definizione dei codici di stato HTTP.

string

Messaggio che descrive l'errore. La lunghezza massima consentita per il messaggio è 8192 caratteri.