Method: projects.locations.collections.engines.controls.patch

Aktualisiert ein Steuerelement

Der Aktionstyp Control kann nicht geändert werden. Wenn die zu aktualisierende Control nicht vorhanden ist, wird ein NOT_FOUND-Fehler zurückgegeben.

HTTP-Anfrage

PATCH https://discoveryengine.googleapis.com/v1beta/{control.name=projects/*/locations/*/collections/*/engines/*/controls/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
control.name

string

Nicht veränderbar. Voll qualifizierter Name projects/*/locations/global/dataStore/*/controls/*

Anfrageparameter

Parameter
updateMask

string (FieldMask format)

Optional. Gibt an, welche Felder in der bereitgestellten Control aktualisiert werden sollen. Folgendes wird NICHT unterstützt:

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

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo"

Anfragetext

Der Anfragetext enthält eine Instanz von Control.

Antworttext

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

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

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

  • discoveryengine.controls.update

Weitere Informationen finden Sie in der IAM-Dokumentation.