Method: settings.datasources.update

Aggiorna un'origine dati.

Nota:per l'esecuzione di questa API è necessario un account amministratore.

Richiesta HTTP

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
source.name

string

Il nome della risorsa dell'origine dati. Formato: datasources/{sourceId}.

Il nome viene ignorato durante la creazione di un'origine dati.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
Campi
source.displayName

string

Obbligatorio. Nome visualizzato dell'origine dati. La lunghezza massima è 300 caratteri.
source.shortName

string

Un nome breve o un alias per l'origine. Questo valore verrà utilizzato per trovare una corrispondenza con l'operatore "source". Ad esempio, se il nome breve è <value>, query come source:<value> restituiranno solo risultati per questa origine. Il valore deve essere univoco in tutte le origini dati. Il valore deve contenere solo caratteri alfanumerici (a-zA-Z0-9). Il valore non può iniziare con "google" e non può essere uno dei seguenti: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. La lunghezza massima è di 32 caratteri.
source.indexingServiceAccounts[]

string

Elenco degli account di servizio che dispongono dell'accesso all'indicizzazione.
source.disableServing

boolean

Disattivare la pubblicazione di risultati di ricerca o di assistenza.
source.disableModifications

boolean

Se true, imposta la modalità di sola lettura per la sorgente dati. In modalità di sola lettura, l'API Indexing rifiuta tutte le richieste di indicizzazione o eliminazione di elementi in questa origine. L'attivazione della modalità di sola lettura non interrompe l'elaborazione dei dati accettati in precedenza.
source.itemsVisibility[]

object (GSuitePrincipal)

Questo campo limita la visibilità agli elementi a livello di origine dati. Gli elementi all'interno della sorgente dati sono limitati all'unione di utenti e gruppi inclusi in questo campo. Tieni presente che questo non garantisce l'accesso a un elemento specifico, poiché gli utenti devono disporre delle autorizzazioni ACL per gli elementi contenuti. In questo modo, viene garantito un accesso di alto livello all'intera origine dati e i singoli elementi non vengono condivisi al di fuori di questa visibilità.
source.returnThumbnailUrls

boolean

Un utente può richiedere l'URI delle miniature per gli elementi indicizzati in questa origine dati.
source.operationIds[]

string

ID delle operazioni a lunga esecuzione (LRO) attualmente in esecuzione per questo schema.
debugOptions

object (DebugOptions)

Opzioni di debug comuni.
updateMask

string (FieldMask format)

Si applica solo a settings.datasources.patch.

Aggiorna la maschera per controllare i campi da aggiornare. Esempi di percorsi dei campi: name, displayName.

  • Se updateMask non è vuoto, vengono aggiornati solo i campi specificati in updateMask.
  • Se specifichi un campo in updateMask, ma non ne specifichi il valore nell'origine, il campo viene cancellato.
  • Se updateMask non è presente, è vuoto o ha il valore *, vengono aggiornati tutti i campi.

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.settings.indexing
  • https://www.googleapis.com/auth/cloud_search.settings
  • https://www.googleapis.com/auth/cloud_search

Per ulteriori informazioni, consulta la Guida all'autorizzazione.