Method: settings.datasources.update

Aggiorna un'origine dati.

Nota: l'esecuzione di questa API richiede 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: origini dati/{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 è di 300 caratteri.
source.shortName

string

Un nome breve o alias per la fonte. Questo valore verrà utilizzato per creare corrispondenze con l'operatore "source". Ad esempio, se il nome breve è <value>, query come source:<value> restituiranno solo i risultati per questa sorgente. 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 sua lunghezza massima è di 32 caratteri.
source.indexingServiceAccounts[]

string

Elenco di account di servizio che hanno accesso all'indicizzazione.
source.disableServing

boolean

Disattiva la pubblicazione di qualsiasi risultato di ricerca o di assistenza.
source.disableModifications

boolean

Se il valore è true, imposta l'origine dati in modalità di sola lettura. In modalità di sola lettura, l'API Indexing rifiuta qualsiasi richiesta di indicizzazione o eliminazione di elementi nell'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 dell'origine dati sono limitati all'unione di utenti e gruppi inclusi in questo campo. Tieni presente che questa operazione non garantisce l'accesso a un elemento specifico, poiché gli utenti devono disporre delle autorizzazioni ACL per gli elementi contenuti. Ciò garantisce un accesso ad alto livello all'intera origine dati e che i singoli elementi non vengano condivisi al di fuori di questa visibilità.
source.returnThumbnailUrls

boolean

Può un utente richiedere di ottenere l'URI della miniatura 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 stabilire quali campi aggiornare. Esempi di percorsi dei campi: name, displayName.

  • Se il campo 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 o vuoto o ha il valore *, tutti i campi vengono aggiornati.

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