Method: projects.locations.collections.dataStores.widgetConfigs.patch

Aktualisiert eine „WidgetConfig“

HTTP-Anfrage

PATCH https://discoveryengine.googleapis.com/v1alpha/{widgetConfig.name=projects/*/locations/*/collections/*/dataStores/*/widgetConfigs/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
widgetConfig.name

string

Nicht veränderbar. Der vollständige Ressourcenname der Widget-Konfiguration. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.

Anfrageparameter

Parameter
updateMask

string (FieldMask format)

Gibt an, welche Felder in der angegebenen WidgetConfig aktualisiert werden sollen. Folgende Felder werden unterstützt:

Wenn nicht festgelegt, werden alle unterstützten Felder aktualisiert.

Dies ist eine durch Kommas getrennte Liste mit voll qualifizierten Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von WidgetConfig.

Antworttext

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

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource name:

  • discoveryengine.widgetConfigs.update

Weitere Informationen finden Sie in der IAM-Dokumentation.