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

コントロールを更新します。

Control アクション タイプは変更できません。更新する Control が存在しない場合は、NOT_FOUND エラーが返されます。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
control.name

string

変更不可。完全修飾名 projects/*/locations/global/dataStore/*/controls/*

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

省略可。指定された Control で更新するフィールドを示します。以下はサポートされません。

設定されていない場合、または空の場合、サポートされているすべてのフィールドが更新されます。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Control のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Control のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.controls.update

詳細については、IAM のドキュメントをご覧ください。