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 zum Abgleich mit der 'Quelle' [source] verwendet. . Wenn der Kurzname beispielsweise <value> lautet, geben Abfragen wie <value> nur Ergebnisse für diese Quelle zurück. Der Wert muss in allen Datenquellen eindeutig sein. Der Wert darf nur alphanumerische Zeichen (a-z, A-Z0-9) enthalten. Der Wert darf nicht mit „google“ beginnen. und darf keine der folgenden sein: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, team. Sie darf maximal 32 Zeichen lang sein.
source.indexingServiceAccounts[]

string

Liste der Dienstkonten mit Indexierungszugriff.
source.disableServing

boolean

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

boolean

Bei Einstellung auf „true“ wird die Datenquelle auf den Lesemodus gesetzt. Im Lesemodus lehnt die API alle Anfragen zum Indexieren oder Löschen von Elementen in dieser Quelle ab. Wenn Sie den Lesemodus aktivieren, wird die Verarbeitung zuvor akzeptierter Daten nicht gestoppt.
source.itemsVisibility[]

object (GSuitePrincipal)

Mit diesem Feld wird die Sichtbarkeit auf Elemente auf Datenquellenebene beschränkt. Elemente in der Datenquelle sind auf die Gesamtheit der in diesem Feld enthaltenen Nutzer und Gruppen beschränkt. Beachten Sie, dass dadurch nicht der Zugriff auf ein bestimmtes Element sichergestellt wird, da Nutzer über ACL-Berechtigungen für die enthaltenen Elemente verfügen müssen. Dadurch wird ein umfassender Zugriff auf die gesamte Datenquelle gewährleistet und die einzelnen Elemente werden nicht außerhalb dieser Sichtbarkeit freigegeben.
source.returnThumbnailUrls

boolean

Kann ein Nutzer anfordern, dass der URI der Miniaturansicht für die in dieser Datenquelle indexierten Elemente abgerufen wird.
source.operationIds[]

string

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

object (DebugOptions)

Gängige Fehlerbehebungsoptionen.
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, aber nicht dessen Wert in der Quelle angeben, wird dieses 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.