Method: settings.datasources.update

Aktualisiert eine Datenquelle.

Hinweis:Für die Ausführung dieser API ist ein Administratorkonto erforderlich.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
source.name

string

Der Name der Datenquellenressource. Format: datasources/{sourceId}.

Der Name wird beim Erstellen einer Datenquelle ignoriert.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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
}
Felder
source.displayName

string

Erforderlich. Der Anzeigename der Datenquelle. Die maximale Länge beträgt 300 Zeichen.
source.shortName

string

Ein Kurzname oder Alias für die Quelle. Dieser Wert wird für den Abgleich mit dem Operator „source“ verwendet. Wenn der Kurzname beispielsweise <Wert> lautet, werden bei Suchanfragen wie Quelle:<Wert> nur Ergebnisse für diese Quelle zurückgegeben. Der Wert muss für alle Datenquellen eindeutig sein. Der Wert darf nur alphanumerische Zeichen (a–zA–Z0–9) enthalten. Der Wert darf nicht mit „google“ beginnen und darf keiner der folgenden Namen sein: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Die maximale Länge beträgt 32 Zeichen.
source.indexingServiceAccounts[]

string

Liste der Dienstkonten mit Indexierungszugriff.
source.disableServing

boolean

Deaktivieren Sie die Bereitstellung von Such- oder Assistenzergebnissen.
source.disableModifications

boolean

Wenn „true“, wird die Datenquelle in den Lesemodus versetzt. Im Lesemodus lehnt die Indexing API alle Anfragen zum Indexieren oder Löschen von Elementen in dieser Quelle ab. Durch das Aktivieren des Lesemodus wird die Verarbeitung zuvor akzeptierter Daten nicht beendet.
source.itemsVisibility[]

object (GSuitePrincipal)

Mit diesem Feld wird die Sichtbarkeit auf Elemente auf Datenquellenebene beschränkt. Elemente in der Datenquelle sind auf die Vereinigung der Nutzer und Gruppen beschränkt, die in diesem Feld enthalten sind. Hinweis: Dies ist keine Garantie für den Zugriff auf ein bestimmtes Element, da Nutzer ACL-Berechtigungen für die enthaltenen Elemente benötigen. So wird ein umfassender Zugriff auf die gesamte Datenquelle sichergestellt und die einzelnen Elemente werden nicht außerhalb dieser Sichtbarkeit freigegeben.
source.returnThumbnailUrls

boolean

Können Nutzer den Thumbnail-URI für Elemente anfordern, die in dieser Datenquelle indexiert sind?
source.operationIds[]

string

IDs der derzeit für dieses Schema ausgeführten lang andauernden Vorgänge.
debugOptions

object (DebugOptions)

Gängige Optionen zur Fehlerbehebung
updateMask

string (FieldMask format)

Gilt nur für settings.datasources.patch.

Aktualisieren Sie die Maske, um festzulegen, welche Felder aktualisiert werden sollen. Beispiel für Feldpfade: name, displayName.

  • Wenn updateMask nicht leer ist, werden nur die in updateMask angegebenen Felder aktualisiert.
  • Wenn Sie ein Feld in updateMask angeben, aber keinen Wert in der Quelle angeben, wird dieses Feld gelöscht.
  • Wenn updateMask nicht vorhanden, leer oder * ist, werden alle Felder aktualisiert.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud_search.settings.indexing
  • https://www.googleapis.com/auth/cloud_search.settings
  • https://www.googleapis.com/auth/cloud_search

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.