Method: projects.locations.sampleQuerySets.sampleQueries.create

SampleQuery を作成します

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries

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

パスパラメータ

パラメータ
parent

string

必須。親リソース名（projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet} など）。

クエリ パラメータ

パラメータ
sampleQueryId

string

必須。SampleQuery に使用する ID。これは SampleQuery.name の最終的なコンポーネントになります。

呼び出し元に SampleQuery を作成する権限がない場合、SampleQuery が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

このフィールドは、同じ parent を持つすべての SampleQuery の中で一意である必要があります。それ以外の場合は、ALREADY_EXISTS エラーが返されます。

このフィールドは RFC-1034 標準に準拠し、長さは 63 文字以下にする必要があります。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.sampleQueries.create

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