Method: settings.datasources.update

Aktualisiert eine Datenquelle.

Hinweis:Zum Ausführen 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. 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 verwendet, um dem Operator „source“ zu entsprechen. Wenn der Kurzname beispielsweise <value> ist, geben Abfragen wie source:<value> nur Ergebnisse für diese Quelle zurück. Der Wert muss für alle Datenquellen eindeutig sein. Der Wert darf nur alphanumerische Zeichen (a–z, A–Z, 0–9) enthalten. Der Wert darf nicht mit „google“ beginnen und darf nicht Folgendes sein: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, team. Er darf maximal 32 Zeichen lang sein.
source.indexingServiceAccounts[]

string

Liste der Dienstkonten, die Zugriff auf die Indexierung haben.
source.disableServing

boolean

Deaktivieren Sie die Ausgabe von Such- oder Unterstützungsergebnissen.
source.disableModifications

boolean

Bei „true“ wird die Datenquelle in den Lesemodus gesetzt. Im Lesemodus lehnt die Indexing API alle Anfragen zum Indexieren oder Löschen von Elementen in dieser Quelle ab. Wenn Sie den Lesemodus aktivieren, werden zuvor akzeptierte Daten weiterhin verarbeitet.
source.itemsVisibility[]

object (GSuitePrincipal)

Mit diesem Feld wird die Sichtbarkeit von Elementen auf Datenquellenebene eingeschränkt. Elemente in der Datenquelle sind auf die Zusammenführung von Nutzern und Gruppen in diesem Feld beschränkt. Beachten Sie, dass dadurch nicht der Zugriff auf ein bestimmtes Element gewährleistet wird, da Nutzer ACL-Berechtigungen für die enthaltenen Elemente benötigen. So erhalten Sie einen umfassenden Zugriff auf die gesamte Datenquelle und die einzelnen Elemente werden nicht außerhalb dieser Sichtbarkeit freigegeben.
source.returnThumbnailUrls

boolean

Kann ein Nutzer den URI der Miniaturansicht für Elemente, die in dieser Datenquelle indexiert sind, anfordern.
source.operationIds[]

string

IDs der lang andauernden Vorgänge, die derzeit für dieses Schema ausgeführt werden.
debugOptions

object (DebugOptions)

Häufig verwendete Optionen zur Fehlerbehebung.
updateMask

string (FieldMask format)

Gilt nur für settings.datasources.patch.

Aktualisieren Sie die Maske, um zu steuern, welche Felder aktualisiert werden sollen. Beispiele 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, wird das Feld gelöscht.
  • Wenn updateMask nicht vorhanden oder leer ist oder den Wert * hat, 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.