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

コントロールを作成します。

デフォルトでは、データストアで 1,000 個のコントロールを使用できます。この上限を調整するリクエストを送信できます。作成する Control がすでに存在する場合は、ALREADY_EXISTS エラーが返されます。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/engines/*}/controls

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

パスパラメータ

パラメータ
parent

string

必須。親データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} または projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}。

クエリ パラメータ

パラメータ
controlId

string

必須。Control に使用する ID。Control のリソース名の最終的なコンポーネントになります。

この値は 1 ～ 63 文字にする必要があります。有効な文字は /[a-z][0-9]-_/ です。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.controls.create

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